AU Core Implementation Guide
0.2.2-preview - Preview
AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter | Version: 0.2.2-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreEncounter | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for an Encounter resource to record, search, and fetch basic encounter information for a patient. It is based on the AU Base Encounter profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Encounter when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
A resource conforming to this profile:
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.
Encounter.code.text and/or Encounter.code.coding.display so that client applications can at least display the condition even if the client application does not recognise the code supplied.Encounter.reasonCode, or a reference with Encounter.reasonReference to a Condition or other resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseEncounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Encounter | 0..* | AUBaseEncounter | An encounter in an Australian healthcare context | |
  extension:encounterDescription | S | 0..1 | EncounterDescription | Description, overview or summary of an encounter |
 identifier | S | 0..* | Identifier | Identifier(s) by which this encounter is known |
| status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| class | S | 1..1 | Coding | Classification of patient encounter |
| type | S | 0..* | CodeableConcept | Specific type of encounter Binding: https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 (preferred) |
| serviceType | S | 0..1 | CodeableConcept | Specific type of service Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred) |
 subject | S | 1..1 | Reference(AU Core Patient) | The patient or group present at the encounter |
 participant | S | 0..* | BackboneElement | List of participants involved in the encounter |
 type | S | 0..* | CodeableConcept | Role of participant in encounter |
 individual | S | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Persons involved in the encounter other than the patient |
| period | S | 1..1 | Period | The start and end time of the encounter |
| reasonCode | S | 0..* | CodeableConcept | Coded reason the encounter takes place |
| reasonReference[x] | S | 0..* | Reference(AU Core Condition | AU Core Observation | AU Core Procedure) | Reason the encounter takes place (reference) |
| hospitalization | S | 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 | S | 0..1 | Reference(AU Core Organization) | The organization (facility) responsible for this encounter |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1 |
| Encounter.serviceType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described 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.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| patient | SHALL | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
| patient+date | SHALL | reference+date |
|
| patient+class | SHOULD | reference+token |
|
| patient+discharge-disposition | SHOULD | reference+token |
|
| patient.identifier | SHOULD | reference.token |
The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
| patient+location | SHOULD | reference+reference |
|
| patient+status | SHOULD | reference+token |
|
| patient+type | SHOULD | reference+token |
|
| class | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| date | MAY | date |
A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
| discharge-disposition | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| identifier | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| location | MAY | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
| status | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| type | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
The following search parameters and search parameter combinations SHALL be supported:
patient search parameter:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Encounter?patient={Type/}[id] or optionally GET [base]/Encounter?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient (how to search by reference and how to search by token)
patient and date search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])date comparators: gt,lt,ge,ledate (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:
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)
The following search parameters and search parameter combinations SHOULD be supported:
patient and class search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Encounter?patient={Type/}[id]&class={system|}[code]
Example:
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)
patient and discharge-disposition search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Encounter?patient={Type/}[id]&discharge-disposition={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources for the specified patient and discharge disposition (how to search by reference and how to search by token)
patient and location search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Encounter?patient={Type/}[id]&location={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Encounter resources matching the specified patient and location (how to search by reference)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.2-preview based on FHIR 4.0.1. Generated 2023-11-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change