AU Patient Summary Implementation Guide
0.6.0-cibuild - CI Build

AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.6.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/freshehr/interopen-uk-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.6.0-cibuild
Standards status: Draft | Maturity Level: 1 | 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

Examples for this Profile: Bundle/aups-gpvisit-retrieval

Usages:

- Use this Profile: AU PS Bundle
- Refer to this Profile: AU PS MedicationRequest and AU PS Procedure

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
class | SO Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
serviceType | SO Σ | 0..1 | CodeableConceptIPS | Specific type of service Binding: Service Type (preferred)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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..* | CodeableConceptIPS | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonCode | SO Σ | 0..* | CodeableConceptIPS | Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode - AU Extended | 📦6.0.1-ci-build | AU Base Implementation Guide vnull
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.hl7.org.au
Encounter.participant.​type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Reason For Encounter | ⏿1.0.0 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Encounter | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from AUCoreEncounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUCoreEncounter | An encounter in an Australian healthcare context
status | O | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
serviceType | O | 0..1 | CodeableConceptIPS | Specific type of service
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
subject | O | 1..1 | Reference(AU PS Patient) | The patient or group present at the encounter
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
type | O | 0..* | CodeableConceptIPS | Role of participant in encounter
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonCode | O | 0..* | CodeableConceptIPS | Coded reason the encounter takes place
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 Bindings | Purpose
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.
Obligations | Actor
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)
Obligations | Actor
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 | CodeableConceptIPS | Specific type of service Binding: Service Type (preferred)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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..* | CodeableConceptIPS | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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..* | CodeableConceptIPS | Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.statusHistory.​status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode - AU Extended | 📦6.0.1-ci-build | AU Base Implementation Guide vnull
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0
Encounter.type | Base | preferred | Encounter Type | ⏿1.0.1 | tx.hl7.org.au
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.hl7.org.au
Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.0
Encounter.participant.​type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Reason For Encounter | ⏿1.0.0 | tx.hl7.org.au
Encounter.diagnosis.​use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0
Encounter.hospitalization.​dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​dischargeDisposition | Base | extensible | Separation Mode | ⏿1.0.1 | tx.hl7.org.au
Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std.
Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Encounter | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from AUCoreEncounter

Summary

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)
- AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
- AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)
- AU PS RelatedPerson (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson)
- AU PS Condition (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-condition)
- AU PS Procedure (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-procedure)
- AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)

Maturity: 1

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
class | SO Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible)
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
serviceType | SO Σ | 0..1 | CodeableConceptIPS | Specific type of service Binding: Service Type (preferred)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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..* | CodeableConceptIPS | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonCode | SO Σ | 0..* | CodeableConceptIPS | Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode - AU Extended | 📦6.0.1-ci-build | AU Base Implementation Guide vnull
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.hl7.org.au
Encounter.participant.​type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Reason For Encounter | ⏿1.0.0 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Encounter | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from AUCoreEncounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUCoreEncounter | An encounter in an Australian healthcare context
status | O | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
serviceType | O | 0..1 | CodeableConceptIPS | Specific type of service
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
subject | O | 1..1 | Reference(AU PS Patient) | The patient or group present at the encounter
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
type | O | 0..* | CodeableConceptIPS | Role of participant in encounter
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
reasonCode | O | 0..* | CodeableConceptIPS | Coded reason the encounter takes place
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 Bindings | Purpose
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.
Obligations | Actor
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)
Obligations | Actor
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 | CodeableConceptIPS | Specific type of service Binding: Service Type (preferred)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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..* | CodeableConceptIPS | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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..* | CodeableConceptIPS | Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.statusHistory.​status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode - AU Extended | 📦6.0.1-ci-build | AU Base Implementation Guide vnull
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0
Encounter.type | Base | preferred | Encounter Type | ⏿1.0.1 | tx.hl7.org.au
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.hl7.org.au
Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.0
Encounter.participant.​type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Reason For Encounter | ⏿1.0.0 | tx.hl7.org.au
Encounter.diagnosis.​use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0
Encounter.hospitalization.​dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std.
Encounter.hospitalization.​dischargeDisposition | Base | extensible | Separation Mode | ⏿1.0.1 | tx.hl7.org.au
Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std.
Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Encounter | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from AUCoreEncounter

Summary

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)
- AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
- AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)
- AU PS RelatedPerson (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson)
- AU PS Condition (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-condition)
- AU PS Procedure (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-procedure)
- AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)

Maturity: 1

Other representations of profile: CSV, Excel, Schematron