My Health Record FHIR IG

My Health Record FHIR IG - Local Development build (v1.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON
• TTL

Resource Profile: MHR Encounter

The purpose of this profile is to provide a representation of an encounter for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

Usages:

• Refer to this Profile: MHR Advance Care Planning Document Composition, MHR Personal Health Notes Document Composition, MHR Condition, MHR Advance Care Planning Document DocumentReference... Show 2 more, MHR Australian Immunisation Register Notice and MHR Record of Immunisation from Australian Immunisation Register
• Examples for this Profile: Encounter/annual-01, Encounter/es-01, Encounter/es-02, Encounter/psml-02 and Encounter/psml-03

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
Slices for extension				Content/Rules for all slices
extension:associatedHealthcareService		0..*	Reference(HealthcareService)	Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Fixed Value: finished
class	SOΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible)
type	SΣ	0..*	CodeableConcept	Specific type of encounter Binding: Encounter Type (preferred)
serviceType	SOΣ	0..1	CodeableConcept	Specific type of service Binding: Service Type (preferred)
subject	SOΣ	1..1	Reference(AU Core Patient)	The patient or group present at the encounter
participant	SOΣ	1..*	BackboneElement	List of participants involved in the encounter
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.
individual	SOΣC	0..1	Reference(AU Core PractitionerRole | AU Core RelatedPerson)	Persons involved in the encounter other than the patient
period	SO	0..1	Period	The start and end time of the encounter
reasonCode	SOΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
reasonReference	SOΣ	0..*	Reference(MHR Condition | Observation | AU Core Procedure)	Reason the encounter takes place (reference)
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
dischargeDisposition	S	0..1	CodeableConcept	Separation Mode Binding: Separation Mode (extensible)
location	SO	0..*	BackboneElement	List of locations where the patient has been
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location	SO	1..1	Reference(AU Core Location)	Location the encounter takes place
serviceProvider	SOC	0..1	Reference(AU Core Organization)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.status	required	Fixed Value: finished http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.class	extensible	ActEncounterCodeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.type	preferred	EncounterType https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.serviceType	preferred	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.reasonCode	preferred	ReasonForEncounter https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.hospitalization.dischargeDisposition	extensible	SeparationMode (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1) https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 From https://tx.ontoserver.csiro.au/fhir

Constraints

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

This structure is derived from AUCoreEncounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	AUCoreEncounter	An encounter in an Australian healthcare context
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Fixed Value: finished
type	S	0..*	CodeableConcept	Specific type of encounter Binding: Encounter Type (preferred)
subject	S	1..1	Reference(AU Core Patient)	The patient or group present at the encounter
participant	S	1..*	BackboneElement	List of participants involved in the encounter
individual	SC	0..1	Reference(AU Core PractitionerRole | AU Core RelatedPerson)	Persons involved in the encounter other than the patient
reasonReference	S	0..*	Reference(MHR Condition | Observation | AU Core Procedure)	Reason the encounter takes place (reference)
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
dischargeDisposition	S	0..1	CodeableConcept	Separation Mode
location	S	0..*	BackboneElement	List of locations where the patient has been
location	S	1..1	Reference(AU Core Location)	Location the encounter takes place
serviceProvider	SC	0..1	Reference(AU Core Organization)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.type	preferred	EncounterType https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 From https://tx.ontoserver.csiro.au/fhir

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:associatedHealthcareService		0..*	Reference(HealthcareService)	Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!SOΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Fixed Value: finished
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)
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	SΣ	0..*	CodeableConcept	Specific type of encounter Binding: Encounter Type (preferred)
serviceType	SOΣ	0..1	CodeableConcept	Specific type of service Binding: Service Type (preferred)
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	SOΣ	1..1	Reference(AU Core Patient)	The patient or group present at the encounter
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Σ	1..*	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	SOΣ	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	SOΣC	0..1	Reference(AU Core PractitionerRole | AU Core RelatedPerson)	Persons involved in the encounter other than the patient
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period	SO	0..1	Period	The start and end time of the encounter
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)
reasonReference	SOΣ	0..*	Reference(MHR Condition | Observation | AU Core Procedure)	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: 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	S	0..1	CodeableConcept	Separation Mode Binding: Separation Mode (extensible)
location	SO	0..*	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	SO	1..1	Reference(AU Core Location)	Location the encounter takes place
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	SOC	0..1	Reference(AU Core 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	Conformance	ValueSet / Code	URI
Encounter.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Encounter.status	required	Fixed Value: finished http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.class	extensible	ActEncounterCodeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	preferred	EncounterType https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.serviceType	preferred	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.reasonCode	preferred	ReasonForEncounter https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard
Encounter.hospitalization.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source From the FHIR Standard
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet From the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy From the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements From the FHIR Standard
Encounter.hospitalization.dischargeDisposition	extensible	SeparationMode (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1) https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 From the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type From the FHIR Standard

Constraints

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

This structure is derived from AUCoreEncounter

Summary

Mandatory: 1 element
Must-Support: 9 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)
• AU Core RelatedPerson (http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson)
• MHR Condition (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-condition-mhr-1)
• AU Core Procedure (http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure)
• AU Core Location (http://hl7.org.au/fhir/core/StructureDefinition/au-core-location)
• AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)

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
Slices for extension				Content/Rules for all slices
extension:associatedHealthcareService		0..*	Reference(HealthcareService)	Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Fixed Value: finished
class	SOΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible)
type	SΣ	0..*	CodeableConcept	Specific type of encounter Binding: Encounter Type (preferred)
serviceType	SOΣ	0..1	CodeableConcept	Specific type of service Binding: Service Type (preferred)
subject	SOΣ	1..1	Reference(AU Core Patient)	The patient or group present at the encounter
participant	SOΣ	1..*	BackboneElement	List of participants involved in the encounter
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.
individual	SOΣC	0..1	Reference(AU Core PractitionerRole | AU Core RelatedPerson)	Persons involved in the encounter other than the patient
period	SO	0..1	Period	The start and end time of the encounter
reasonCode	SOΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: Reason For Encounter (preferred)
reasonReference	SOΣ	0..*	Reference(MHR Condition | Observation | AU Core Procedure)	Reason the encounter takes place (reference)
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
dischargeDisposition	S	0..1	CodeableConcept	Separation Mode Binding: Separation Mode (extensible)
location	SO	0..*	BackboneElement	List of locations where the patient has been
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location	SO	1..1	Reference(AU Core Location)	Location the encounter takes place
serviceProvider	SOC	0..1	Reference(AU Core Organization)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.status	required	Fixed Value: finished http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.class	extensible	ActEncounterCodeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.type	preferred	EncounterType https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.serviceType	preferred	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.reasonCode	preferred	ReasonForEncounter https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.hospitalization.dischargeDisposition	extensible	SeparationMode (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1) https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 From https://tx.ontoserver.csiro.au/fhir

Constraints

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

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		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Fixed Value: finished
type	S	0..*	CodeableConcept	Specific type of encounter Binding: Encounter Type (preferred)
subject	S	1..1	Reference(AU Core Patient)	The patient or group present at the encounter
participant	S	1..*	BackboneElement	List of participants involved in the encounter
individual	SC	0..1	Reference(AU Core PractitionerRole | AU Core RelatedPerson)	Persons involved in the encounter other than the patient
reasonReference	S	0..*	Reference(MHR Condition | Observation | AU Core Procedure)	Reason the encounter takes place (reference)
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
dischargeDisposition	S	0..1	CodeableConcept	Separation Mode
location	S	0..*	BackboneElement	List of locations where the patient has been
location	S	1..1	Reference(AU Core Location)	Location the encounter takes place
serviceProvider	SC	0..1	Reference(AU Core Organization)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.type	preferred	EncounterType https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 From https://tx.ontoserver.csiro.au/fhir

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:associatedHealthcareService		0..*	Reference(HealthcareService)	Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!SOΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Fixed Value: finished
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)
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	SΣ	0..*	CodeableConcept	Specific type of encounter Binding: Encounter Type (preferred)
serviceType	SOΣ	0..1	CodeableConcept	Specific type of service Binding: Service Type (preferred)
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	SOΣ	1..1	Reference(AU Core Patient)	The patient or group present at the encounter
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Σ	1..*	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	SOΣ	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	SOΣC	0..1	Reference(AU Core PractitionerRole | AU Core RelatedPerson)	Persons involved in the encounter other than the patient
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period	SO	0..1	Period	The start and end time of the encounter
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)
reasonReference	SOΣ	0..*	Reference(MHR Condition | Observation | AU Core Procedure)	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: 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	S	0..1	CodeableConcept	Separation Mode Binding: Separation Mode (extensible)
location	SO	0..*	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	SO	1..1	Reference(AU Core Location)	Location the encounter takes place
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	SOC	0..1	Reference(AU Core 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	Conformance	ValueSet / Code	URI
Encounter.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Encounter.status	required	Fixed Value: finished http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.class	extensible	ActEncounterCodeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	preferred	EncounterType https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.serviceType	preferred	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.reasonCode	preferred	ReasonForEncounter https://healthterminologies.gov.au/fhir/ValueSet/reason-for-encounter-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard
Encounter.hospitalization.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source From the FHIR Standard
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet From the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy From the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements From the FHIR Standard
Encounter.hospitalization.dischargeDisposition	extensible	SeparationMode (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1) https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 From https://tx.ontoserver.csiro.au/fhir
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 From the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type From the FHIR Standard

Constraints

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

This structure is derived from AUCoreEncounter

Summary

Mandatory: 1 element
Must-Support: 9 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)
• AU Core RelatedPerson (http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson)
• MHR Condition (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-condition-mhr-1)
• AU Core Procedure (http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure)
• AU Core Location (http://hl7.org.au/fhir/core/StructureDefinition/au-core-location)
• AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)

Other representations of profile: CSV, Excel, Schematron