This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions
AU Base Encounter Profile [FMM Level 1]
This profile defines an encounter structure including core localisation concepts for use in an Australian context. This profile is intended to be applicable for recording details of ambulatory as well as non-ambulatory patient encounters in an Australian healthcare context.
Extensions used in this profile:
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-encounter
This profile defines an encounter structure including core localisation concepts for use in an Australian context.
This profile builds on Encounter.
This profile was published on Mon Mar 18 10:07:00 AEDT 2019 as a draft by Health Level Seven Australia (Patient Administration WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | I | 0..* | Encounter | 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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounter-description | I | 0..1 | string | Encounter description URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description |
associated-healthcareservice | I | 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 | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) |
statusHistory | I | 0..* | BackboneElement | List of past encounter statuses |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) | |
period | 1..1 | Period | The time that the episode was in the specified status | |
class | Σ | 0..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible) |
classHistory | I | 0..* | BackboneElement | List of past encounter classes |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible) | |
period | 1..1 | Period | The time that the episode was in the specified class | |
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example) |
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example) | |
subject | Σ | 0..1 | Reference(Patient | Group) | The patient ro group present at the encounter |
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
incomingReferral | 0..* | Reference(ReferralRequest) | The ReferralRequest that initiated this encounter | |
participant | ΣI | 0..* | BackboneElement | List of participants involved in the encounter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible) |
period | 0..1 | Period | Period of time during the encounter that the participant participated | |
individual | Σ | 0..1 | Reference(Practitioner | RelatedPerson) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..1 | Reference(Appointment) | The appointment that scheduled this encounter |
period | 0..1 | Period | The start and end time of the encounter | |
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
reason | Σ | 0..* | CodeableConcept | Reason the encounter takes place (code) Binding: Encounter Reason Codes (preferred) |
diagnosis | ΣI | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
condition | 1..1 | Reference(Condition | Procedure) | Reason the encounter takes place (resource) | |
role | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) | |
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 | I | 0..1 | BackboneElement | Details about the admission to a healthcare service |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounter-origin-organisation | I | 0..1 | Reference(Organization) | The organisation from which the patient came before admission URL: http://hl7.org.au/fhir/StructureDefinition/encounter-origin-organisation |
encounter-destination-organisation | I | 0..1 | Reference(Organization) | Organisation to which the patient is discharged URL: http://hl7.org.au/fhir/StructureDefinition/encounter-destination-organisation |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |
origin | 0..1 | Reference(Location) | The location from which the patient came before admission | |
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred) | |
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: v2 Re-Admission Indicator (example) | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example) | |
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred) | |
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred) | |
destination | 0..1 | Reference(Location) | Location to which the patient is discharged | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 (preferred) | |
location | I | 0..* | BackboneElement | List of locations where the patient has been |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
location | 1..1 | Reference(Location) | Location the encounter takes place | |
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required) | |
period | 0..1 | Period | Time period during which the patient was present at the location | |
serviceProvider | 0..1 | Reference(Organization) | The custodian organization of this Encounter record | |
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | I | 0..* | Encounter | 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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounter-description | I | 0..1 | string | Encounter description URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description |
associated-healthcareservice | I | 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 | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) |
statusHistory | I | 0..* | BackboneElement | List of past encounter statuses |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) | |
period | 1..1 | Period | The time that the episode was in the specified status | |
class | Σ | 0..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible) |
classHistory | I | 0..* | BackboneElement | List of past encounter classes |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible) | |
period | 1..1 | Period | The time that the episode was in the specified class | |
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example) |
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example) | |
subject | Σ | 0..1 | Reference(Patient | Group) | The patient ro group present at the encounter |
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
incomingReferral | 0..* | Reference(ReferralRequest) | The ReferralRequest that initiated this encounter | |
participant | ΣI | 0..* | BackboneElement | List of participants involved in the encounter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible) |
period | 0..1 | Period | Period of time during the encounter that the participant participated | |
individual | Σ | 0..1 | Reference(Practitioner | RelatedPerson) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..1 | Reference(Appointment) | The appointment that scheduled this encounter |
period | 0..1 | Period | The start and end time of the encounter | |
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
reason | Σ | 0..* | CodeableConcept | Reason the encounter takes place (code) Binding: Encounter Reason Codes (preferred) |
diagnosis | ΣI | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
condition | 1..1 | Reference(Condition | Procedure) | Reason the encounter takes place (resource) | |
role | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) | |
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 | I | 0..1 | BackboneElement | Details about the admission to a healthcare service |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
encounter-origin-organisation | I | 0..1 | Reference(Organization) | The organisation from which the patient came before admission URL: http://hl7.org.au/fhir/StructureDefinition/encounter-origin-organisation |
encounter-destination-organisation | I | 0..1 | Reference(Organization) | Organisation to which the patient is discharged URL: http://hl7.org.au/fhir/StructureDefinition/encounter-destination-organisation |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |
origin | 0..1 | Reference(Location) | The location from which the patient came before admission | |
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred) | |
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: v2 Re-Admission Indicator (example) | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example) | |
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred) | |
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred) | |
destination | 0..1 | Reference(Location) | Location to which the patient is discharged | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 (preferred) | |
location | I | 0..* | BackboneElement | List of locations where the patient has been |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
location | 1..1 | Reference(Location) | Location the encounter takes place | |
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required) | |
period | 0..1 | Period | Time period during which the patient was present at the location | |
serviceProvider | 0..1 | Reference(Organization) | The custodian organization of this Encounter record | |
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-encounter
none defined