AU Core Implementation Guide
2.0.0-draft - Draft

Publication Build: This will be filled in by the publication tooling

## Resource Profile: AU Core Encounter

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter | Version: 2.0.0-draft
Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUCoreEncounter
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for an Encounter resource to record, search, and fetch basic encounter information for a patient. It is based on the AU Base Encounter profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Encounter when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

### Usage scenarios

The following are supported usage scenarios for this profile:

- Query for a specific patient encounter
- Query for all patient encounters
- Record or update a patient encounter

### Profile specific implementation guidance

- 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, responders are not required to support both a code and a reference, but they SHALL support at least one of these elements
  - A requester SHALL support both elements

Usages:

- Refer to this Profile: AU Core MedicationRequest and AU Core Procedure
- Examples for this Profile: Encounter/covid-admin-1, Encounter/discharge-1 and Encounter/telehealth
- CapabilityStatements using this Profile: AU Core Requester CapabilityStatement and AU Core Responder CapabilityStatement

Changes since version 1.0.0:

- The resource metadata has changed (description)

### Formal Views of Profile Content

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

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

This structure is derived from AUBaseEncounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
status | SO | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
class | SO | 1..1 | Coding | Classification of patient encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
serviceType | SO | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
subject | SO | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
participant | SO | 0..* | BackboneElement | List of participants involved in the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
type | SO | 0..* | CodeableConcept | Role of participant in encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
individual | SO | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
period | SO | 0..1 | Period | The start and end time of the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
reasonCode | SO | 0..* | CodeableConcept | Coded reason the encounter takes place
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
reasonReference | SO | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
location | SO | 0..* | BackboneElement | List of locations where the patient has been
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
location | SO | 1..1 | Reference(AU Core Location) | Location the encounter takes place
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
serviceProvider | SO | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Encounter.serviceType | preferred | ServiceType `https://healthterminologies.gov.au/fhir/ValueSet/service-type-1` From https://tx.ontoserver.csiro.au/fhir

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:associatedHealthcareService |  | 0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
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 Core Responder |
SHALL:no-error | AU Core Requester |
class | SO Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
serviceType | SO Σ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
subject | SO Σ | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
participant | SO Σ | 0..* | BackboneElement | List of participants involved in the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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.
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
individual | SO Σ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
period | SO | 0..1 | Period | The start and end time of the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
reasonCode | SO Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
reasonReference | SO Σ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
location | SO | 0..* | BackboneElement | List of locations where the patient has been
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
serviceProvider | SO | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.class | extensible | ActEncounterCodeAUExtended `http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended`
Encounter.serviceType | preferred | ServiceType `https://healthterminologies.gov.au/fhir/ValueSet/service-type-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` From the FHIR Standard
Encounter.reasonCode | preferred | ReasonForEncounter `https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1` From https://tx.ontoserver.csiro.au/fhir

#### Constraints

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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 | ?!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 Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Patient) | The patient or group present at the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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.
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | SO Σ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
reasonReference | SO Σ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Organization) | The organization (facility) responsible for this encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Encounter.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.statusHistory.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.class | extensible | ActEncounterCodeAUExtended `http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended`
Encounter.classHistory.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.type | preferred | EncounterType `https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.serviceType | preferred | ServiceType `https://healthterminologies.gov.au/fhir/ValueSet/service-type-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.priority | example | ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` From the FHIR Standard
Encounter.reasonCode | preferred | ReasonForEncounter `https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.diagnosis.use | preferred | DiagnosisRole `http://hl7.org/fhir/ValueSet/diagnosis-role` From the FHIR Standard
Encounter.hospitalization.admitSource | preferred | AdmitSource `http://hl7.org/fhir/ValueSet/encounter-admit-source` From the FHIR Standard
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator `http://terminology.hl7.org/ValueSet/v2-0092`
Encounter.hospitalization.dietPreference | example | Diet `http://hl7.org/fhir/ValueSet/encounter-diet` From the FHIR Standard
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy `http://hl7.org/fhir/ValueSet/encounter-special-courtesy` From the FHIR Standard
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements `http://hl7.org/fhir/ValueSet/encounter-special-arrangements` From the FHIR Standard
Encounter.hospitalization.dischargeDisposition | extensible | SeparationMode (a valid code from `https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1`) `https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.location.status | required | EncounterLocationStatus `http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1` From the FHIR Standard
Encounter.location.physicalType | example | LocationType `http://hl7.org/fhir/ValueSet/location-physical-type` From the FHIR Standard

#### Constraints

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

This structure is derived from AUBaseEncounter

Summary

Mandatory: 1 element
Must-Support: 13 elements

Structures

This structure refers to these other structures:

- AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)
- AU Core Practitioner (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner)
- AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)
- AU Core RelatedPerson (http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson)
- AU Core Condition (http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition)
- AU Core Procedure (http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure)
- AU Core Location (http://hl7.org.au/fhir/core/StructureDefinition/au-core-location)
- AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)

Maturity: 2

Differential View

This structure is derived from AUBaseEncounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
status | SO | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
class | SO | 1..1 | Coding | Classification of patient encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
serviceType | SO | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
subject | SO | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
participant | SO | 0..* | BackboneElement | List of participants involved in the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
type | SO | 0..* | CodeableConcept | Role of participant in encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
individual | SO | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
period | SO | 0..1 | Period | The start and end time of the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
reasonCode | SO | 0..* | CodeableConcept | Coded reason the encounter takes place
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
reasonReference | SO | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
location | SO | 0..* | BackboneElement | List of locations where the patient has been
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
location | SO | 1..1 | Reference(AU Core Location) | Location the encounter takes place
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
serviceProvider | SO | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Encounter.serviceType | preferred | ServiceType `https://healthterminologies.gov.au/fhir/ValueSet/service-type-1` From https://tx.ontoserver.csiro.au/fhir

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:associatedHealthcareService |  | 0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
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 Core Responder |
SHALL:no-error | AU Core Requester |
class | SO Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
serviceType | SO Σ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
subject | SO Σ | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
participant | SO Σ | 0..* | BackboneElement | List of participants involved in the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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.
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
individual | SO Σ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
period | SO | 0..1 | Period | The start and end time of the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
reasonCode | SO Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
reasonReference | SO Σ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
location | SO | 0..* | BackboneElement | List of locations where the patient has been
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
serviceProvider | SO | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.class | extensible | ActEncounterCodeAUExtended `http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended`
Encounter.serviceType | preferred | ServiceType `https://healthterminologies.gov.au/fhir/ValueSet/service-type-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` From the FHIR Standard
Encounter.reasonCode | preferred | ReasonForEncounter `https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1` From https://tx.ontoserver.csiro.au/fhir

#### Constraints

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

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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 | ?!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 Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Patient) | The patient or group present at the encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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.
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | SO Σ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
reasonReference | SO Σ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Responder |
SHALL:no-error | AU Core Requester |
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 Core Organization) | The organization (facility) responsible for this encounter
Obligations | Actor
SHALL:populate-if-known | AU Core Responder |
SHALL:no-error | AU Core Requester |
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Encounter.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.statusHistory.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.class | extensible | ActEncounterCodeAUExtended `http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended`
Encounter.classHistory.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.type | preferred | EncounterType `https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.serviceType | preferred | ServiceType `https://healthterminologies.gov.au/fhir/ValueSet/service-type-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.priority | example | ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` From the FHIR Standard
Encounter.reasonCode | preferred | ReasonForEncounter `https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.diagnosis.use | preferred | DiagnosisRole `http://hl7.org/fhir/ValueSet/diagnosis-role` From the FHIR Standard
Encounter.hospitalization.admitSource | preferred | AdmitSource `http://hl7.org/fhir/ValueSet/encounter-admit-source` From the FHIR Standard
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator `http://terminology.hl7.org/ValueSet/v2-0092`
Encounter.hospitalization.dietPreference | example | Diet `http://hl7.org/fhir/ValueSet/encounter-diet` From the FHIR Standard
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy `http://hl7.org/fhir/ValueSet/encounter-special-courtesy` From the FHIR Standard
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements `http://hl7.org/fhir/ValueSet/encounter-special-arrangements` From the FHIR Standard
Encounter.hospitalization.dischargeDisposition | extensible | SeparationMode (a valid code from `https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1`) `https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1` From https://tx.ontoserver.csiro.au/fhir
Encounter.location.status | required | EncounterLocationStatus `http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1` From the FHIR Standard
Encounter.location.physicalType | example | LocationType `http://hl7.org/fhir/ValueSet/location-physical-type` From the FHIR Standard

#### Constraints

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

This structure is derived from AUBaseEncounter

Summary

Mandatory: 1 element
Must-Support: 13 elements

Structures

This structure refers to these other structures:

- AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)
- AU Core Practitioner (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner)
- AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)
- AU Core RelatedPerson (http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson)
- AU Core Condition (http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition)
- AU Core Procedure (http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure)
- AU Core Location (http://hl7.org.au/fhir/core/StructureDefinition/au-core-location)
- AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron

### Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination)
--- | --- | --- | ---
patient | SHALL | `reference` | The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
patient+date | SHALL | `reference`+`date` |
patient+class | SHOULD | `reference`+`token` |
patient+location | SHOULD | `reference`+`reference` |
patient+status | SHOULD | `reference`+`token` |
class | MAY | `token` | The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.
date | MAY | `date` | A requester SHALL provide a value precise to the second + time offset. A responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators `gt`, `lt`, `ge`, `le`. The responder SHALL support these search comparators `gt`, `lt`, `ge`, `le`. The requester SHOULD support `multipleAnd`, and if `multipleAnd` is supported, SHALL support the search comparators `gt`, `lt`, `ge`, `le`. The responder SHOULD support `multipleAnd`, and if `multipleAnd` is supported, SHALL support the search comparators `gt`, `lt`, `ge`, `le`.
location | MAY | `reference` | The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both.
status | MAY | `token` | The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support `multipleOr`.The responder SHALL support `multipleOr`.

#### Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching using the `patient` search parameter:
   - SHOULD support chained searching of patient canonical identifier `patient.identifier` (e.g. `patient.identifier=[system|][code]`)

   `GET [base]/Encounter?patient={Type/}[id]` or optionally `GET [base]/Encounter?patient.identifier=[system|][code]`

   Example:

   1. GET [base]/Encounter?patient=5678
   2. GET [base]/Encounter?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
   3. GET [base]/Encounter?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

   Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient (how to search by reference and how to search by token)

2. SHALL support searching using the combination of the `patient` and `date` search parameters:
   - SHOULD support chained searching of patient canonical identifier `patient.identifier` (e.g. `patient.identifier=[system|][code]`)
   - SHALL support these `date` comparators: `gt,lt,ge,le`
   - SHOULD support multipleAnd search on `date` (e.g.`date=[date]&date=[date]]&...`), and if multipleAnd is supported, SHALL support the search comparators `gt,lt,ge,le`

   `GET [base]/Encounter?patient={Type/}[id]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}`

   Example:

   1. GET [base]/Encounter?patient=5678&date=ge2020-01-01T00:00:00Z

   Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient and date (how to search by reference and how to search by date)

#### Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported:

1. SHOULD support searching using the combination of the `patient` and `class` search parameters:
   - SHOULD support chained searching of patient canonical identifier `patient.identifier` (e.g. `patient.identifier=[system|][code]`)

   `GET [base]/Encounter?patient={Type/}[id]&class={system|}[code]`

   Example:

   1. GET [base]/Encounter?patient=5678&class=http://terminology.hl7.org/CodeSystem/v3-ActCode|AMB

   Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient and class (how to search by reference and how to search by token)

2. SHOULD support searching using the combination of the `patient` and `location` search parameters:
   - SHOULD support chained searching of patient canonical identifier `patient.identifier` (e.g. `patient.identifier=[system|][code]`)

   `GET [base]/Encounter?patient={Type/}[id]&location={Type/}[id]`

   Example:

   1. GET [base]/Encounter?patient=5678&location=Location/vic-hospital

   Implementation Notes: Fetches a bundle of all Encounter resources matching the specified patient and location (how to search by reference)

3. SHOULD support searching using the combination of the `patient` and `status` search parameters:
   - SHOULD support chained searching of patient canonical identifier `patient.identifier` (e.g. `patient.identifier=[system|][code]`)
   - SHALL support multipleOr search on `status` (e.g.`status={system|}[code],{system|}[code],...`)

   `GET [base]/Encounter?patient={Type/}[id]&&status={system|}[code]{,{system|}[code],...}`

   Example:

   1. GET [base]/Encounter?patient=5678&status=finished

   Implementation Notes: Fetches a bundle of all Encounter resources matching the specified patient and status (how to search by reference) and how to search by token).