| Australian Digital Health Agency FHIR Implementation Guide 1.0.0

Australian Digital Health Agency FHIR Implementation Guide. This is the current published version. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available versions.

#### StructureDefinition: ADHA Core Encounter - Detailed Descriptions

Definitions for the dh-encounter-core-1 Profile.

1. Encounter
Definition | 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.
Control | 0..*
Alternate Names | Visit
2. Encounter.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. Encounter.meta
Definition | 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.
Control | 0..1
Type | Meta
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Encounter.implicitRules
Definition | 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.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Encounter.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Encounter.text
Definition | 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.
Control | 0..1
Type | Narrative
Alternate Names | narrativehtmlxhtmldisplay
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Encounter.contained
Definition | 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.
Control | 0..*
Type | Resource
Alternate Names | inline resourcesanonymous resourcescontained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. Encounter.extension
Definition | An Extension
Control | 0..*
Type | Extension
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Encounter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. Encounter.extension:encounterDescription
SliceName | encounterDescription
Definition | Description, overview or summary of a clinical event and its reasons.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(EncounterDescription) (Extension Type: string)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Encounter.extension:associatedHealthcareService
SliceName | associatedHealthcareService
Definition | Healthcare service relating to a resource.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(AssociatedHealthcareService) (Extension Type: Reference(HealthcareService)))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. Encounter.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Encounter.identifier
Definition | Identifier(s) by which this encounter is known.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Encounter.status
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
Control | 1..1
Binding | The codes SHALL be taken from EncounterStatus Current state of the encounter
Type | code
Is Modifier | true
Must Support | true
Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Encounter.statusHistory
Definition | 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.
Control | 0..*
Type | BackboneElement
Comments | The current status is always found in the current version of the resource, not the status history.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Encounter.statusHistory.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
16. Encounter.statusHistory.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
17. Encounter.statusHistory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
18. Encounter.statusHistory.status
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
Control | 1..1
Binding | The codes SHALL be taken from EncounterStatus Current state of the encounter
Type | code
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Encounter.statusHistory.period
Definition | The time that the episode was in the specified status.
Control | 1..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Encounter.class
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Control | 1..1
Binding | The codes SHALL be taken from ActEncounterCode - AU Extended; other codes may be used where these codes are not suitable
Type | Coding
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Encounter.classHistory
Definition | 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.
Control | 0..*
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Encounter.classHistory.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
23. Encounter.classHistory.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. Encounter.classHistory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
25. Encounter.classHistory.class
Definition | inpatient | outpatient | ambulatory | emergency +.
Control | 1..1
Binding | The codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable Classification of the encounter
Type | Coding
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Encounter.classHistory.period
Definition | The time that the episode was in the specified class.
Control | 1..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Encounter.type
Definition | Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
Control | 0..*
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
Type | CodeableConcept
Must Support | true
Comments | Since there are many ways to further classify encounters, this element is 0..*.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Encounter.serviceType
Definition | Broad categorization of the service that is to be provided (e.g. cardiology).
Control | 0..1
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Encounter.priority
Definition | Indicates the urgency of the encounter.
Control | 0..1
Binding | For example codes, see ActPriority Indicates the urgency of the encounter
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Encounter.subject
Definition | The patient or group present at the encounter.
Control | 1..1 This element is affected by the following invariants: inv-dh-enc-01
Type | Reference(ADHAPatientCore))
Must Support | true
Alternate Names | patient
Comments | While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-enc-01: At least reference or a valid identifier shall be present (: reference.exists() or identifier.where(system.count() + value.count() >1).exists())
31. Encounter.episodeOfCare
Definition | 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).
Control | 0..*
Type | Reference(EpisodeOfCare))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Encounter.basedOn
Definition | The request this encounter satisfies (e.g. incoming referral or procedure request).
Control | 0..*
Type | Reference(ServiceRequest))
Alternate Names | incomingReferral
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Encounter.participant
Definition | The list of people responsible for providing the service.
Control | 1..*
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-enc-02: If present, an individual shall at least have a reference, an identifier or a display (: individual.exists() implies individual.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()))
34. Encounter.participant.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
35. Encounter.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
36. Encounter.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
37. Encounter.participant.type
Definition | Role of participant in encounter.
Control | 0..*
Binding | The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounter
Type | CodeableConcept
Must Support | true
Comments | The participant type indicates how an individual participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Encounter.participant.period
Definition | The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
Control | 0..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Encounter.participant.individual
Definition | Persons involved in the encounter other than the patient.
Control | 0..1 This element is affected by the following invariants: inv-dh-enc-02
Type | Reference(ADHAPractitionerRoleCore ADHARelatedPersonCore))
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Encounter.appointment
Definition | The appointment that scheduled this encounter.
Control | 0..*
Type | Reference(Appointment))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Encounter.period
Definition | The start and end time of the encounter.
Control | 1..1
Type | Period
Must Support | true
Comments | If not (yet) known, the end of the Period may be omitted.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Encounter.length
Definition | Quantity of time the encounter lasted. This excludes the time during leaves of absence.
Control | 0..1
Type | Duration
Comments | May differ from the time the Encounter.period lasted because of leave of absence.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Encounter.reasonCode
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Control | 0..*
Binding | The codes SHOULD be taken from EncounterReasonCodes Reason why the encounter takes place
Type | CodeableConcept
Must Support | true
Alternate Names | IndicationAdmission diagnosis
Comments | For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Encounter.reasonReference
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Control | 0..*
Type | Reference(ADHAConditionCore ADHAObservationCore ADHAProcedureCore))
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Alternate Names | IndicationAdmission diagnosis
Comments | For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Encounter.diagnosis
Definition | The list of diagnosis relevant to this encounter.
Control | 0..*
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Encounter.diagnosis.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
47. Encounter.diagnosis.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
48. Encounter.diagnosis.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
49. Encounter.diagnosis.condition
Definition | Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Control | 1..1
Type | Reference(Condition Procedure))
Alternate Names | Admission diagnosisdischarge diagnosisindication
Comments | For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Encounter.diagnosis.use
Definition | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
Control | 0..1
Binding | The codes SHOULD be taken from DiagnosisRole The type of diagnosis this condition represents
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Encounter.diagnosis.rank
Definition | Ranking of the diagnosis (for each role type).
Control | 0..1
Type | positiveInt
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Encounter.account
Definition | The set of accounts that may be used for billing for this Encounter.
Control | 0..*
Type | Reference(Account))
Comments | The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Encounter.hospitalization
Definition | Details about the admission to a healthcare service.
Control | 0..1
Type | BackboneElement
Must Support | true
Comments | An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this hospitalization record.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Encounter.hospitalization.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
55. Encounter.hospitalization.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
56. Encounter.hospitalization.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
57. Encounter.hospitalization.preAdmissionIdentifier
Definition | Pre-admission identifier.
Control | 0..1
Type | Identifier
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Encounter.hospitalization.origin
Definition | The location/organization from which the patient came before admission.
Control | 0..1
Type | Reference(Location Organization))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Encounter.hospitalization.admitSource
Definition | From where patient was admitted (physician referral, transfer).
Control | 0..1
Binding | The codes SHOULD be taken from AdmitSource From where the patient was admitted
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Encounter.hospitalization.reAdmission
Definition | Whether this hospitalization is a readmission and why if known.
Control | 0..1
Binding | For example codes, see hl7VS-re-admissionIndicator The reason for re-admission of this hospitalization encounter
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. Encounter.hospitalization.dietPreference
Definition | Diet preferences reported by the patient.
Control | 0..*
Binding | For example codes, see Diet Medical, cultural or ethical food preferences to help with catering requirements
Type | CodeableConcept
Requirements | Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter.
Comments | For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Encounter.hospitalization.specialCourtesy
Definition | Special courtesies (VIP, board member).
Control | 0..*
Binding | The codes SHOULD be taken from SpecialCourtesy Special courtesies
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Encounter.hospitalization.specialArrangement
Definition | Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
Control | 0..*
Binding | The codes SHOULD be taken from SpecialArrangements Special arrangements
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. Encounter.hospitalization.destination
Definition | Location/organization to which the patient is discharged.
Control | 0..1
Type | Reference(Location Organization))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Encounter.hospitalization.dischargeDisposition
Definition | Category or kind of location after discharge.
Control | 0..1
Binding | The codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1; other codes may be used where these codes are not suitable
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. Encounter.location
Definition | List of locations where the patient has been during this encounter.
Control | 0..*
Type | BackboneElement
Must Support | true
Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-enc-03: If present, location shall at least have a reference or display or a valid identifier (: location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()))
67. Encounter.location.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
68. Encounter.location.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
69. Encounter.location.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
70. Encounter.location.location
Definition | The location where the encounter takes place.
Control | 1..1 This element is affected by the following invariants: inv-dh-enc-03
Type | Reference(ADHALocationCore))
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. Encounter.location.status
Definition | The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.
Control | 0..1
Binding | The codes SHALL be taken from EncounterLocationStatus The status of the location
Type | code
Comments | When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Encounter.location.physicalType
Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
Control | 0..1
Binding | For example codes, see LocationType Physical form of the location
Type | CodeableConcept
Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Encounter.location.period
Definition | Time period during which the patient was present at the location.
Control | 0..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. Encounter.serviceProvider
Definition | 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.
Control | 0..1 This element is affected by the following invariants: inv-dh-enc-04
Type | Reference(ADHAOrganizationCore))
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. Encounter.partOf
Definition | Another Encounter of which this encounter is a part of (administratively or in time).
Control | 0..1
Type | Reference(Encounter))
Comments | This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))