AU Patient Summary Implementation Guide
0.5.0-cibuild - CI Build Australia flag

AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.5.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions

Resource Profile: AU PS Encounter

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-encounter Version: 0.5.0-cibuild
Standards status: Draft Maturity Level: 0 Computable Name: AUPSEncounter

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for an Encounter resource in the context of a patient summary in an Australian context. It is based on the AU Core Encounter profile, and applies the additional constraints for use in a patient summary context consistent with the profiling conventions of IPS.

See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

Profile Specific Implementation Guidance

  • See the guidance on implementing the Encounter resource in AU Core.
  • The Encounter resource can represent a clinical indication with Encounter.reasonCode, or a reference with Encounter.reasonReference to a Condition or other resource.
    • Although both are marked as Must Support, producers are not required to support both a code and a reference, but they SHALL support at least one of these elements
    • A consumer SHALL support both elements

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

This structure is derived from AUCoreEncounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* AUCoreEncounter An encounter in an Australian healthcare context
... status O 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... class O 1..1 Coding Classification of patient encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... serviceType O 0..1 CodeableConcept Specific type of service
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... participant O 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... type O 0..* CodeableConcept Role of participant in encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... individual O 0..1 Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) Persons involved in the encounter other than the patient
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... period O 0..1 Period The start and end time of the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonCode O 0..* CodeableConcept Coded reason the encounter takes place
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonReference O 0..* Reference(AU PS Condition | Observation | AU PS Procedure) Reason the encounter takes place (reference)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... location O 0..* BackboneElement List of locations where the patient has been
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... location O 1..1 Reference(AU Core Location) Location the encounter takes place
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... serviceProvider O 0..1 Reference(AU PS Organization) The organization (facility) responsible for this encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* AUCoreEncounter An encounter in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SOΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... serviceType SOΣ 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... subject SOΣ 1..1 Reference(AU PS Patient) The patient or group present at the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... participant SOΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SOΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... individual SOΣ 0..1 Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) Persons involved in the encounter other than the patient
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... period SO 0..1 Period The start and end time of the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonCode SOΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: Reason For Encounter . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonReference SOΣ 0..* Reference(AU PS Condition | Observation | AU PS Procedure) Reason the encounter takes place (reference)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... location SO 0..* BackboneElement List of locations where the patient has been
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location SO 1..1 Reference(AU Core Location) Location the encounter takes place
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... serviceProvider SO 0..1 Reference(AU PS Organization) The organization (facility) responsible for this encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

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.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.reasonCodepreferredReasonForEncounter .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* AUCoreEncounter 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!SOΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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 SOΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode - AU Extended (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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 Σ 0..* CodeableConcept Specific type of encounter
Binding: Encounter Type . (preferred)
... serviceType SOΣ 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SOΣ 1..1 Reference(AU PS Patient) The patient or group present at the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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 SOΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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 SOΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual SOΣ 0..1 Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) Persons involved in the encounter other than the patient
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period SO 0..1 Period The start and end time of the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SOΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: Reason For Encounter . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonReference SOΣ 0..* Reference(AU PS Condition | Observation | AU PS Procedure) Reason the encounter takes place (reference)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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 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 0..1 CodeableConcept Separation Mode
Binding: Separation Mode . (extensible)
... location SO 0..* BackboneElement List of locations where the patient has been
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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 SO 1..1 Reference(AU Core Location) Location the encounter takes place
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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 SO 0..1 Reference(AU PS Organization) The organization (facility) responsible for this encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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.reasonCodepreferredReasonForEncounter .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1
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
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from AUCoreEncounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* AUCoreEncounter An encounter in an Australian healthcare context
... status O 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... class O 1..1 Coding Classification of patient encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... serviceType O 0..1 CodeableConcept Specific type of service
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... participant O 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... type O 0..* CodeableConcept Role of participant in encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... individual O 0..1 Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) Persons involved in the encounter other than the patient
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... period O 0..1 Period The start and end time of the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonCode O 0..* CodeableConcept Coded reason the encounter takes place
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonReference O 0..* Reference(AU PS Condition | Observation | AU PS Procedure) Reason the encounter takes place (reference)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... location O 0..* BackboneElement List of locations where the patient has been
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... location O 1..1 Reference(AU Core Location) Location the encounter takes place
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... serviceProvider O 0..1 Reference(AU PS Organization) The organization (facility) responsible for this encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* AUCoreEncounter An encounter in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SOΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... serviceType SOΣ 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... subject SOΣ 1..1 Reference(AU PS Patient) The patient or group present at the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... participant SOΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SOΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... individual SOΣ 0..1 Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) Persons involved in the encounter other than the patient
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... period SO 0..1 Period The start and end time of the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonCode SOΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: Reason For Encounter . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonReference SOΣ 0..* Reference(AU PS Condition | Observation | AU PS Procedure) Reason the encounter takes place (reference)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... location SO 0..* BackboneElement List of locations where the patient has been
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location SO 1..1 Reference(AU Core Location) Location the encounter takes place
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... serviceProvider SO 0..1 Reference(AU PS Organization) The organization (facility) responsible for this encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

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.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.reasonCodepreferredReasonForEncounter .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* AUCoreEncounter 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!SOΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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 SOΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode - AU Extended (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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 Σ 0..* CodeableConcept Specific type of encounter
Binding: Encounter Type . (preferred)
... serviceType SOΣ 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SOΣ 1..1 Reference(AU PS Patient) The patient or group present at the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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 SOΣ 0..* BackboneElement List of participants involved in the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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 SOΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual SOΣ 0..1 Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS RelatedPerson) Persons involved in the encounter other than the patient
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period SO 0..1 Period The start and end time of the encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SOΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: Reason For Encounter . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... reasonReference SOΣ 0..* Reference(AU PS Condition | Observation | AU PS Procedure) Reason the encounter takes place (reference)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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 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 0..1 CodeableConcept Separation Mode
Binding: Separation Mode . (extensible)
... location SO 0..* BackboneElement List of locations where the patient has been
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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 SO 1..1 Reference(AU Core Location) Location the encounter takes place
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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 SO 0..1 Reference(AU PS Organization) The organization (facility) responsible for this encounter
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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.reasonCodepreferredReasonForEncounter .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1
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
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron