AU Core Implementation Guide
0.3.0-ballot - R1
AU Core Implementation Guide
0.3.0-ballot - R1
This page is part of the AU Core (v0.3.0-ballot: AU Core R1 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter | Version: 0.3.0-ballot | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreEncounter | ||
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 to record, search, and fetch basic encounter information for a patient. It is based on the AU Base Encounter profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Encounter when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
A resource conforming to this profile:
No equivalent International Patient Access or International Patient Summary profile.
Conformance in reverse is not guaranteed, i.e. a resource conforming to US Core MAY NOT conform to AU Core.
Encounter.code.text and/or Encounter.code.coding.display so that client applications can at least display the condition even if the client application does not recognise the code supplied.Encounter.reasonCode, or a reference with Encounter.reasonReference to a Condition or other resource.
Feedback is requested on the proposals to remove Must Support from the following elements:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseEncounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Encounter | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |
  identifier | S | 0..* | Identifier | Identifier(s) by which this encounter is known |
| status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| class | S | 1..1 | Coding | Classification of patient encounter |
| type | S | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type  (preferred) |
| serviceType | S | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) |
 subject | S | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter |
 participant | S | 0..* | BackboneElement | List of participants involved in the encounter |
 type | S | 0..* | CodeableConcept | Role of participant in encounter |
 individual | S | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient |
| period | S | 0..1 | Period | The start and end time of the encounter |
| reasonCode | S | 0..* | CodeableConcept | Coded reason the encounter takes place |
| reasonReference | S | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference) |
| hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode |
| location | S | 0..* | BackboneElement | List of locations where the patient has been |
| location | S | 1..1 | Reference(AU Core Location) | Location the encounter takes place |
| serviceProvider | S | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| 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 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 encounterDescription | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |
| associatedHealthcareService | 0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
| status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
| class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) |
| type | SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type (preferred) |
| serviceType | SΣ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter |
| participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
| individual | SΣ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient |
| period | S | 0..1 | Period | The start and end time of the encounter |
| reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
| reasonReference | SΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference) |
| hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode Binding: Separation Mode (extensible) |
| location | S | 0..* | BackboneElement | List of locations where the patient has been |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| location | S | 1..1 | Reference(AU Core Location) | Location the encounter takes place |
| serviceProvider | S | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter |
| 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.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.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.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 |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| encounterDescription | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |||||
| associatedHealthcareService | 0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
| status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
| statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified status | |||||
| class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) | ||||
| classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified class | |||||
| type | SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type (preferred) | ||||
| serviceType | SΣ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) | ||||
| priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter | ||||
| episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
| basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
| appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
| period | S | 0..1 | Period | The start and end time of the encounter | ||||
| length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
| reasonReference | SΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference) | ||||
| diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
| use | 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. | |||||
| rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
| origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
| admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
| reAdmission | 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. | |||||
| dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
| specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
| specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
| destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode Binding: Separation Mode (extensible) | ||||
| location | S | 0..* | BackboneElement | List of locations where the patient has been | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| location | S | 1..1 | Reference(AU Core Location) | Location the encounter takes place | ||||
| status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType | 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. | |||||
| period | 0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider | S | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter | ||||
| partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Encounter.language | preferred | CommonLanguages
http://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: 17 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 |
|---|---|---|---|---|
| Encounter | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |
| identifier | S | 0..* | Identifier | Identifier(s) by which this encounter is known |
| status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| class | S | 1..1 | Coding | Classification of patient encounter |
| type | S | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type (preferred) |
| serviceType | S | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) |
| subject | S | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter |
| participant | S | 0..* | BackboneElement | List of participants involved in the encounter |
| type | S | 0..* | CodeableConcept | Role of participant in encounter |
| individual | S | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient |
| period | S | 0..1 | Period | The start and end time of the encounter |
| reasonCode | S | 0..* | CodeableConcept | Coded reason the encounter takes place |
| reasonReference | S | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference) |
| hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode |
| location | S | 0..* | BackboneElement | List of locations where the patient has been |
| location | S | 1..1 | Reference(AU Core Location) | Location the encounter takes place |
| serviceProvider | S | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| 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 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| encounterDescription | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |
| associatedHealthcareService | 0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
| status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
| class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) |
| type | SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type (preferred) |
| serviceType | SΣ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter |
| participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
| individual | SΣ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient |
| period | S | 0..1 | Period | The start and end time of the encounter |
| reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
| reasonReference | SΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference) |
| hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode Binding: Separation Mode (extensible) |
| location | S | 0..* | BackboneElement | List of locations where the patient has been |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| location | S | 1..1 | Reference(AU Core Location) | Location the encounter takes place |
| serviceProvider | S | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter |
| 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.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.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.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 |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| encounterDescription | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |||||
| associatedHealthcareService | 0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
| status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
| statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified status | |||||
| class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) | ||||
| classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified class | |||||
| type | SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type (preferred) | ||||
| serviceType | SΣ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred) | ||||
| priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter | ||||
| episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
| basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
| appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
| period | S | 0..1 | Period | The start and end time of the encounter | ||||
| length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
| reasonReference | SΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference) | ||||
| diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
| use | 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. | |||||
| rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
| origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
| admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
| reAdmission | 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. | |||||
| dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
| specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
| specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
| destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode Binding: Separation Mode (extensible) | ||||
| location | S | 0..* | BackboneElement | List of locations where the patient has been | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| location | S | 1..1 | Reference(AU Core Location) | Location the encounter takes place | ||||
| status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType | 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. | |||||
| period | 0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider | S | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter | ||||
| partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Encounter.language | preferred | CommonLanguages
http://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: 17 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| patient | SHALL | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
| patient+date | SHALL | reference+date |
|
| patient+class | SHOULD | reference+token |
|
| patient+discharge-disposition | SHOULD | reference+token |
|
| patient.identifier | SHOULD | reference.token |
The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
| patient+location | SHOULD | reference+reference |
|
| patient+status | SHOULD | reference+token |
|
| patient+type | SHOULD | reference+token |
|
| class | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| date | MAY | date |
A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
| discharge-disposition | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| identifier | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| location | MAY | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
| status | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| type | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
The following search parameters and search parameter combinations SHALL be supported:
patient search parameter:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Encounter?patient={Type/}[id] or optionally GET [base]/Encounter?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient (how to search by reference and how to search by token)
patient and date search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])date comparators: gt,lt,ge,ledate (e.g.date=[date]&date=[date]]&...)GET [base]/Encounter?patient={Type/}[id]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient and date (how to search by reference and how to search by date)
The following search parameters and search parameter combinations SHOULD be supported:
patient and class search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Encounter?patient={Type/}[id]&class={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient and class (how to search by reference and how to search by token)
patient and discharge-disposition search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Encounter?patient={Type/}[id]&discharge-disposition={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient and discharge disposition (how to search by reference and how to search by token)
patient and location search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Encounter?patient={Type/}[id]&location={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources matching the specified patient and location (how to search by reference)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.3.0-ballot based on FHIR 4.0.1. Generated 2024-03-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change