Usage scenarios

The following are supported usage scenarios for this profile:

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

Comparison with other national and international IGs

A resource conforming to this profile:

• MAY be conformant to US Core Encounter if Encounter.type is supplied

No equivalent International Patient Access or International Patient Summary profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

• The use of coding can vary significantly across systems, requesters need to understand that they may encounter codes they do not recognise and be prepared to handle those resources appropriately. Responders SHOULD populate Encounter.code.text and/or Encounter.code.coding.display so that requesters can at least display the condition even if the requester does not recognise the code supplied.
• The Encounter resource can represent a reason as a code with Encounter.reasonCode, or a reference with Encounter.reasonReference to a Condition or other resource.
  • Although both are marked as Must Support, responders are not required to support both a code and a reference, but they SHALL support at least one of these elements
  • A requester SHALL support both elements

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

This structure is derived from AUBaseEncounter

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

Terminology Bindings (Differential)

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

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	AUBaseEncounter	An encounter in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
encounterDescription		0..1	string	Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
associatedHealthcareService		0..*	Reference(HealthcareService)	Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
class	SOΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
serviceType	SOΣ	0..1	CodeableConcept	Specific type of service Binding: Service Type (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
subject	SOΣ	1..1	Reference(AU Core Patient)	The patient or group present at the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
participant	SOΣ	0..*	BackboneElement	List of participants involved in the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SOΣ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
individual	SOΣ	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Base Related Person)	Persons involved in the encounter other than the patient Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
period	SO	0..1	Period	The start and end time of the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
reasonCode	SOΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
reasonReference	SΣ	0..*	Reference(AU Core Condition | Observation | AU Core Procedure)	Reason the encounter takes place (reference)
location	SO	0..*	BackboneElement	List of locations where the patient has been Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location	SO	1..1	Reference(AU Core Location)	Location the encounter takes place Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
serviceProvider	SO	0..1	Reference(AU Core Organization)	The organization (facility) responsible for this encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCodeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.serviceType	preferred	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason 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()

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	AUBaseEncounter	An encounter in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
encounterDescription		0..1	string	Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
associatedHealthcareService		0..*	Reference(HealthcareService)	Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!SOΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
statusHistory		0..*	BackboneElement	List of past encounter statuses
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period		1..1	Period	The time that the episode was in the specified status
class	SOΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
classHistory		0..*	BackboneElement	List of past encounter classes
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: Encounter Type (preferred)
serviceType	SOΣ	0..1	CodeableConcept	Specific type of service Binding: Service Type (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	SOΣ	1..1	Reference(AU Core Patient)	The patient or group present at the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
episodeOfCare	Σ	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
basedOn		0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter
participant	SOΣ	0..*	BackboneElement	List of participants involved in the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SOΣ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
period		0..1	Period	Period of time during the encounter that the participant participated
individual	SOΣ	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Base Related Person)	Persons involved in the encounter other than the patient Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period	SO	0..1	Period	The start and end time of the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
reasonCode	SOΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
reasonReference	SΣ	0..*	Reference(AU Core 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		0..1	CodeableConcept	Separation Mode Binding: Separation Mode (extensible)
location	SO	0..*	BackboneElement	List of locations where the patient has been Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location	SO	1..1	Reference(AU Core Location)	Location the encounter takes place Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period		0..1	Period	Time period during which the patient was present at the location
serviceProvider	SO	0..1	Reference(AU Core Organization)	The organization (facility) responsible for this encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
partOf		0..1	Reference(Encounter)	Another Encounter this encounter is part of
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCodeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	preferred	EncounterType https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 from https://tx.ontoserver.csiro.au/fhir
Encounter.serviceType	preferred	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
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()

Differential View

This structure is derived from AUBaseEncounter

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

Terminology Bindings (Differential)

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	AUBaseEncounter	An encounter in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
encounterDescription		0..1	string	Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
associatedHealthcareService		0..*	Reference(HealthcareService)	Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
class	SOΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
serviceType	SOΣ	0..1	CodeableConcept	Specific type of service Binding: Service Type (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
subject	SOΣ	1..1	Reference(AU Core Patient)	The patient or group present at the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
participant	SOΣ	0..*	BackboneElement	List of participants involved in the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SOΣ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
individual	SOΣ	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Base Related Person)	Persons involved in the encounter other than the patient Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
period	SO	0..1	Period	The start and end time of the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
reasonCode	SOΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
reasonReference	SΣ	0..*	Reference(AU Core Condition | Observation | AU Core Procedure)	Reason the encounter takes place (reference)
location	SO	0..*	BackboneElement	List of locations where the patient has been Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location	SO	1..1	Reference(AU Core Location)	Location the encounter takes place Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
serviceProvider	SO	0..1	Reference(AU Core Organization)	The organization (facility) responsible for this encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCodeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
Encounter.serviceType	preferred	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason 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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	AUBaseEncounter	An encounter in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
encounterDescription		0..1	string	Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
associatedHealthcareService		0..*	Reference(HealthcareService)	Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!SOΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
statusHistory		0..*	BackboneElement	List of past encounter statuses
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period		1..1	Period	The time that the episode was in the specified status
class	SOΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode - AU Extended (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
classHistory		0..*	BackboneElement	List of past encounter classes
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: Encounter Type (preferred)
serviceType	SOΣ	0..1	CodeableConcept	Specific type of service Binding: Service Type (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	SOΣ	1..1	Reference(AU Core Patient)	The patient or group present at the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
episodeOfCare	Σ	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
basedOn		0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter
participant	SOΣ	0..*	BackboneElement	List of participants involved in the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SOΣ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
period		0..1	Period	Period of time during the encounter that the participant participated
individual	SOΣ	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Base Related Person)	Persons involved in the encounter other than the patient Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period	SO	0..1	Period	The start and end time of the encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
reasonCode	SOΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
reasonReference	SΣ	0..*	Reference(AU Core 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		0..1	CodeableConcept	Separation Mode Binding: Separation Mode (extensible)
location	SO	0..*	BackboneElement	List of locations where the patient has been Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location	SO	1..1	Reference(AU Core Location)	Location the encounter takes place Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period		0..1	Period	Time period during which the patient was present at the location
serviceProvider	SO	0..1	Reference(AU Core Organization)	The organization (facility) responsible for this encounter Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
partOf		0..1	Reference(Encounter)	Another Encounter this encounter is part of
Documentation for this format

Terminology Bindings

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

Constraints

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

This structure is derived from AUBaseEncounter

Summary

Mandatory: 1 element
Must-Support: 13 elements

Structures

This structure refers to these other structures:

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

Maturity: 1

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

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

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

Mandatory Search Parameters:

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

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

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

   Example:

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

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

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

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

   Example:

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

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

Optional Search Parameters:

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

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

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

   Example:

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

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

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

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

   Example:

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

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

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

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

   Example:

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

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