Skip to main content

HS.FHIR.vSTU3.Model.Resource.Encounter

deprecated class HS.FHIR.vSTU3.Model.Resource.Encounter extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method 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 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.

Properties

property account as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "account", XMLPROJECTION = "ELEMENT");
The set of accounts that may be used for billing for this Encounter.
Property methods: accountBuildValueArray(), accountCollectionToDisplay(), accountCollectionToOdbc(), accountDisplayToCollection(), accountGet(), accountGetObject(), accountGetObjectId(), accountGetSwizzled(), accountIsValid(), accountOdbcToCollection(), accountSet(), accountSetObject(), accountSetObjectId()
property appointment as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "appointment", XMLPROJECTION = "ELEMENT");
The appointment that scheduled this encounter.
Property methods: appointmentGet(), appointmentGetSwizzled(), appointmentIsValid(), appointmentNewObject(), appointmentSet()
property class as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "class", XMLPROJECTION = "ELEMENT");
inpatient | outpatient | ambulatory | emergency +.
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.vSTU3.Model.Resource.Encounter.ClassHistory (XMLNAME = "classHistory", XMLPROJECTION = "ELEMENT");
The class history permits the tracking of the encounters transitions without needing to go through the resource history.This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.
Property methods: classHistoryBuildValueArray(), classHistoryCollectionToDisplay(), classHistoryCollectionToOdbc(), classHistoryDisplayToCollection(), classHistoryGet(), classHistoryGetObject(), classHistoryGetObjectId(), classHistoryGetSwizzled(), classHistoryIsValid(), classHistoryOdbcToCollection(), classHistorySet(), classHistorySetObject(), classHistorySetObjectId()
property diagnosis as list of HS.FHIR.vSTU3.Model.Resource.Encounter.Diagnosis (XMLNAME = "diagnosis", XMLPROJECTION = "ELEMENT");
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.vSTU3.Model.Base.Reference (XMLNAME = "episodeOfCare", XMLPROJECTION = "ELEMENT");
Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
Property methods: episodeOfCareBuildValueArray(), episodeOfCareCollectionToDisplay(), episodeOfCareCollectionToOdbc(), episodeOfCareDisplayToCollection(), episodeOfCareGet(), episodeOfCareGetObject(), episodeOfCareGetObjectId(), episodeOfCareGetSwizzled(), episodeOfCareIsValid(), episodeOfCareOdbcToCollection(), episodeOfCareSet(), episodeOfCareSetObject(), episodeOfCareSetObjectId()
property hospitalization as HS.FHIR.vSTU3.Model.Resource.Encounter.Hospitalization (XMLNAME = "hospitalization", XMLPROJECTION = "ELEMENT");
Details about the admission to a healthcare service.
Property methods: hospitalizationGet(), hospitalizationGetSwizzled(), hospitalizationIsValid(), hospitalizationNewObject(), hospitalizationSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
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.vSTU3.Model.Base.Reference (XMLNAME = "incomingReferral", XMLPROJECTION = "ELEMENT");
The referral request this encounter satisfies (incoming referral).
Property methods: incomingReferralBuildValueArray(), incomingReferralCollectionToDisplay(), incomingReferralCollectionToOdbc(), incomingReferralDisplayToCollection(), incomingReferralGet(), incomingReferralGetObject(), incomingReferralGetObjectId(), incomingReferralGetSwizzled(), incomingReferralIsValid(), incomingReferralOdbcToCollection(), incomingReferralSet(), incomingReferralSetObject(), incomingReferralSetObjectId()
property length as HS.FHIR.vSTU3.Model.Base.Duration (XMLNAME = "length", XMLPROJECTION = "ELEMENT");
Quantity of time the encounter lasted. This excludes the time during leaves of absence.
Property methods: lengthGet(), lengthGetSwizzled(), lengthIsValid(), lengthNewObject(), lengthSet()
property location as list of HS.FHIR.vSTU3.Model.Resource.Encounter.Location (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
List of locations where the patient has been during this encounter.
Property methods: locationBuildValueArray(), locationCollectionToDisplay(), locationCollectionToOdbc(), locationDisplayToCollection(), locationGet(), locationGetObject(), locationGetObjectId(), locationGetSwizzled(), locationIsValid(), locationOdbcToCollection(), locationSet(), locationSetObject(), locationSetObjectId()
property partOf as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Another Encounter of which this encounter is a part of (administratively or in time).
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property participant as list of HS.FHIR.vSTU3.Model.Resource.Encounter.Participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");
The list of people responsible for providing the service.
Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
The start and end time of the encounter.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property priority as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
Indicates the urgency of the encounter.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reason as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property serviceProvider as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "serviceProvider", XMLPROJECTION = "ELEMENT");
An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
Property methods: serviceProviderGet(), serviceProviderGetSwizzled(), serviceProviderIsValid(), serviceProviderNewObject(), serviceProviderSet()
property status as HS.FHIR.vSTU3.Model.Base.EncounterStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
Property methods: statusGet(), statusGetSwizzled(), statusHistoryBuildValueArray(), statusHistoryCollectionToDisplay(), statusHistoryCollectionToOdbc(), statusHistoryDisplayToCollection(), statusHistoryGet(), statusHistoryGetObject(), statusHistoryGetObjectId(), statusHistoryGetSwizzled(), statusHistoryIsValid(), statusHistoryOdbcToCollection(), statusHistorySet(), statusHistorySetObject(), statusHistorySetObjectId(), statusIsValid(), statusNewObject(), statusSet()
property statusHistory as list of HS.FHIR.vSTU3.Model.Resource.Encounter.StatusHistory (XMLNAME = "statusHistory", XMLPROJECTION = "ELEMENT");
The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
Property methods: statusHistoryBuildValueArray(), statusHistoryCollectionToDisplay(), statusHistoryCollectionToOdbc(), statusHistoryDisplayToCollection(), statusHistoryGet(), statusHistoryGetObject(), statusHistoryGetObjectId(), statusHistoryGetSwizzled(), statusHistoryIsValid(), statusHistoryOdbcToCollection(), statusHistorySet(), statusHistorySetObject(), statusHistorySetObjectId()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
The patient ro group present at the encounter.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property type as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()

Methods

deprecated method SetAccount(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "account" property.
deprecated method SetAppointment(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "appointment" property.
deprecated method SetClass(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "class" property.
deprecated method SetEpisodeOfCare(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "episodeOfCare" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetIncomingReferral(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "incomingReferral" property.
deprecated method SetPartOf(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "partOf" property.
deprecated method SetPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetPriority(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "priority" property.
deprecated method SetReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reason" property.
deprecated method SetServiceProvider(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "serviceProvider" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.
deprecated method SetType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab