AU eRequesting Implementation Guide
1.0.0-preview - Preview

AU eRequesting Implementation Guide - Downloaded Version 1.0.0-preview See the Directory of published versions

## Resource Profile: AU eRequesting Encounter

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-encounter | Version: 1.0.0-preview
Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingEncounter
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for an Encounter resource that is used to record, search, and fetch basic encounter information for a patient. It is based on the AU Core Encounter profile and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the Encounter resource when conforming to this profile.

### Profile Specific Implementation Guidance

- See the general guidance on implementing the Encounter resource in AU Core.

Obligations for AU Core actors (AU Core Requester and AU Core Responder) inherited from AU Core Encounter currently render in the profile view. This is a tooling limitation, and only the AU eRequesting actor obligations should be applied. See Zulip discussion for more information.

Usages:

- Refer to this Profile: AU eRequesting Diagnostic Request
- Examples for this Profile: Encounter/gp-consult-finger-pain, Encounter/gp-consultation and Encounter/obsgynaeclinic
- CapabilityStatements using this Profile: AU eRequesting Filler CapabilityStatement, AU eRequesting Patient CapabilityStatement, AU eRequesting Placer CapabilityStatement and AU eRequesting Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

Changes since version 1.0.0-ballot:

- New Content

### 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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
class | SO Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
serviceType | SO Σ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
subject | SO Σ | 1..1 | Reference(AU eRequesting Patient) | The patient or group present at the encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
participant | SO Σ | 0..* | BackboneElement | List of participants involved in the encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
individual | SO Σ | 0..1 | Reference(AU eRequesting Practitioner | AU eRequesting PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
period | SO | 0..1 | Period | The start and end time of the encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonCode | SO Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonReference | SO Σ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
location | SO | 0..* | BackboneElement | List of locations where the patient has been
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
serviceProvider | SO | 0..1 | Reference(AU eRequesting Organization) | The organization (facility) responsible for this encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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.0-preview | AU Base Implementation Guide v6.0
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.ontoserver.csiro.au
Encounter.participant.​type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Reason For Encounter | ⏿1.0.0 | tx.ontoserver.csiro.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 | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
class | O | 1..1 | Coding | Classification of patient encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
serviceType | O | 0..1 | CodeableConcept | Specific type of service
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
subject | O | 1..1 | Reference(AU eRequesting Patient) | The patient or group present at the encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
participant | O | 0..* | BackboneElement | List of participants involved in the encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
type | O | 0..* | CodeableConcept | Role of participant in encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
individual | O | 0..1 | Reference(AU eRequesting Practitioner | AU eRequesting PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
period | O | 0..1 | Period | The start and end time of the encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonCode | O | 0..* | CodeableConcept | Coded reason the encounter takes place
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonReference | O | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
location | O | 0..* | BackboneElement | List of locations where the patient has been
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
location | O | 1..1 | Reference(AU Core Location) | Location the encounter takes place
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
serviceProvider | O | 0..1 | Reference(AU eRequesting Organization) | The organization (facility) responsible for this encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 eRequesting Patient) | The patient or group present at the encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | SO Σ | 0..1 | Reference(AU eRequesting Practitioner | AU eRequesting PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonReference | SO Σ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 eRequesting Organization) | The organization (facility) responsible for this encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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.0-preview | AU Base Implementation Guide v6.0
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0
Encounter.type | Base | preferred | Encounter Type | ⏿1.0.1 | tx.ontoserver.csiro.au
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.ontoserver.csiro.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.ontoserver.csiro.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.ontoserver.csiro.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:

- AU eRequesting Patient (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-patient)
- AU eRequesting Practitioner (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitioner)
- AU eRequesting PractitionerRole (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitionerrole)
- AU Core RelatedPerson (http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson)
- AU eRequesting Organization (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-organization)

Maturity: 0

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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
class | SO Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
serviceType | SO Σ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
subject | SO Σ | 1..1 | Reference(AU eRequesting Patient) | The patient or group present at the encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
participant | SO Σ | 0..* | BackboneElement | List of participants involved in the encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
individual | SO Σ | 0..1 | Reference(AU eRequesting Practitioner | AU eRequesting PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
period | SO | 0..1 | Period | The start and end time of the encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonCode | SO Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonReference | SO Σ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
location | SO | 0..* | BackboneElement | List of locations where the patient has been
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
serviceProvider | SO | 0..1 | Reference(AU eRequesting Organization) | The organization (facility) responsible for this encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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.0-preview | AU Base Implementation Guide v6.0
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.ontoserver.csiro.au
Encounter.participant.​type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Reason For Encounter | ⏿1.0.0 | tx.ontoserver.csiro.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 | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
class | O | 1..1 | Coding | Classification of patient encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
serviceType | O | 0..1 | CodeableConcept | Specific type of service
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
subject | O | 1..1 | Reference(AU eRequesting Patient) | The patient or group present at the encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
participant | O | 0..* | BackboneElement | List of participants involved in the encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
type | O | 0..* | CodeableConcept | Role of participant in encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
individual | O | 0..1 | Reference(AU eRequesting Practitioner | AU eRequesting PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
period | O | 0..1 | Period | The start and end time of the encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonCode | O | 0..* | CodeableConcept | Coded reason the encounter takes place
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonReference | O | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
location | O | 0..* | BackboneElement | List of locations where the patient has been
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
location | O | 1..1 | Reference(AU Core Location) | Location the encounter takes place
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
serviceProvider | O | 0..1 | Reference(AU eRequesting Organization) | The organization (facility) responsible for this encounter
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 eRequesting Patient) | The patient or group present at the encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | SO Σ | 0..1 | Reference(AU eRequesting Practitioner | AU eRequesting PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
reasonReference | SO Σ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure) | Reason the encounter takes place (reference)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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 eRequesting Organization) | The organization (facility) responsible for this encounter
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core Encounter
SHALL:no-error | AU Core Requester | from AU Core Encounter
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core Encounter
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core Encounter
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
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.0-preview | AU Base Implementation Guide v6.0
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0
Encounter.type | Base | preferred | Encounter Type | ⏿1.0.1 | tx.ontoserver.csiro.au
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.ontoserver.csiro.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.ontoserver.csiro.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.ontoserver.csiro.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:

- AU eRequesting Patient (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-patient)
- AU eRequesting Practitioner (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitioner)
- AU eRequesting PractitionerRole (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitionerrole)
- AU Core RelatedPerson (http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson)
- AU eRequesting Organization (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-organization)

Maturity: 0

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 eRequesting 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 eRequesting interactions is defined here.

Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT".

Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination)
--- | --- | --- | --- | --- | --- | ---
_id | SHALL | MAY | MAY | MAY | `token` |

#### Search Parameters:

The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.

1. `_id` search parameter

   `GET [base]/Encounter?_id=[id]`

   Example:

   1. GET [base]/Encounter?_id=987654

Implementation Notes: Fetches a bundle with the requested Encounter, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)