AU Core Implementation Guide
1.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions
Page standards status: Draft | Maturity Level: 1 |
Definitions for the au-core-encounter resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Encounter | |||||||
2. Encounter.status | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
4. Encounter.class | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
6. Encounter.serviceType | |||||||
Binding | The codes SHOULD be taken from Service Type (preferred to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 ) | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
8. Encounter.subject | |||||||
Control | 1..? | ||||||
Type | Reference(AU Core Patient) | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
10. Encounter.participant | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
12. Encounter.participant.type | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
14. Encounter.participant.individual | |||||||
Type | Reference(AU Core Practitioner, AU Core PractitionerRole, AU Base Related Person) | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
16. Encounter.period | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
18. Encounter.reasonCode | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
20. Encounter.reasonReference | |||||||
Type | Reference(AU Core Condition, Observation, AU Core Procedure) | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
22. Encounter.location | |||||||
Must Support | true | ||||||
Obligations |
| ||||||
24. Encounter.location.location | |||||||
Type | Reference(AU Core Location) | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
26. Encounter.serviceProvider | |||||||
Type | Reference(AU Core Organization) | ||||||
Must Support | true | ||||||
Obligations |
|
Guidance on how to interpret the contents of this table can be found here
0. 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. | ||||||
Short | An encounter in an Australian healthcare contextAn interaction during which services are provided to the patient | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | Visit | ||||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) | ||||||
2. 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. | ||||||
Short | A set of rules under which this content was created | ||||||
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. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
4. Encounter.extension:encounterDescription | |||||||
Slice Name | encounterDescription | ||||||
Definition | Description, overview or summary of a clinical event and its reasons. | ||||||
Short | Description, overview or summary of an encounter | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Encounter Description) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Invariants | 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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
6. Encounter.extension:associatedHealthcareService | |||||||
Slice Name | associatedHealthcareService | ||||||
Definition | Healthcare service relating to a resource. | ||||||
Short | Associated healthcare service | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Associated Healthcare Service) (Extension Type: Reference(HealthcareService)) | ||||||
Is Modifier | false | ||||||
Invariants | 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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
8. 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). | ||||||
Short | Extensions that cannot be ignored | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
Summary | false | ||||||
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 | extensions, user content | ||||||
Invariants | 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.status | |||||||
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +. | ||||||
Short | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | ||||||
Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 )Current state of the encounter. | ||||||
Type | code | ||||||
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
12. Encounter.class | |||||||
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. | ||||||
Short | Classification of patient encounter | ||||||
Control | 1..1 | ||||||
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode - AU Extendedhttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode (extensible to http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended ) | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
14. Encounter.serviceType | |||||||
Definition | Broad categorization of the service that is to be provided (e.g. cardiology). | ||||||
Short | Specific type of service | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from For example codes, see Service Type http://hl7.org/fhir/ValueSet/service-type (preferred to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
16. Encounter.subject | |||||||
Definition | The patient or group present at the encounter. | ||||||
Short | The patient or group present at the encounter | ||||||
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). | ||||||
Control | 10..1 | ||||||
Type | Reference(AU Core Patient, Patient, Group) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | patient | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
18. Encounter.participant | |||||||
Definition | The list of people responsible for providing the service. | ||||||
Short | List of participants involved in the encounter | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
20. 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). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | 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 | extensions, user content, modifiers | ||||||
Invariants | 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()) | ||||||
22. Encounter.participant.type | |||||||
Definition | Role of participant in encounter. | ||||||
Short | Role of participant in encounter | ||||||
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. | ||||||
Control | 0..* | ||||||
Binding | Unless not suitable, these codes SHALL be taken from ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type )Role of participant in encounter. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
24. Encounter.participant.individual | |||||||
Definition | Persons involved in the encounter other than the patient. | ||||||
Short | Persons involved in the encounter other than the patient | ||||||
Control | 0..1 | ||||||
Type | Reference(AU Core Practitioner, AU Core PractitionerRole, AU Base Related Person, Practitioner, PractitionerRole, RelatedPerson) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
26. Encounter.period | |||||||
Definition | The start and end time of the encounter. | ||||||
Short | The start and end time of the encounter | ||||||
Comments | If not (yet) known, the end of the Period may be omitted. | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
28. Encounter.reasonCode | |||||||
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||||||
Short | Coded reason the encounter takes place | ||||||
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). | ||||||
Control | 0..* | ||||||
Binding | The codes SHOULD be taken from EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason (preferred to http://hl7.org/fhir/ValueSet/encounter-reason )Reason why the encounter takes place. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | Indication, Admission diagnosis | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
30. Encounter.reasonReference | |||||||
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||||||
Short | Reason the encounter takes place (reference) | ||||||
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). | ||||||
Control | 0..* | ||||||
Type | Reference(AU Core Condition, Observation, AU Core Procedure, Condition, Procedure, ImmunizationRecommendation) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | Indication, Admission diagnosis | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
32. Encounter.location | |||||||
Definition | List of locations where the patient has been during this encounter. | ||||||
Short | List of locations where the patient has been | ||||||
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". | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
34. 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). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | 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 | extensions, user content, modifiers | ||||||
Invariants | 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.location.location | |||||||
Definition | The location where the encounter takes place. | ||||||
Short | Location the encounter takes place | ||||||
Control | 1..1 | ||||||
Type | Reference(AU Core Location, Location) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
38. 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. | ||||||
Short | The organization (facility) responsible for this encounter | ||||||
Control | 0..1 | ||||||
Type | Reference(AU Core Organization, Organization) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. 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. | ||||||
Short | An encounter in an Australian healthcare context | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | Visit | ||||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() ) | ||||||
2. Encounter.id | |||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||
Short | Logical id of this artifact | ||||||
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. | ||||||
Control | 0..1 | ||||||
Type | id | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
4. 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. | ||||||
Short | Metadata about the resource | ||||||
Control | 0..1 | ||||||
Type | Meta | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
6. 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. | ||||||
Short | A set of rules under which this content was created | ||||||
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. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
8. Encounter.language | |||||||
Definition | The base language in which the resource is written. | ||||||
Short | Language of the resource content | ||||||
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). | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
10. 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. | ||||||
Short | Text summary of the resource, for human interpretation | ||||||
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. | ||||||
Control | 0..1 | ||||||
Type | Narrative | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | narrative, html, xhtml, display | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
12. 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. | ||||||
Short | Contained, inline 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. | ||||||
Control | 0..* | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||
14. Encounter.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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 areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
16. Encounter.extension:encounterDescription | |||||||
Slice Name | encounterDescription | ||||||
Definition | Description, overview or summary of a clinical event and its reasons. | ||||||
Short | Description, overview or summary of an encounter | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Encounter Description) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Invariants | 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.extension:associatedHealthcareService | |||||||
Slice Name | associatedHealthcareService | ||||||
Definition | Healthcare service relating to a resource. | ||||||
Short | Associated healthcare service | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Associated Healthcare Service) (Extension Type: Reference(HealthcareService)) | ||||||
Is Modifier | false | ||||||
Invariants | 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() ) | ||||||
20. 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). | ||||||
Short | Extensions that cannot be ignored | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
Summary | false | ||||||
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 | extensions, user content | ||||||
Invariants | 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() ) | ||||||
22. Encounter.identifier | |||||||
Definition | Identifier(s) by which this encounter is known. | ||||||
Short | Identifier(s) by which this encounter is known | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
24. Encounter.status | |||||||
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +. | ||||||
Short | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | ||||||
Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from EncounterStatus (required to http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 )Current state of the encounter. | ||||||
Type | code | ||||||
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
26. 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. | ||||||
Short | List of past encounter statuses | ||||||
Comments | The current status is always found in the current version of the resource, not the status history. | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
28. 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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
30. 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. | ||||||
Short | Additional content defined by implementations | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
32. 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). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | 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 | extensions, user content, modifiers | ||||||
Invariants | 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() ) | ||||||
34. Encounter.statusHistory.status | |||||||
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +. | ||||||
Short | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from EncounterStatus (required to http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 )Current state of the encounter. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
36. Encounter.statusHistory.period | |||||||
Definition | The time that the episode was in the specified status. | ||||||
Short | The time that the episode was in the specified status | ||||||
Control | 1..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
38. Encounter.class | |||||||
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. | ||||||
Short | Classification of patient encounter | ||||||
Control | 1..1 | ||||||
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode - AU Extended (extensible to http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended ) | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
40. 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. | ||||||
Short | List of past encounter classes | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
42. 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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
44. 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. | ||||||
Short | Additional content defined by implementations | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
46. 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). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | 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 | extensions, user content, modifiers | ||||||
Invariants | 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.classHistory.class | |||||||
Definition | inpatient | outpatient | ambulatory | emergency +. | ||||||
Short | inpatient | outpatient | ambulatory | emergency + | ||||||
Control | 1..1 | ||||||
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode )Classification of the encounter. | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
50. Encounter.classHistory.period | |||||||
Definition | The time that the episode was in the specified class. | ||||||
Short | The time that the episode was in the specified class | ||||||
Control | 1..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
52. Encounter.type | |||||||
Definition | Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). | ||||||
Short | Specific type of encounter | ||||||
Comments | Since there are many ways to further classify encounters, this element is 0..*. | ||||||
Control | 0..* | ||||||
Binding | The codes SHOULD be taken from Encounter Type (preferred to https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
54. Encounter.serviceType | |||||||
Definition | Broad categorization of the service that is to be provided (e.g. cardiology). | ||||||
Short | Specific type of service | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from Service Type (preferred to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
56. Encounter.priority | |||||||
Definition | Indicates the urgency of the encounter. | ||||||
Short | Indicates the urgency of the encounter | ||||||
Control | 0..1 | ||||||
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority )Indicates the urgency of the encounter. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
58. Encounter.subject | |||||||
Definition | The patient or group present at the encounter. | ||||||
Short | The patient or group present at the encounter | ||||||
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). | ||||||
Control | 1..1 | ||||||
Type | Reference(AU Core Patient) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | patient | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
60. 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). | ||||||
Short | Episode(s) of care that this encounter should be recorded against | ||||||
Control | 0..* | ||||||
Type | Reference(EpisodeOfCare) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
62. Encounter.basedOn | |||||||
Definition | The request this encounter satisfies (e.g. incoming referral or procedure request). | ||||||
Short | The ServiceRequest that initiated this encounter | ||||||
Control | 0..* | ||||||
Type | Reference(ServiceRequest) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | incomingReferral | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
64. Encounter.participant | |||||||
Definition | The list of people responsible for providing the service. | ||||||
Short | List of participants involved in the encounter | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
66. 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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
68. 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. | ||||||
Short | Additional content defined by implementations | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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.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). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | 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 | extensions, user content, modifiers | ||||||
Invariants | 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() ) | ||||||
72. Encounter.participant.type | |||||||
Definition | Role of participant in encounter. | ||||||
Short | Role of participant in encounter | ||||||
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. | ||||||
Control | 0..* | ||||||
Binding | Unless not suitable, these codes SHALL be taken from ParticipantType (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type )Role of participant in encounter. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
74. 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. | ||||||
Short | Period of time during the encounter that the participant participated | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
76. Encounter.participant.individual | |||||||
Definition | Persons involved in the encounter other than the patient. | ||||||
Short | Persons involved in the encounter other than the patient | ||||||
Control | 0..1 | ||||||
Type | Reference(AU Core Practitioner, AU Core PractitionerRole, AU Base Related Person) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
78. Encounter.appointment | |||||||
Definition | The appointment that scheduled this encounter. | ||||||
Short | The appointment that scheduled this encounter | ||||||
Control | 0..* | ||||||
Type | Reference(Appointment) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
80. Encounter.period | |||||||
Definition | The start and end time of the encounter. | ||||||
Short | The start and end time of the encounter | ||||||
Comments | If not (yet) known, the end of the Period may be omitted. | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
82. Encounter.length | |||||||
Definition | Quantity of time the encounter lasted. This excludes the time during leaves of absence. | ||||||
Short | Quantity of time the encounter lasted (less time absent) | ||||||
Comments | May differ from the time the Encounter.period lasted because of leave of absence. | ||||||
Control | 0..1 | ||||||
Type | Duration | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
84. Encounter.reasonCode | |||||||
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||||||
Short | Coded reason the encounter takes place | ||||||
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). | ||||||
Control | 0..* | ||||||
Binding | The codes SHOULD be taken from EncounterReasonCodes (preferred to http://hl7.org/fhir/ValueSet/encounter-reason )Reason why the encounter takes place. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | Indication, Admission diagnosis | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
86. Encounter.reasonReference | |||||||
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||||||
Short | Reason the encounter takes place (reference) | ||||||
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). | ||||||
Control | 0..* | ||||||
Type | Reference(AU Core Condition, Observation, AU Core Procedure) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | Indication, Admission diagnosis | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
88. Encounter.diagnosis | |||||||
Definition | The list of diagnosis relevant to this encounter. | ||||||
Short | The list of diagnosis relevant to this encounter | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
90. 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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
92. 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. | ||||||
Short | Additional content defined by implementations | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
94. 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). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | 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 | extensions, user content, modifiers | ||||||
Invariants | 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() ) | ||||||
96. 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. | ||||||
Short | The diagnosis or procedure relevant to the encounter | ||||||
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). | ||||||
Control | 1..1 | ||||||
Type | Reference(Condition, Procedure) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Alternate Names | Admission diagnosis, discharge diagnosis, indication | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
98. Encounter.diagnosis.use | |||||||
Definition | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …). | ||||||
Short | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from DiagnosisRole (preferred to http://hl7.org/fhir/ValueSet/diagnosis-role )The type of diagnosis this condition represents. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
100. Encounter.diagnosis.rank | |||||||
Definition | Ranking of the diagnosis (for each role type). | ||||||
Short | Ranking of the diagnosis (for each role type) | ||||||
Control | 0..1 | ||||||
Type | positiveInt | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
102. Encounter.account | |||||||
Definition | The set of accounts that may be used for billing for this Encounter. | ||||||
Short | The set of accounts that may be used for billing for this Encounter | ||||||
Comments | The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. | ||||||
Control | 0..* | ||||||
Type | Reference(Account) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
104. Encounter.hospitalization | |||||||
Definition | Details about the admission to a healthcare service. | ||||||
Short | Details about the admission to a healthcare service | ||||||
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. | ||||||
Control | 0..1 | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
106. 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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
108. 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. | ||||||
Short | Additional content defined by implementations | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
110. 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). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | 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 | extensions, user content, modifiers | ||||||
Invariants | 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() ) | ||||||
112. Encounter.hospitalization.preAdmissionIdentifier | |||||||
Definition | Pre-admission identifier. | ||||||
Short | Pre-admission identifier | ||||||
Control | 0..1 | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
114. Encounter.hospitalization.origin | |||||||
Definition | The location/organization from which the patient came before admission. | ||||||
Short | The location/organization from which the patient came before admission | ||||||
Control | 0..1 | ||||||
Type | Reference(Location, Organization) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
116. Encounter.hospitalization.admitSource | |||||||
Definition | From where patient was admitted (physician referral, transfer). | ||||||
Short | From where patient was admitted (physician referral, transfer) | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from AdmitSource (preferred to http://hl7.org/fhir/ValueSet/encounter-admit-source )From where the patient was admitted. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
118. Encounter.hospitalization.reAdmission | |||||||
Definition | Whether this hospitalization is a readmission and why if known. | ||||||
Short | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission | ||||||
Control | 0..1 | ||||||
Binding | For example codes, see hl7VS-re-admissionIndicator (example to http://terminology.hl7.org/ValueSet/v2-0092 )The reason for re-admission of this hospitalization encounter. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
120. Encounter.hospitalization.dietPreference | |||||||
Definition | Diet preferences reported by the patient. | ||||||
Short | Diet preferences reported by the patient | ||||||
Comments | For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive). | ||||||
Control | 0..* | ||||||
Binding | For example codes, see Diet (example to http://hl7.org/fhir/ValueSet/encounter-diet )Medical, cultural or ethical food preferences to help with catering requirements. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
122. Encounter.hospitalization.specialCourtesy | |||||||
Definition | Special courtesies (VIP, board member). | ||||||
Short | Special courtesies (VIP, board member) | ||||||
Control | 0..* | ||||||
Binding | The codes SHOULD be taken from SpecialCourtesy (preferred to http://hl7.org/fhir/ValueSet/encounter-special-courtesy )Special courtesies. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
124. 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. | ||||||
Short | Wheelchair, translator, stretcher, etc. | ||||||
Control | 0..* | ||||||
Binding | The codes SHOULD be taken from SpecialArrangements (preferred to http://hl7.org/fhir/ValueSet/encounter-special-arrangements )Special arrangements. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
126. Encounter.hospitalization.destination | |||||||
Definition | Location/organization to which the patient is discharged. | ||||||
Short | Location/organization to which the patient is discharged | ||||||
Control | 0..1 | ||||||
Type | Reference(Location, Organization) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
128. Encounter.hospitalization.dischargeDisposition | |||||||
Definition | Category or kind of location after discharge. | ||||||
Short | Separation Mode | ||||||
Control | 0..1 | ||||||
Binding | Unless not suitable, these codes SHALL be taken from Separation Mode (extensible to https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
130. Encounter.location | |||||||
Definition | List of locations where the patient has been during this encounter. | ||||||
Short | List of locations where the patient has been | ||||||
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". | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
132. 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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
134. 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. | ||||||
Short | Additional content defined by implementations | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
136. 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). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | 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 | extensions, user content, modifiers | ||||||
Invariants | 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() ) | ||||||
138. Encounter.location.location | |||||||
Definition | The location where the encounter takes place. | ||||||
Short | Location the encounter takes place | ||||||
Control | 1..1 | ||||||
Type | Reference(AU Core Location) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
140. 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. | ||||||
Short | planned | active | reserved | completed | ||||||
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. | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from EncounterLocationStatus (required to http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 )The status of the location. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
142. 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. | ||||||
Short | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) | ||||||
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. | ||||||
Control | 0..1 | ||||||
Binding | For example codes, see LocationType (example to http://hl7.org/fhir/ValueSet/location-physical-type )Physical form of the location. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
144. Encounter.location.period | |||||||
Definition | Time period during which the patient was present at the location. | ||||||
Short | Time period during which the patient was present at the location | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
146. 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. | ||||||
Short | The organization (facility) responsible for this encounter | ||||||
Control | 0..1 | ||||||
Type | Reference(AU Core Organization) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
148. Encounter.partOf | |||||||
Definition | Another Encounter of which this encounter is a part of (administratively or in time). | ||||||
Short | Another Encounter this encounter is part of | ||||||
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. | ||||||
Control | 0..1 | ||||||
Type | Reference(Encounter) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |