Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Encounter

class HS.FHIR.DTL.vR4.Model.Resource.Encounter extends HS.FHIR.DTL.vR4.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 account as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "account", XMLPROJECTION = "ELEMENT");
Reference

The set of accounts that may be used for billing for this Encounter.

Account

Property methods: accountBuildValueArray(), accountCollectionToDisplay(), accountCollectionToOdbc(), accountDisplayToCollection(), accountGet(), accountGetObject(), accountGetObjectId(), accountGetSwizzled(), accountIsValid(), accountOdbcToCollection(), accountSet(), accountSetObject(), accountSetObjectId()
property appointment as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "appointment", XMLPROJECTION = "ELEMENT");
Reference

The appointment that scheduled this encounter.

Appointment

Property methods: appointmentBuildValueArray(), appointmentCollectionToDisplay(), appointmentCollectionToOdbc(), appointmentDisplayToCollection(), appointmentGet(), appointmentGetObject(), appointmentGetObjectId(), appointmentGetSwizzled(), appointmentIsValid(), appointmentOdbcToCollection(), appointmentSet(), appointmentSetObject(), appointmentSetObjectId()
property basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

The ServiceRequest that initiated this encounter.

ServiceRequest

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property class as HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "class", XMLPROJECTION = "ELEMENT") [ Required ];
Coding

Classification of patient encounter.

v3-ActEncounterCode is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in v3-ActEncounterCode, you may formally EXTEND v3-ActEncounterCode to add codes to it.

Property methods: classGet(), classGetSwizzled(), classHistoryBuildValueArray(), classHistoryCollectionToDisplay(), classHistoryCollectionToOdbc(), classHistoryDisplayToCollection(), classHistoryGet(), classHistoryGetObject(), classHistoryGetObjectId(), classHistoryGetSwizzled(), classHistoryIsValid(), classHistoryOdbcToCollection(), classHistorySet(), classHistorySetObject(), classHistorySetObjectId(), classIsValid(), classNewObject(), classSet()
property classHistory as list of HS.FHIR.DTL.vR4.Model.Element.Encounter.classHistory (XMLNAME = "classHistory", XMLPROJECTION = "ELEMENT");
BackboneElement

List of past encounter classes.

Property methods: classHistoryBuildValueArray(), classHistoryCollectionToDisplay(), classHistoryCollectionToOdbc(), classHistoryDisplayToCollection(), classHistoryGet(), classHistoryGetObject(), classHistoryGetObjectId(), classHistoryGetSwizzled(), classHistoryIsValid(), classHistoryOdbcToCollection(), classHistorySet(), classHistorySetObject(), classHistorySetObjectId()
property diagnosis as list of HS.FHIR.DTL.vR4.Model.Element.Encounter.diagnosis (XMLNAME = "diagnosis", XMLPROJECTION = "ELEMENT");
BackboneElement

The list of diagnosis relevant to this encounter.

Property methods: diagnosisBuildValueArray(), diagnosisCollectionToDisplay(), diagnosisCollectionToOdbc(), diagnosisDisplayToCollection(), diagnosisGet(), diagnosisGetObject(), diagnosisGetObjectId(), diagnosisGetSwizzled(), diagnosisIsValid(), diagnosisOdbcToCollection(), diagnosisSet(), diagnosisSetObject(), diagnosisSetObjectId()
property episodeOfCare as list of HS.FHIR.DTL.vR4.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.vR4.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.vR4.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 length as HS.FHIR.DTL.vR4.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.vR4.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.vR4.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.vR4.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 period as HS.FHIR.DTL.vR4.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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
CodeableConcept

Indicates the urgency of the encounter.

any FHIR4 code may be used; v3-ActPriority shows EXAMPLE codes, but you may use codes from any ValueSet.

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

Coded reason the encounter takes place.

encounter-reason is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in encounter-reason, you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Reason the encounter takes place (reference)

Condition | Procedure | Observation | ImmunizationRecommendation

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property serviceProvider as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "serviceProvider", XMLPROJECTION = "ELEMENT");
Reference

The organization (facility) responsible for this encounter.

Organization

Property methods: serviceProviderGet(), serviceProviderGetSwizzled(), serviceProviderIsValid(), serviceProviderNewObject(), serviceProviderSet()
property serviceType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "serviceType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Specific type of service.

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

Property methods: serviceTypeGet(), serviceTypeGetSwizzled(), serviceTypeIsValid(), serviceTypeNewObject(), serviceTypeSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

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

encounter-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend encounter-status|4.0.1 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.vR4.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 subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

The patient or group present at the encounter.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property type as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Specific type of encounter.

any FHIR4 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