Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core Encounter

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1 Version: 1.0.0
Active as of 2024-09-12 Computable Name: ADHAEncounterCore

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to provide a core representation of an encounter for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend Encounter that are supported.

This profile is designed to set a core Encounter standard for:

  • Query for a patient's encounters
  • Query for records associated with a specific patient encounter
  • Record or update an encounter and records associated with an encounter

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

  • Encounter.type supports categorisation and provides an efficient way of supporting system interactions, e.g. restricting searches. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.
  • In an exchange with the My Health Record system Encounter.status is "finished".
  • The Encounter resource can represent a reason using either a code with Encounter.reasonCode, or a reference with Encounter.reasonReference to a Condition or other resource.
    • Although both are marked as must support, sending systems are not required to support both a code and a reference, but they SHALL support at least one of these elements.
    • A receiving or persisting system SHALL support both elements.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AUBaseEncounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* AUBaseEncounter An encounter in an Australian healthcare context
inv-dh-enc-04: If present, the service provider shall at least have a reference or display or a valid identifier
... Slices for extension Content/Rules for all slices
.... extension:encounterDescription S 0..1 EncounterDescription Description, overview or summary of an encounter
... status S 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class S 1..1 Coding Classification of patient encounter
... serviceType S 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
... subject SC 1..1 Reference(ADHA Core Patient) The patient or group present at the encounter
inv-dh-enc-01: At least reference or a valid identifier shall be present
... participant SC 1..* BackboneElement List of participants involved in the encounter
inv-dh-enc-02: If present, an individual shall at least have a reference, an identifier or a display
.... type S 0..* CodeableConcept Role of participant in encounter
.... individual SC 0..1 Reference(ADHA Core PractitionerRole | ADHA Core RelatedPerson) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
... reasonCode S 0..* CodeableConcept Coded reason the encounter takes place
... reasonReference[x] S 0..* Reference(ADHA Core Condition | ADHA Core Observation | ADHA 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 SC 0..* BackboneElement List of locations where the patient has been
inv-dh-enc-03: If present, location shall at least have a reference or display or a valid identifier
.... location SC 1..1 Reference(ADHA Core Location) Location the encounter takes place
... serviceProvider SC 0..1 Reference(ADHA Core Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
Encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-enc-01errorEncounter.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-enc-02errorEncounter.participantIf present, an individual shall at least have a reference, an identifier or a display
: individual.exists() implies individual.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-03errorEncounter.locationIf present, location shall at least have a reference or display or a valid identifier
: location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-04errorEncounterIf present, the service provider shall at least have a reference or display or a valid identifier
: serviceProvider.exists() implies serviceProvider.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* AUBaseEncounter An encounter in an Australian healthcare context
inv-dh-enc-04: If present, the service provider shall at least have a reference or display or a valid identifier
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... encounterDescription S 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
... 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ΣC 1..1 Reference(ADHA Core Patient) The patient or group present at the encounter
inv-dh-enc-01: At least reference or a valid identifier shall be present
... participant SΣC 1..* BackboneElement List of participants involved in the encounter
inv-dh-enc-02: If present, an individual shall at least have a reference, an identifier or a display
.... 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ΣC 0..1 Reference(ADHA Core PractitionerRole | ADHA Core RelatedPerson) Persons involved in the encounter other than the patient
... period S 1..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(ADHA Core Condition | ADHA Core Observation | ADHA 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 SC 0..* BackboneElement List of locations where the patient has been
inv-dh-enc-03: If present, location shall at least have a reference or display or a valid identifier
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location SC 1..1 Reference(ADHA Core Location) Location the encounter takes place
... serviceProvider SC 0..1 Reference(ADHA Core Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCodeAUExtended
http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
Encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-enc-01errorEncounter.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-enc-02errorEncounter.participantIf present, an individual shall at least have a reference, an identifier or a display
: individual.exists() implies individual.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-03errorEncounter.locationIf present, location shall at least have a reference or display or a valid identifier
: location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-04errorEncounterIf present, the service provider shall at least have a reference or display or a valid identifier
: serviceProvider.exists() implies serviceProvider.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* AUBaseEncounter An encounter in an Australian healthcare context
inv-dh-enc-04: If present, the service provider shall at least have a reference or display or a valid identifier
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 S 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 Σ 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ΣC 1..1 Reference(ADHA Core Patient) The patient or group present at the encounter
inv-dh-enc-01: At least reference or a valid identifier shall be present
... 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ΣC 1..* BackboneElement List of participants involved in the encounter
inv-dh-enc-02: If present, an individual shall at least have a reference, an identifier or a display
.... 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ΣC 0..1 Reference(ADHA Core PractitionerRole | ADHA Core RelatedPerson) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 1..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(ADHA Core Condition | ADHA Core Observation | ADHA 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 SC 0..* BackboneElement List of locations where the patient has been
inv-dh-enc-03: If present, location shall at least have a reference or display or a valid identifier
.... 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 SC 1..1 Reference(ADHA 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 SC 0..1 Reference(ADHA Core Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCodeAUExtended
http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
Encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-enc-01errorEncounter.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-enc-02errorEncounter.participantIf present, an individual shall at least have a reference, an identifier or a display
: individual.exists() implies individual.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-03errorEncounter.locationIf present, location shall at least have a reference or display or a valid identifier
: location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-04errorEncounterIf present, the service provider shall at least have a reference or display or a valid identifier
: serviceProvider.exists() implies serviceProvider.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())

Differential View

This structure is derived from AUBaseEncounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* AUBaseEncounter An encounter in an Australian healthcare context
inv-dh-enc-04: If present, the service provider shall at least have a reference or display or a valid identifier
... Slices for extension Content/Rules for all slices
.... extension:encounterDescription S 0..1 EncounterDescription Description, overview or summary of an encounter
... status S 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class S 1..1 Coding Classification of patient encounter
... serviceType S 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
... subject SC 1..1 Reference(ADHA Core Patient) The patient or group present at the encounter
inv-dh-enc-01: At least reference or a valid identifier shall be present
... participant SC 1..* BackboneElement List of participants involved in the encounter
inv-dh-enc-02: If present, an individual shall at least have a reference, an identifier or a display
.... type S 0..* CodeableConcept Role of participant in encounter
.... individual SC 0..1 Reference(ADHA Core PractitionerRole | ADHA Core RelatedPerson) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
... reasonCode S 0..* CodeableConcept Coded reason the encounter takes place
... reasonReference[x] S 0..* Reference(ADHA Core Condition | ADHA Core Observation | ADHA 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 SC 0..* BackboneElement List of locations where the patient has been
inv-dh-enc-03: If present, location shall at least have a reference or display or a valid identifier
.... location SC 1..1 Reference(ADHA Core Location) Location the encounter takes place
... serviceProvider SC 0..1 Reference(ADHA Core Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
Encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-enc-01errorEncounter.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-enc-02errorEncounter.participantIf present, an individual shall at least have a reference, an identifier or a display
: individual.exists() implies individual.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-03errorEncounter.locationIf present, location shall at least have a reference or display or a valid identifier
: location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-04errorEncounterIf present, the service provider shall at least have a reference or display or a valid identifier
: serviceProvider.exists() implies serviceProvider.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* AUBaseEncounter An encounter in an Australian healthcare context
inv-dh-enc-04: If present, the service provider shall at least have a reference or display or a valid identifier
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... encounterDescription S 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
... 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ΣC 1..1 Reference(ADHA Core Patient) The patient or group present at the encounter
inv-dh-enc-01: At least reference or a valid identifier shall be present
... participant SΣC 1..* BackboneElement List of participants involved in the encounter
inv-dh-enc-02: If present, an individual shall at least have a reference, an identifier or a display
.... 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ΣC 0..1 Reference(ADHA Core PractitionerRole | ADHA Core RelatedPerson) Persons involved in the encounter other than the patient
... period S 1..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(ADHA Core Condition | ADHA Core Observation | ADHA 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 SC 0..* BackboneElement List of locations where the patient has been
inv-dh-enc-03: If present, location shall at least have a reference or display or a valid identifier
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location SC 1..1 Reference(ADHA Core Location) Location the encounter takes place
... serviceProvider SC 0..1 Reference(ADHA Core Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCodeAUExtended
http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
Encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-enc-01errorEncounter.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-enc-02errorEncounter.participantIf present, an individual shall at least have a reference, an identifier or a display
: individual.exists() implies individual.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-03errorEncounter.locationIf present, location shall at least have a reference or display or a valid identifier
: location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-04errorEncounterIf present, the service provider shall at least have a reference or display or a valid identifier
: serviceProvider.exists() implies serviceProvider.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* AUBaseEncounter An encounter in an Australian healthcare context
inv-dh-enc-04: If present, the service provider shall at least have a reference or display or a valid identifier
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 S 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 Σ 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ΣC 1..1 Reference(ADHA Core Patient) The patient or group present at the encounter
inv-dh-enc-01: At least reference or a valid identifier shall be present
... 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ΣC 1..* BackboneElement List of participants involved in the encounter
inv-dh-enc-02: If present, an individual shall at least have a reference, an identifier or a display
.... 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ΣC 0..1 Reference(ADHA Core PractitionerRole | ADHA Core RelatedPerson) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 1..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(ADHA Core Condition | ADHA Core Observation | ADHA 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 SC 0..* BackboneElement List of locations where the patient has been
inv-dh-enc-03: If present, location shall at least have a reference or display or a valid identifier
.... 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 SC 1..1 Reference(ADHA 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 SC 0..1 Reference(ADHA Core Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCodeAUExtended
http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
Encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-enc-01errorEncounter.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-enc-02errorEncounter.participantIf present, an individual shall at least have a reference, an identifier or a display
: individual.exists() implies individual.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-03errorEncounter.locationIf present, location shall at least have a reference or display or a valid identifier
: location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-enc-04errorEncounterIf present, the service provider shall at least have a reference or display or a valid identifier
: serviceProvider.exists() implies serviceProvider.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.