HS.FHIRModel.R4.Encounter
class HS.FHIRModel.R4.Encounter extends HS.FHIRModel.FHIRClassSuper
******************************************* Encounter generated class schema
*****************************************
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.
Property Inventory
- _implicitRules
- _language
- _status
- account
- appointment
- basedOn
- class
- classHistory
- contained
- diagnosis
- episodeOfCare
- extension
- fhirID
- hospitalization
- identifier
- implicitRules
- language
- length
- location
- meta
- modifierExtension
- partOf
- participant
- period
- priority
- reasonCode
- reasonReference
- resourceType
- serviceProvider
- serviceType
- status
- statusHistory
- subject
- text
- type
Method Inventory
- IncludeAccount()
- IncludeAppointment()
- IncludeBasedOn()
- IncludeClass()
- IncludeClassHistory()
- IncludeContained()
- IncludeDiagnosis()
- IncludeEpisodeOfCare()
- IncludeExtension()
- IncludeHospitalization()
- IncludeIdentifier()
- IncludeLength()
- IncludeLocation()
- IncludeMeta()
- IncludeModifierExtension()
- IncludePartOf()
- IncludeParticipant()
- IncludePeriod()
- IncludePriority()
- IncludeReasonCode()
- IncludeReasonReference()
- IncludeServiceProvider()
- IncludeServiceType()
- IncludeStatusHistory()
- IncludeSubject()
- IncludeText()
- IncludeType()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_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 _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property account as HS.FHIRModel.R4.SeqOfReference;
The set of accounts that may be used for billing for this Encounter.
Property methods: accountGet(), accountGetSwizzled(), accountIsValid(), accountNewObject(), accountSet()
property appointment as HS.FHIRModel.R4.SeqOfReference;
The appointment that scheduled this encounter.
Property methods: appointmentGet(), appointmentGetSwizzled(), appointmentIsValid(), appointmentNewObject(), appointmentSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
The request this encounter satisfies (e.g. incoming referral or procedure
request).
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property class as HS.FHIRModel.R4.Coding [ Required ];
Concepts representing classification of patient encounter such as
ambulatory (outpatient), inpatient, emergency, home health or others
due to local variations.
Property methods: classGet(), classGetSwizzled(), classIsValid(), classNewObject(), classSet()
property classHistory as HS.FHIRModel.R4.EncounterX.SeqOfEncounterXClassHistory;
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 transitions 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 kind of discharge from emergency
to inpatient.
Property methods: classHistoryGet(), classHistoryGetSwizzled(), classHistoryIsValid(), classHistoryNewObject(), classHistorySet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property diagnosis as HS.FHIRModel.R4.EncounterX.SeqOfEncounterXDiagnosis;
The list of diagnosis relevant to this encounter.
Property methods: diagnosisGet(), diagnosisGetSwizzled(), diagnosisIsValid(), diagnosisNewObject(), diagnosisSet()
property episodeOfCare as HS.FHIRModel.R4.SeqOfReference;
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: episodeOfCareGet(), episodeOfCareGetSwizzled(), episodeOfCareIsValid(), episodeOfCareNewObject(), episodeOfCareSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property hospitalization as HS.FHIRModel.R4.EncounterX.Hospitalization;
Details about the admission to a healthcare service.
Property methods: hospitalizationGet(), hospitalizationGetSwizzled(), hospitalizationIsValid(), hospitalizationNewObject(), hospitalizationSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifier(s) by which this encounter is known.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property length as HS.FHIRModel.R4.Duration;
Quantity of time the encounter lasted. This excludes the time during
leaves of absence.
Property methods: lengthGet(), lengthGetSwizzled(), lengthIsValid(), lengthNewObject(), lengthSet()
property location as HS.FHIRModel.R4.EncounterX.SeqOfEncounterXLocation;
List of locations where the patient has been during this encounter.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property partOf as HS.FHIRModel.R4.Reference;
Another Encounter of which this encounter is a part of (administratively
or in time).
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property participant as HS.FHIRModel.R4.EncounterX.SeqOfEncounterXParticipant;
The list of people responsible for providing the service.
Property methods: participantGet(), participantGetSwizzled(), participantIsValid(), participantNewObject(), participantSet()
property period as HS.FHIRModel.R4.Period;
The start and end time of the encounter.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property priority as HS.FHIRModel.R4.CodeableConcept;
Indicates the urgency of the encounter.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Reason the encounter takes place, expressed as a code. For admissions,
this can be used for a coded admission diagnosis.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Reason the encounter takes place, expressed as a code. For admissions,
this can be used for a coded admission diagnosis.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property resourceType as %String [ InitialExpression = "Encounter" , Required ];
This is a Encounter resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property serviceProvider as HS.FHIRModel.R4.Reference;
The organization that is primarily responsible for this Encounter's
services. This MAY be the same as the organization on the Patient
record, however it could be different, such as if the actor performing
the services was from an external organization (which may be billed
seperately) for an external consultation. Refer to the example
bundle showing an abbreviated set of Encounters for a colonoscopy.
Property methods: serviceProviderGet(), serviceProviderGetSwizzled(), serviceProviderIsValid(), serviceProviderNewObject(), serviceProviderSet()
property serviceType as HS.FHIRModel.R4.CodeableConcept;
Broad categorization of the service that is to be provided (e.g.
cardiology).
Property methods: serviceTypeGet(), serviceTypeGetSwizzled(), serviceTypeIsValid(), serviceTypeNewObject(), serviceTypeSet()
property status as %String (VALUELIST = ",planned,arrived,triaged,in-progress,onleave,finished,cancelled,entered-in-error,unknown");
planned | arrived | triaged | in-progress | onleave | finished |
cancelled +.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusHistory as HS.FHIRModel.R4.EncounterX.SeqOfEncounterXStatusHistory;
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: statusHistoryGet(), statusHistoryGetSwizzled(), statusHistoryIsValid(), statusHistoryNewObject(), statusHistorySet()
property subject as HS.FHIRModel.R4.Reference;
The patient or group present at the encounter.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property type as HS.FHIRModel.R4.SeqOfCodeableConcept;
Specific type of encounter (e.g. e-mail consultation, surgical day-care,
skilled nursing, rehabilitation).
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
Methods
method IncludeAccount()
method IncludeAppointment()
method IncludeBasedOn()
method IncludeClass()
method IncludeClassHistory()
method IncludeContained()
method IncludeDiagnosis()
method IncludeEpisodeOfCare()
method IncludeExtension()
method IncludeHospitalization()
method IncludeIdentifier()
method IncludeLength()
method IncludeLocation()
method IncludeMeta()
method IncludeModifierExtension()
method IncludePartOf()
method IncludeParticipant()
method IncludePeriod()
method IncludePriority()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeServiceProvider()
method IncludeServiceType()
method IncludeStatusHistory()
method IncludeSubject()
method IncludeText()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Encounter
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()