Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build
Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-encounter | Version: 1.2.60 | |||
| Active as of 2026-04-05 | Computable Name: EOrdersEncounter | |||
Minimum Genie Encounter profile for EOrders Diagnostic Request. The sole use at present is to specify that the request is community diagnostic request, i.e. ambulatory, to distinguish it from possible future support for in-patient/hospital diagnostic requesting.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |
![]() ![]() ![]() |
0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | Assumes the encounter where the request was made is finished Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: finished |
![]() ![]() |
SΣ | 1..1 | Coding | Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory) Binding: ActEncounterCode - AU Extended (extensible) Required Pattern: At least the following |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB | |
![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() |
SΣ | 0..1 | Reference(Genie Patient) | Patient the request is for |
![]() ![]() ![]() |
ΣC | 1..1 | string | Relative reference to Patient |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode - AU Extended | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | 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 | error | Encounter | 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 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUBaseEncounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
AUBaseEncounter | |||
![]() ![]() |
S | 0..1 | id | Logical id of this artifact |
![]() ![]() |
S | 1..1 | code | Assumes the encounter where the request was made is finished Required Pattern: finished |
![]() ![]() |
S | 1..1 | Coding | Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory) Required Pattern: At least the following |
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB | |
![]() ![]() |
S | 0..1 | Reference(Genie Patient) | Patient the request is for |
![]() ![]() ![]() |
1..1 | string | Relative reference to Patient | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |||||
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |||||
![]() ![]() ![]() |
0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() |
?!SΣ | 1..1 | code | Assumes the encounter where the request was made is finished Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: finished | ||||
![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() |
SΣ | 1..1 | Coding | Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory) Binding: ActEncounterCode - AU Extended (extensible) Required Pattern: At least the following | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |||||
![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB | |||||
![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type (preferred) | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
SΣ | 0..1 | Reference(Genie Patient) | Patient the request is for | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 1..1 | string | Relative reference to Patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
0..1 | Period | The start and end time of the encounter | |||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Separation Mode Binding: Separation Mode (extensible) | |||||
![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode - AU Extended | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1 |
| Encounter.type | Base | preferred |
Encounter Type
|
⏿1.0.1 | tx.hl7.org.au |
| Encounter.serviceType | Base | preferred |
Service Type
|
⏿1.0.0 | tx.hl7.org.au |
| Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1 |
| Encounter.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.participant.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.1 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | extensible |
Separation Mode
|
⏿1.0.1 | tx.hl7.org.au |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | 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 | error | Encounter | 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 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUBaseEncounter
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |
![]() ![]() ![]() |
0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | Assumes the encounter where the request was made is finished Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: finished |
![]() ![]() |
SΣ | 1..1 | Coding | Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory) Binding: ActEncounterCode - AU Extended (extensible) Required Pattern: At least the following |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB | |
![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() |
SΣ | 0..1 | Reference(Genie Patient) | Patient the request is for |
![]() ![]() ![]() |
ΣC | 1..1 | string | Relative reference to Patient |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode - AU Extended | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | 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 | error | Encounter | 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 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AUBaseEncounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
AUBaseEncounter | |||
![]() ![]() |
S | 0..1 | id | Logical id of this artifact |
![]() ![]() |
S | 1..1 | code | Assumes the encounter where the request was made is finished Required Pattern: finished |
![]() ![]() |
S | 1..1 | Coding | Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory) Required Pattern: At least the following |
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB | |
![]() ![]() |
S | 0..1 | Reference(Genie Patient) | Patient the request is for |
![]() ![]() ![]() |
1..1 | string | Relative reference to Patient | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |||||
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |||||
![]() ![]() ![]() |
0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() |
?!SΣ | 1..1 | code | Assumes the encounter where the request was made is finished Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: finished | ||||
![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() |
SΣ | 1..1 | Coding | Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory) Binding: ActEncounterCode - AU Extended (extensible) Required Pattern: At least the following | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |||||
![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB | |||||
![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type (preferred) | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
SΣ | 0..1 | Reference(Genie Patient) | Patient the request is for | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 1..1 | string | Relative reference to Patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
0..1 | Period | The start and end time of the encounter | |||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Separation Mode Binding: Separation Mode (extensible) | |||||
![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode - AU Extended | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1 |
| Encounter.type | Base | preferred |
Encounter Type
|
⏿1.0.1 | tx.hl7.org.au |
| Encounter.serviceType | Base | preferred |
Service Type
|
⏿1.0.0 | tx.hl7.org.au |
| Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1 |
| Encounter.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Encounter.participant.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.1 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | extensible |
Separation Mode
|
⏿1.0.1 | tx.hl7.org.au |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | 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 | error | Encounter | 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 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUBaseEncounter
Other representations of profile: CSV, Excel, Schematron