Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.Encounter

class HS.FHIR.DTL.vDSTU2.Model.Resource.Encounter extends HS.FHIR.DTL.vDSTU2.Model.Base.DomainResource

An interaction during which services are provided to the patient.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Encounter;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Encounter;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property appointment as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "appointment", XMLPROJECTION = "ELEMENT");
Reference

The appointment that scheduled this encounter.

Appointment

Property methods: appointmentGet(), appointmentGetSwizzled(), appointmentIsValid(), appointmentNewObject(), appointmentSet()
property class as %String (MAXLEN = 1000000, XMLNAME = "class", XMLPROJECTION = "ATTRIBUTE");
code

inpatient | outpatient | ambulatory | emergency +

encounter-class is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend encounter-class and you may NOT use codes from other ValueSets.

Property methods: classDisplayToLogical(), classGet(), classIsValid(), classLogicalToDisplay(), classLogicalToOdbc(), classNormalize(), classSet()
property episodeOfCare as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "episodeOfCare", XMLPROJECTION = "ELEMENT");
Reference

Episode(s) of care that this encounter should be recorded against.

EpisodeOfCare

Property methods: episodeOfCareBuildValueArray(), episodeOfCareCollectionToDisplay(), episodeOfCareCollectionToOdbc(), episodeOfCareDisplayToCollection(), episodeOfCareGet(), episodeOfCareGetObject(), episodeOfCareGetObjectId(), episodeOfCareGetSwizzled(), episodeOfCareIsValid(), episodeOfCareOdbcToCollection(), episodeOfCareSet(), episodeOfCareSetObject(), episodeOfCareSetObjectId()
property hospitalization as HS.FHIR.DTL.vDSTU2.Model.Element.Encounter.hospitalization (XMLNAME = "hospitalization", XMLPROJECTION = "ELEMENT");
BackboneElement

Details about the admission to a healthcare service.

Property methods: hospitalizationGet(), hospitalizationGetSwizzled(), hospitalizationIsValid(), hospitalizationNewObject(), hospitalizationSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Identifier(s) by which this encounter is known.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property incomingReferral as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "incomingReferral", XMLPROJECTION = "ELEMENT");
Reference

The ReferralRequest that initiated this encounter.

ReferralRequest

Property methods: incomingReferralBuildValueArray(), incomingReferralCollectionToDisplay(), incomingReferralCollectionToOdbc(), incomingReferralDisplayToCollection(), incomingReferralGet(), incomingReferralGetObject(), incomingReferralGetObjectId(), incomingReferralGetSwizzled(), incomingReferralIsValid(), incomingReferralOdbcToCollection(), incomingReferralSet(), incomingReferralSetObject(), incomingReferralSetObjectId()
property indication as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "indication", XMLPROJECTION = "ELEMENT");
Reference

Reason the encounter takes place (resource)

Condition | Procedure

Property methods: indicationBuildValueArray(), indicationCollectionToDisplay(), indicationCollectionToOdbc(), indicationDisplayToCollection(), indicationGet(), indicationGetObject(), indicationGetObjectId(), indicationGetSwizzled(), indicationIsValid(), indicationOdbcToCollection(), indicationSet(), indicationSetObject(), indicationSetObjectId()
property length as HS.FHIR.DTL.vDSTU2.Model.Datatype.Duration (XMLNAME = "length", XMLPROJECTION = "ELEMENT");
Duration

Quantity of time the encounter lasted (less time absent)

Property methods: lengthGet(), lengthGetSwizzled(), lengthIsValid(), lengthNewObject(), lengthSet()
property location as list of HS.FHIR.DTL.vDSTU2.Model.Element.Encounter.location (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
BackboneElement

List of locations where the patient has been.

Property methods: locationBuildValueArray(), locationCollectionToDisplay(), locationCollectionToOdbc(), locationDisplayToCollection(), locationGet(), locationGetObject(), locationGetObjectId(), locationGetSwizzled(), locationIsValid(), locationOdbcToCollection(), locationSet(), locationSetObject(), locationSetObjectId()
property partOf as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Another Encounter this encounter is part of.

Encounter

Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property participant as list of HS.FHIR.DTL.vDSTU2.Model.Element.Encounter.participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");
BackboneElement

List of participants involved in the encounter.

Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property patient as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");
Reference

The patient present at the encounter.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property period as HS.FHIR.DTL.vDSTU2.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

The start and end time of the encounter.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property priority as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
CodeableConcept

Indicates the urgency of the encounter.

any FHIR2 code may be used; encounter-priority shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reason as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason the encounter takes place (code)

any FHIR2 code may be used; encounter-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property serviceProvider as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "serviceProvider", XMLPROJECTION = "ELEMENT");
Reference

The custodian organization of this Encounter record.

Organization

Property methods: serviceProviderGet(), serviceProviderGetSwizzled(), serviceProviderIsValid(), serviceProviderNewObject(), serviceProviderSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

planned | arrived | in-progress | onleave | finished | cancelled

encounter-state is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend encounter-state and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusHistoryBuildValueArray(), statusHistoryCollectionToDisplay(), statusHistoryCollectionToOdbc(), statusHistoryDisplayToCollection(), statusHistoryGet(), statusHistoryGetObject(), statusHistoryGetObjectId(), statusHistoryGetSwizzled(), statusHistoryIsValid(), statusHistoryOdbcToCollection(), statusHistorySet(), statusHistorySetObject(), statusHistorySetObjectId(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusHistory as list of HS.FHIR.DTL.vDSTU2.Model.Element.Encounter.statusHistory (XMLNAME = "statusHistory", XMLPROJECTION = "ELEMENT");
BackboneElement

List of past encounter statuses.

Property methods: statusHistoryBuildValueArray(), statusHistoryCollectionToDisplay(), statusHistoryCollectionToOdbc(), statusHistoryDisplayToCollection(), statusHistoryGet(), statusHistoryGetObject(), statusHistoryGetObjectId(), statusHistoryGetSwizzled(), statusHistoryIsValid(), statusHistoryOdbcToCollection(), statusHistorySet(), statusHistorySetObject(), statusHistorySetObjectId()
property type as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Specific type of encounter.

any FHIR2 code may be used; encounter-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab