AU Core Implementation Guide
1.0.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Requirements: Actor Definitions

The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.

AU Core Requester

The AU Core Requester is a system that creates and initiates a data access request to retrieve core digital health and administrative information.

AU Core Responder

The AU Core Responder is a system responsible for providing responses to queries submitted by AU Core Requesters.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

AU Core Requester CapabilityStatement

This CapabilityStatement describes the basic rules for the AU Core Requester actor that is responsible for creating and initiating the queries for information. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU Core Requesters are defined in this CapabilityStatement.

AU Core Responder CapabilityStatement

This CapabilityStatement describes the basic rules for the AU Core Responder actor that is responsible for providing responses to queries submitted by AU Core Requesters. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU Core Responders are defined in this CapabilityStatement.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

AUCoreClinicalPatient

A clinical patient SHOULD support patient.identifier. This AU Core SearchParameter extends the usage context of the clinical-patient parameter

  • multipleAnd
  • multipleOr
  • chain
AUCorePractitionerRolePractitioner

A practitioner role practitioner SHOULD support practitioner.identifier. NOTE: This AU Core SearchParameter extends the usage context of the PractitionerRole-practitioner parameter

  • multipleAnd
  • multipleOr
  • chain

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

AU Core AllergyIntolerance

This profile sets minimum expectations for an AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient. It is based on the AU Base Allergy Intolerance profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the AllergyIntolerance resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Blood Pressure

This profile sets minimum expectations for an Observation resource to record, search, and fetch blood pressure observations with standard coding and units of measure. It is based on the FHIR Blood Pressure Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Body Height

This profile sets minimum expectations for an Observation resource to record, search, and fetch body height observations with standard coding and units of measure. It is based on the FHIR Body Height Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Body Temperature

This profile sets minimum expectations for an Observation resource to record, search, and fetch body temperature observations with standard coding and units of measure. It is based on the FHIR Body Temperature Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Body Weight

This profile sets minimum expectations for an Observation resource to record, search, and fetch body weight observations with standard coding and units of measure. It is based on the FHIR Body Weight Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Condition

This profile sets minimum expectations for a Condition resource to record, search, and fetch problems, diagnoses, and health concerns associated with a patient. It is based on the AU Base Condition profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Condition resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Diagnostic Result Observation

This profile sets minimum expectations for an Observation resource to record, search, and fetch diagnostic results associated with a patient. It is based on the AU Base Diagnostic Result profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Encounter

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.

AU Core Heart Rate

This profile sets minimum expectations for an Observation resource to record, search, and fetch heart rate observations with standard coding and units of measure. It is based on the FHIR Heart Rate Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Immunization

This profile sets minimum expectations for an Immunization resource to record, search, and fetch immunisation history associated with a patient. It is based on the AU Base Immunisation profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Immunization resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Location

This profile sets minimum expectations for a Location resource to record, search, and fetch information about a location. It is based on the AU Base Location profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Location when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Medication

This profile sets minimum expectations for a Medication resource to record, search, and fetch medications associated with a patient. It is based on the AU Base Medication profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Medication when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

In AU Core a Medication resource is used within the context of a referencing resource: MedicationAdministration, MedicationDispense, MedicationRequest, or MedicationStatement resource.

AU Core MedicationRequest

This profile sets minimum expectations for a MedicationRequest resource to record, search, and fetch medication orders and requests (i.e. prescriptions) associated with a patient. It is based on the AU Base Medication Request profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the MedicationRequest when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Organization

This profile sets minimum expectations for a Organization resource to record, search, and fetch information about an organisation. It is based on the AU Base Organization profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Organization when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Pathology Result Observation

This profile sets minimum expectations for an Observation resource to record, search, and fetch pathology results associated with a patient. It is based on the AU Base Pathology Result profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Patient

This profile sets minimum expectations for a Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It is based on the AU Base Patient profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Patient when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Practitioner

This profile sets minimum expectations for a Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner. It is based on the AU Base Practitioner profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Practitioner when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core PractitionerRole

This profile sets minimum expectations for a PractitionerRole resource to record, search, and fetch a practitioner role for a practitioner associated with a patient. It is based on the AU Base Practitioner Role profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the PractitionerRole resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Procedure

This profile sets minimum expectations for a Procedure resource to record, search, and fetch procedures associated with a patient. It is based on the AU Base Procedure profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Procedure resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Respiration Rate

This profile sets minimum expectations for an Observation resource to record, search, and fetch respiration rate observations with standard coding and units of measure. It is based on the FHIR Respiratory Rate Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Smoking Status

This profile sets minimum expectations for an Observation resource to record, search, and fetch observations that represent a patient’s smoking status, i.e. current behaviour for all types of tobacco smoking, with standard coding. It is based on the core FHIR Observation resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

AU Core Waist Circumference

This profile sets minimum expectations for an Observation resource to record, search, and fetch waist circumference observations with standard coding and units of measure. It is based on the FHIR Vital Signs Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

AU Core Sex Assigned At Birth

This profile defines the minimum expectations for a Person Recorded Sex or Gender extension when representing Sex Assigned at Birth. This profile identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Extension when conforming to this profile.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

AllergyIntolerance - Lactose intolerance

Shows an example of Lactose intolerance for the AU Core AllergyIntolerance profile. Patient: Mia Leanne Banks.

AllergyIntolerance - No known allergy

Shows an example of allergyintolerance for the AU Core AllergyIntolerance indicating the patient has no known allergies. Patient: Mr. Li Wang.

AllergyIntolerance - Penicillin allergy

Shows an example of Penicillin allergy for the AU Core AllergyIntolerance profile. Patient: Deangelo HOWE.

Condition - Chronic Kidney Disease

Shows an example of an active Chronic Kidney Disease with onset age for the AU Core Condition profile. Patient: Ronny Lawrence Irvine.

Condition - Data suppressed for category and code

Shows an example of a Condition with suppressed data (category and code) where the data requester has access rights to know that data is suppressed for the AU Core Condition profile. Patient: Anne Bennelong.

Condition - No known condition

Shows an example of no known conditions for the AU Core Condition profile. Patient: Deangelo HOWE.

Condition - Urinary tract infection

Shows an example of a resolved Urinary tract infection with onset and abatement age for the AU Core Condition profile. Patient: Mia Leanne Banks.

Encounter - COVID 19 Vaccine Administration Dose 1

Shows an example of COVID19 vaccine administration encouter for the AU Core Encounter profile. Patient: Mrs. Anne Bennelong.

Encounter - Discharge

Shows an example of an emergency department encounter for the AU Core Encounter profile. Patient: Ronny Lawrence Irvine.

Encounter - telehealth

Shows and example of a telehealth encounter for the AU Core Encounter profile. Patient: Mrs. Anne Bennelong.

Immunization - Administration of Zoster vaccination refused

Shows an example of not-administered vaccination due to patient's refusal for the AU Core Immunization profile. Patient: Deangelo HOWE.

Immunization - COVID Dose 1

Shows an example of administered COVID 19 vaccine for the AU Core Immunization profile. Patient: Mrs. Anne Bennelong.

Location - Murrabit Public Hospital

Shows an example of the Murrabit Public Hospital location for the AU Core Location profile.

Location - Patient home

Shows an example of patient's home location example for the AU Core Location profile.

Location - Tindal Building

Shows an example of Tindal Building location for the AU Core Location profile.

Medication - Branded pack with one active ingredient

Shows an example of a branded pack with one active ingredient for the AU Core Medication profile.

Medication - Product with two active ingredients

Shows an example of a Product with two active ingredients mediction for the AU Core Medication profile.

Medication - Simvastatin 40 MG Disintegrating Oral Tablet

Shows an example of Simvastatin 40 MG Disintegrating Oral Tablet for the AU Core Medication profile.

MedicationRequest - active prescription, Reaptan

Shows an example of an order for Reaptan for pain management for the AU Core MedicationRequest profile example that demonstrates representing medication as a contained Medication resource. Patient: Mr. Li Wang.

MedicationRequest - active prescription, Simvastatin

Shows an example of an order for Simvastatin for high cholesterol for the AU Core MedicationRequest profile that demonstrates representing medication as a reference to Medication resource. Patient: Mr. Li Wang.

MedicationRequest - prescription, paracetamol 500 mg + codeine phosphate hemihydrate 30 mg (missing data for status and requester)

Shows an example of an order for paracetamol 500 mg + codeine phosphate hemihydrate 30 mg tablet for pain management for the AU Core MedicationRequest profile illustrating missing data for status and requester. Patient: Mrs. Anne Bennelong.

Observation - Blood Pressure (data absent for diastolic)

Shows an example of a blood pressure observation with systolic measurement and unknown dystolic measurement for the AU Core Blood Pressure profile. Patient: Ronny Lawrence Irvine.

Observation - Blood Pressure (systolic and dystolic)

Shows an example of a blood pressure with both systolic and diastolic measurements for the AU Core Blood Pressure profile. Patient: Mr. Li Wang.

Observation - Body weight

Shows an example of a body weight observation for the AU Core Body Weight profile. Patient: Mia Leanne Banks.

Observation - COVID Pathology Result (Not detected)

Shows an example of a COVID-19 PCR test result indicating 'Not detected' with notes on test accreditation and evaluation status for the AU Core Diagnostic Result - Pathology profile. Patient: Li Wang.

Observation - Current smoker

Shows an example of an observation of smoking status of current smoker for the AU Core Smoking Status profile. Patient: Mr. Li Wang.

Observation - Data suppressed for category, code, effective[x] and value[x]

Shows an example of an observation with suppressed data (category, code, effectivePeriod, and valueQuantity) where the data requester has access rights to know that data is suppressed for the AU Core Diagnostic Result Observation profile. Patient: Ronny Lawrence Irvine.

Observation - HDL

Shows an example of an HDL result for the AU Core Pathology Result Observation profile. Patient: Mia Leanne Banks.

Observation - Hearing threshold Ear (left) 500 Hz

Shows an example of a hearing threshold result for the AU Core Diagnostic Result Observation profile. Patient: Ronny Lawrence Irvine.

Observation - Heart rate

Shows an example of a heart rate observation for the AU Core Heart Rate profile. Patient: Mr. Li Wang.

Observation - Height

Shows an example of a body height observation for the AU Core Body Height profile. Patient: Mr. Li Wang.

Observation - LDL

Shows an example of an LDL result for the AU Core Pathology Result Observation profile. Patient: Mia Leanne Banks.

Observation - Pulse rate

Shows an example of a pulse rate observation for the AU Core Heart Rate profile. Patient: Mr. Li Wang.

Observation - Respiration rate

Shows an example of a respiration rate observation for the AU Core Respiration Rate profile. Patient: Mia Leanne Banks.

Observation - Temperature

Shows an example of a body temperature observation for the AU Core Body Temperature profile. Patient: Mrs. Anne Bennelong.

Observation - Total Cholesterol/HDL ratio

Shows an example of a Total Cholesterol/HDL ratio result for the AU Core Pathology Result Observation profile. Patient: Mia Leanne Banks.

Observation - Triglyceride

Shows an example of a Triglyceride result for the AU Core Pathology Result Observation profile. Patient: Mia Leanne Banks.

Observation - Waist Circumference

Shows an example of a waist circumference measurement result for the AU Core Waist Circumference profile. Patient: Mia Leanne Banks.

Organization - Bobrester Medical Centre

Shows an example of Bobrester Medical Centre organisation with ABN identifier for the AU Core Organization profile.

Organization - Mitchells Hill Audiology

Shows an example Mitchells Hill Audiology organisation with ABN and HPI-O identifiers for the AU Core Organization profile.

Organization - Murrabit Public Hospital

Shows an example of Murrabit Public Hospital organisation with an HPI-O identifier for the AU Core Organization profile.

Patient - Deangelo HOWE

Shows an example of a patient with IHI for the AU Core Patient profile.

Patient - Mia Leanne Banks

Shows an example of patient who has an IHI, identifies as female, whose sex at birth is recorded as female, identifies as she/her/her/hers/herself, and has multiple contact details for the AU Core Patient profile.

Patient - Mr. Li Wang

Shows an example of a patient with an HPI-O scoped identifier and communications preferences for the AU Core Patient profile.

Patient - Mrs. Anne Bennelong

Shows an example of a patient with a Medicare Number and communication preferences for the AU Core Patient profile.

Patient - Ronny Lawrence Irvine (missing data for birth date)

Shows an example of a patient with missing data for birth date for the AU Core Patient profile.

Practitioner - Darleen MACKAY

Shows an example of a practitioner with HPI-I example for the AU Core Practitioner profile.

Practitioner - Dr. Bob Bobrester

Shows an example of a practitioner for the AU Core Practitioner profile.

Practitioner - Dr. Chau FRYER

Shows an example of a practitioner with HPI-I for the AU Core Practitioner profile.

Practitioner - Dr. Sallie Sutherland

Shows an example of a practitioner with HPI-I for the AU Core Practitioner profile.

PractitionerRole - Cardiologist

Shows an example of a cardiologist for the AU Core PractitionerRole profile that demonstrates the use of Medicare Provider Number and Practitioner, Organization and Location references.

PractitionerRole - General practitioner

Shows an example of a general practitioner for the AU Core PractitionerRole profile with Practitioner and Organisation references.

PractitionerRole - Nephrologist

Shows an example of a nephrologist for the AU Core PractitionerRole profile, using a local employee number as the role identifier and including a refernce to the Practitioner.

PractitionerRole - Surgeon

Shows an example of a surgeon for the AU Core PractitionerRole profile that demonstrates the Medicare Provider Number and Practitioner, Organization and Location references.

Procedure - Dialysis

Shows an example of a Dialysis procedure for the AU Core Procedure profile with reason as a reference to a Condition resource. Patient: Ronny Lawrence Irvine.

Procedure - Stent insertion

Shows an example of a stent insertion procedure for the AU Core Procedure profile. Patient: Mr. Li Wang.

Specimen - Naso swab (COVID test)

Shows a naso swab specimen referenced by the Observation - COVID Pathology Result (Not detected) example for the AU Core Pathology Result Observation profile. Patient: Mr. Li Wang.