AU Patient Summary Implementation Guide
0.1.0-preview - Preview
This page is part of the AU Patient Summary (v0.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-encounter | Version: 0.1.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSEncounter | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for an Encounter resource in the context of a patient summary in an Australian context. It is based on the AU Base Encounter profile, and applies the constraints of AU Core Encounter and IPS.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
Encounter.reasonCode, or a reference with Encounter.reasonReference to a Condition or other resource.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseEncounter
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context This profile also complies with the profile AU Core Encounter | |
![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() |
S | 1..1 | Coding | Classification of patient encounter |
![]() ![]() |
S | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) |
![]() ![]() |
S | 1..1 | Reference(AU PS Patient) | The patient or group present at the encounter |
![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Role of participant in encounter |
![]() ![]() ![]() |
S | 0..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) | Persons involved in the encounter other than the patient |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter |
![]() ![]() |
S | 0..* | CodeableConcept | Coded reason the encounter takes place |
![]() ![]() |
S | 0..* | Reference(AU PS Condition | Observation | AU PS Procedure) | Reason the encounter takes place (reference) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() |
S | 1..1 | Reference(AU Core Location) | Location the encounter takes place |
![]() ![]() |
S | 0..1 | Reference(AU PS Organization) | The organization (facility) responsible for this encounter |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.serviceType | preferred | ServiceType ![]() https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context This profile also complies with the profile AU Core Encounter dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | Reference(AU PS Patient) | The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) | Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | Reference(AU PS Condition | Observation | AU PS Procedure) | Reason the encounter takes place (reference) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
S | 1..1 | Reference(AU Core Location) | Location the encounter takes place ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..1 | Reference(AU PS Organization) | The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.class | extensible | ActEncounterCodeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended | |
| Encounter.serviceType | preferred | ServiceType ![]() https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context This profile also complies with the profile AU Core Encounter | |||||
![]() ![]() |
Σ | 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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
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 | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() |
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 | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) | ||||
![]() ![]() |
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 (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) | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
SΣ | 1..1 | Reference(AU PS Patient) | The patient or group present at the encounter | ||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() |
SΣ | 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 | ||||
![]() ![]() ![]() |
SΣ | 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 | |||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter | ||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() |
SΣ | 0..* | Reference(AU PS Condition | Observation | AU PS Procedure) | 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: hl7VS-re-admissionIndicator (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) | |||||
![]() ![]() |
S | 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 | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(AU Core 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 | |||||
![]() ![]() |
S | 0..1 | Reference(AU PS Organization) | The organization (facility) responsible for this encounter | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | ||||
| Encounter.class | extensible | ActEncounterCodeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.type | preferred | EncounterType ![]() https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 | ||||
| Encounter.serviceType | preferred | ServiceType ![]() https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
| Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard | ||||
| Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-sourcefrom the FHIR Standard | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-dietfrom the FHIR Standard | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesyfrom the FHIR Standard | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangementsfrom the FHIR Standard | ||||
| Encounter.hospitalization.dischargeDisposition | extensible | SeparationMode (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1from the FHIR Standard | ||||
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUBaseEncounter
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context This profile also complies with the profile AU Core Encounter | |
![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() |
S | 1..1 | Coding | Classification of patient encounter |
![]() ![]() |
S | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) |
![]() ![]() |
S | 1..1 | Reference(AU PS Patient) | The patient or group present at the encounter |
![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Role of participant in encounter |
![]() ![]() ![]() |
S | 0..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) | Persons involved in the encounter other than the patient |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter |
![]() ![]() |
S | 0..* | CodeableConcept | Coded reason the encounter takes place |
![]() ![]() |
S | 0..* | Reference(AU PS Condition | Observation | AU PS Procedure) | Reason the encounter takes place (reference) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() |
S | 1..1 | Reference(AU Core Location) | Location the encounter takes place |
![]() ![]() |
S | 0..1 | Reference(AU PS Organization) | The organization (facility) responsible for this encounter |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.serviceType | preferred | ServiceType ![]() https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context This profile also complies with the profile AU Core Encounter dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | Reference(AU PS Patient) | The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) | Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | Reference(AU PS Condition | Observation | AU PS Procedure) | Reason the encounter takes place (reference) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
S | 1..1 | Reference(AU Core Location) | Location the encounter takes place ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
S | 0..1 | Reference(AU PS Organization) | The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.class | extensible | ActEncounterCodeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended | |
| Encounter.serviceType | preferred | ServiceType ![]() https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseEncounter | An encounter in an Australian healthcare context This profile also complies with the profile AU Core Encounter | |||||
![]() ![]() |
Σ | 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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
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 | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() |
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 | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) | ||||
![]() ![]() |
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 (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) | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
SΣ | 1..1 | Reference(AU PS Patient) | The patient or group present at the encounter | ||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() |
SΣ | 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 | ||||
![]() ![]() ![]() |
SΣ | 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 | |||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter | ||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() |
SΣ | 0..* | Reference(AU PS Condition | Observation | AU PS Procedure) | 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: hl7VS-re-admissionIndicator (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) | |||||
![]() ![]() |
S | 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 | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(AU Core 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 | |||||
![]() ![]() |
S | 0..1 | Reference(AU PS Organization) | The organization (facility) responsible for this encounter | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | ||||
| Encounter.class | extensible | ActEncounterCodeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.type | preferred | EncounterType ![]() https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 | ||||
| Encounter.serviceType | preferred | ServiceType ![]() https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
| Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard | ||||
| Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-sourcefrom the FHIR Standard | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-dietfrom the FHIR Standard | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesyfrom the FHIR Standard | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangementsfrom the FHIR Standard | ||||
| Encounter.hospitalization.dischargeDisposition | extensible | SeparationMode (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1from the FHIR Standard | ||||
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron