Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build

Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: EBookings Encounter

Official URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-encounter | Version: 1.2.60
Active as of 2026-04-05 | Computable Name: EBookingsEncounter

Genie EBookings Encounter profile

Usages:

- Refer to this Profile: EBookings Adverse Reaction, EBookings Infection Risk and EBookings ChargeItem
- Examples for this Profile: Encounter/1a1fafa9-c22c-4557-9670-4010f68f0745

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
id | S Σ | 0..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:encounterDescription |  | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
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 | ?!S Σ | 1..1 | code | planned Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: planned
class | S Σ | 1..1 | Coding | Inpatient => IMP (inpatient encounter) | Outpatient => AMB (ambulatory) | Day Surgery => SS (short stay) Binding: EBookings Encounter Class ValueSet (required)
subject | S Σ | 1..1 | Reference(EBookings Patient) | Patient the theatre booking is for
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
basedOn | S | 1..1 | Reference(EBookings ServiceRequest) | Service request this encounter is for
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
period | S | 1..1 | Period | The start and end time of the encounter
start | Σ C | 1..1 | dateTime | Admission date/time
end | Σ C | 0..1 | dateTime | Discharge date
length | S | 0..1 | Duration | Inpatient Days
value | Σ | 1..1 | decimal | Numerical value (with implicit precision)
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
system | Σ C | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org
code | Σ | 1..1 | code | Coded form of the unit Required Pattern: d
reasonCode | S Σ | 0..1 | CodeableConcept | Pre-op diagnosis Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
text | Σ | 1..1 | string | Plain text representation of the concept
location |  | 0..1 | BackboneElement | List of locations where the patient has been
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
location | S | 1..1 | Reference(Location) | Hospital location
display | Σ | 1..1 | string | Name of hospital
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 | required | EBookings Encounter Class ValueSet | 📦1.2.60 | This IG
Encounter.length.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦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 AUBaseEncounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
id | S | 0..1 | id | Logical id of this artifact
status | S | 1..1 | code | planned Required Pattern: planned
class | S | 1..1 | Coding | Inpatient => IMP (inpatient encounter) | Outpatient => AMB (ambulatory) | Day Surgery => SS (short stay) Binding: EBookings Encounter Class ValueSet (required)
subject | S | 1..1 | Reference(EBookings Patient) | Patient the theatre booking is for
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
basedOn | S | 1..1 | Reference(EBookings ServiceRequest) | Service request this encounter is for
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
period | S | 1..1 | Period | The start and end time of the encounter
start |  | 1..1 | dateTime | Admission date/time
end |  | 0..1 | dateTime | Discharge date
length | S | 0..1 | Duration | Inpatient Days
value |  | 1..1 | decimal | Numerical value (with implicit precision)
system |  | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org
code |  | 1..1 | code | Coded form of the unit Required Pattern: d
reasonCode | S | 0..1 | CodeableConcept | Pre-op diagnosis
coding |  | 0..0 |  | Code defined by a terminology system
text |  | 1..1 | string | Plain text representation of the concept
location |  | 0..1 | BackboneElement | List of locations where the patient has been
location | S | 1..1 | Reference(Location) | Hospital location
reference |  | 0..0 |  | Literal reference, Relative, internal or absolute URL
display |  | 1..1 | string | Name of hospital
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Encounter.class | Base | required | EBookings Encounter Class ValueSet | 📦1.2.60 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
id | S Σ | 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:encounterDescription |  | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
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 | ?!S Σ | 1..1 | code | planned Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: planned
statusHistory |  | 0..* | BackboneElement | List of past encounter statuses
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified status
class | S Σ | 1..1 | Coding | Inpatient => IMP (inpatient encounter) | Outpatient => AMB (ambulatory) | Day Surgery => SS (short stay) Binding: EBookings Encounter Class ValueSet (required)
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 (3.0.0) (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 | Σ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
subject | S Σ | 1..1 | Reference(EBookings Patient) | Patient the theatre booking is for
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
basedOn | S | 1..1 | Reference(EBookings ServiceRequest) | Service request this encounter is for
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
participant | Σ | 0..* | BackboneElement | List of participants involved in the 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
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period | S | 1..1 | Period | The start and end time of the encounter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | Σ C | 1..1 | dateTime | Admission date/time
end | Σ C | 0..1 | dateTime | Discharge date
length | S | 0..1 | Duration | Inpatient Days
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
value | Σ | 1..1 | decimal | Numerical value (with implicit precision)
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit | Σ | 0..1 | string | Unit representation
system | Σ C | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org
code | Σ | 1..1 | code | Coded form of the unit Required Pattern: d
reasonCode | S Σ | 0..1 | CodeableConcept | Pre-op diagnosis Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
text | Σ | 1..1 | string | Plain text representation of the concept
reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference)
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter
use |  | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank |  | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
account |  | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter
hospitalization |  | 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: Hl7VSReAdmissionIndicator (3.0.0) (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 |  | 0..1 | BackboneElement | List of locations where the patient has been
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 | S | 1..1 | Reference(Location) | Hospital location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Name of hospital
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 |  | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter
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 | required | EBookings Encounter Class ValueSet | 📦1.2.60 | This IG
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1
Encounter.type | Base | preferred | Encounter Type | ⏿1.0.1 | tx.hl7.org.au
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.hl7.org.au
Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1
Encounter.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Encounter.basedOn.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.length.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
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 | 📍3.0.0 | THO v7.1
Encounter.hospitalization.​dietPreference | Base | example | Diet | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​specialCourtesy | Base | preferred | Special courtesy | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​specialArrangement | Base | preferred | Special arrangements | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​dischargeDisposition | Base | extensible | Separation Mode | ⏿1.0.1 | tx.hl7.org.au
Encounter.location.location.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
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 AUBaseEncounter

Summary

Mandatory: 6 elements(5 nested mandatory elements)
Must-Support: 9 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

- EBookings Patient (http://fhir.geniesolutions.io/StructureDefinition/ebookings-patient)
- EBookings ServiceRequest (http://fhir.geniesolutions.io/StructureDefinition/ebookings-servicerequest)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
id | S Σ | 0..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:encounterDescription |  | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
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 | ?!S Σ | 1..1 | code | planned Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: planned
class | S Σ | 1..1 | Coding | Inpatient => IMP (inpatient encounter) | Outpatient => AMB (ambulatory) | Day Surgery => SS (short stay) Binding: EBookings Encounter Class ValueSet (required)
subject | S Σ | 1..1 | Reference(EBookings Patient) | Patient the theatre booking is for
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
basedOn | S | 1..1 | Reference(EBookings ServiceRequest) | Service request this encounter is for
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
period | S | 1..1 | Period | The start and end time of the encounter
start | Σ C | 1..1 | dateTime | Admission date/time
end | Σ C | 0..1 | dateTime | Discharge date
length | S | 0..1 | Duration | Inpatient Days
value | Σ | 1..1 | decimal | Numerical value (with implicit precision)
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
system | Σ C | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org
code | Σ | 1..1 | code | Coded form of the unit Required Pattern: d
reasonCode | S Σ | 0..1 | CodeableConcept | Pre-op diagnosis Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
text | Σ | 1..1 | string | Plain text representation of the concept
location |  | 0..1 | BackboneElement | List of locations where the patient has been
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
location | S | 1..1 | Reference(Location) | Hospital location
display | Σ | 1..1 | string | Name of hospital
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 | required | EBookings Encounter Class ValueSet | 📦1.2.60 | This IG
Encounter.length.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦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()`

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
id | S | 0..1 | id | Logical id of this artifact
status | S | 1..1 | code | planned Required Pattern: planned
class | S | 1..1 | Coding | Inpatient => IMP (inpatient encounter) | Outpatient => AMB (ambulatory) | Day Surgery => SS (short stay) Binding: EBookings Encounter Class ValueSet (required)
subject | S | 1..1 | Reference(EBookings Patient) | Patient the theatre booking is for
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
basedOn | S | 1..1 | Reference(EBookings ServiceRequest) | Service request this encounter is for
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
period | S | 1..1 | Period | The start and end time of the encounter
start |  | 1..1 | dateTime | Admission date/time
end |  | 0..1 | dateTime | Discharge date
length | S | 0..1 | Duration | Inpatient Days
value |  | 1..1 | decimal | Numerical value (with implicit precision)
system |  | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org
code |  | 1..1 | code | Coded form of the unit Required Pattern: d
reasonCode | S | 0..1 | CodeableConcept | Pre-op diagnosis
coding |  | 0..0 |  | Code defined by a terminology system
text |  | 1..1 | string | Plain text representation of the concept
location |  | 0..1 | BackboneElement | List of locations where the patient has been
location | S | 1..1 | Reference(Location) | Hospital location
reference |  | 0..0 |  | Literal reference, Relative, internal or absolute URL
display |  | 1..1 | string | Name of hospital
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Encounter.class | Base | required | EBookings Encounter Class ValueSet | 📦1.2.60 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context
id | S Σ | 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:encounterDescription |  | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
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 | ?!S Σ | 1..1 | code | planned Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: planned
statusHistory |  | 0..* | BackboneElement | List of past encounter statuses
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified status
class | S Σ | 1..1 | Coding | Inpatient => IMP (inpatient encounter) | Outpatient => AMB (ambulatory) | Day Surgery => SS (short stay) Binding: EBookings Encounter Class ValueSet (required)
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 (3.0.0) (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 | Σ | 0..1 | CodeableConcept | Specific type of service Binding: Service Type (preferred)
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
subject | S Σ | 1..1 | Reference(EBookings Patient) | Patient the theatre booking is for
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
basedOn | S | 1..1 | Reference(EBookings ServiceRequest) | Service request this encounter is for
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
participant | Σ | 0..* | BackboneElement | List of participants involved in the 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
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period | S | 1..1 | Period | The start and end time of the encounter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | Σ C | 1..1 | dateTime | Admission date/time
end | Σ C | 0..1 | dateTime | Discharge date
length | S | 0..1 | Duration | Inpatient Days
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
value | Σ | 1..1 | decimal | Numerical value (with implicit precision)
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit | Σ | 0..1 | string | Unit representation
system | Σ C | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org
code | Σ | 1..1 | code | Coded form of the unit Required Pattern: d
reasonCode | S Σ | 0..1 | CodeableConcept | Pre-op diagnosis Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
text | Σ | 1..1 | string | Plain text representation of the concept
reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference)
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter
use |  | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank |  | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
account |  | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter
hospitalization |  | 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: Hl7VSReAdmissionIndicator (3.0.0) (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 |  | 0..1 | BackboneElement | List of locations where the patient has been
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 | S | 1..1 | Reference(Location) | Hospital location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Name of hospital
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 |  | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter
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 | required | EBookings Encounter Class ValueSet | 📦1.2.60 | This IG
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1
Encounter.type | Base | preferred | Encounter Type | ⏿1.0.1 | tx.hl7.org.au
Encounter.serviceType | Base | preferred | Service Type | ⏿1.0.0 | tx.hl7.org.au
Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1
Encounter.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Encounter.basedOn.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.length.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
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 | 📍3.0.0 | THO v7.1
Encounter.hospitalization.​dietPreference | Base | example | Diet | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​specialCourtesy | Base | preferred | Special courtesy | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​specialArrangement | Base | preferred | Special arrangements | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​dischargeDisposition | Base | extensible | Separation Mode | ⏿1.0.1 | tx.hl7.org.au
Encounter.location.location.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
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 AUBaseEncounter

Summary

Mandatory: 6 elements(5 nested mandatory elements)
Must-Support: 9 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

- EBookings Patient (http://fhir.geniesolutions.io/StructureDefinition/ebookings-patient)
- EBookings ServiceRequest (http://fhir.geniesolutions.io/StructureDefinition/ebookings-servicerequest)

Other representations of profile: CSV, Excel, Schematron