AU Core Implementation Guide
0.4.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 0.4.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.

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 Client CapabilityStatement

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

AU Core Server CapabilityStatement

This CapabilityStatement describes the basic rules for the AU Core server actor that is responsible for providing responses to queries submitted by AU Core clients. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU Core servers 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 Provenance

This profile sets minimum expectations for an Provenance resource to record, search, and fetch basic provenance information for a patient. It is based on the core FHIR Provenance resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Provenance 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

Lactose (food) intolerance

Patient: Mia BANKS

AllergyIntolerance - No known allergy

No known allergy

Patient: Mr. Li Wang

AllergyIntolerance - Penicillin allergy

Penicillin (medication) allergy

Patient: Deangelo HOWE

Condition - Cellulitis of Right Knee

Cellulitis of right knee

Patient: Anne Bennelong

Condition - Chronic Kidney Disease

Chronic Kidney Disease

Patient: Mr. Harry Dan

Condition - Urinary tract infection

Urinary tract infection

Patient: Mia LEANNE BANKS

DocumentReference - Advance Care Plan, referenced by Provenance/signature example

Mr. Li Wang’s Advance Care Plan

Patient: Mr. Li Wang

Encounter - COVID 19 Vaccine Administration Dose 1

COVID 19 Vaccine Administration for Immunization-covid-1

Patient: Mrs. Anne Bennelong

Encounter - Discharge

Emergency encounter with discharge to home from AU Hospital

Patient: Mr. Harry Dan

Encounter - consultation

Consultation

Patient: Mrs. Anne Bennelong

Encounter - telehealth

Telehealth encounter

Patient: Mrs. Anne Bennelong

Immunization - Administration of Zoster vaccination refused

Administration of Zoster vaccination refused (patient objection)

Patient: Deangelo HOWE

Immunization - COVID Dose 1

Mrs. Anne Bennelong - COVID Dose 1

Location - Mitchells Hill Audiology

Mitchells Hill Audiology

Location - Murrabit Public Hospital

Murrabit Public Hospital

Location - Patient home

Patient home as kind of location (not a specific patient’s location).

Location - Tindal Building

Tindal Building, Bobrester Medical Centre

Medication - Branded pack with one active ingredient

Branded pack with one active ingredient.

Medication - Product with two active ingredients

Product with two active ingredients.

Medication - Simvastatin 40 MG Disintegrating Oral Tablet

Simvastatin 40 MG Disintegrating Oral Tablet.

MedicationRequest - active prescription, Reaptan

Active prescription for Reaptan 10 mg/10 mg (perindopril arginine/amlodipine) tablet, 10.

MedicationRequest - active prescription, paracetamol 500 mg + codeine phosphate hemihydrate 30 mg

Active prescription for paracetamol 500 mg + codeine phosphate hemihydrate 30 mg tablet.

Observation - Blood Pressure (data absent for diastolic)

Blood Pressure - data absent for diastolic

Patient: Mr. Harry Dan

Observation - Blood Pressure (systolic and dystolic)

Blood Pressure - isolated diastolic hypertension

Patient: Mr. Li Wang

Observation - Body weight

Body weight recorded by GP at 6 months

Patient: John Smith

Observation - COVID Pathology Result (Not detected)

COVID Pathology Result (Not detected)

Patient: Mr. Li Wang

Observation - Current smoker

Observation of smoking status of current smoker

Patient: Mr. Li Wang

Performer: Dr. Bob Bobrester, GP

Observation - HDL

HDL result

Patient: Mia LEANNE BANKS

Observation - Hearing threshold Ear (left) 500 Hz

Hearing threshold of Left Ear 500 Hz

Patient: Mr. Harry Dan

Observation - Heart rate

Heart rate recorded by GP

Patient: Mr. Li Wang

Observation - Height

Height recorded by GP

Patient: Mr. Li Wang

Observation - LDL

LDL result

Patient: Mia LEANNE BANKS

Observation - Pulse rate

Pulse rate recorded by GP

Patient: Mr. Li Wang

Observation - Respiration rate

Observation of respiration rate

Patient: Mia LEANNE BANKS

Observation - Temperature

Temperature

Patient: Mrs. Anne Bennelong

Observation - Total Cholesterol/HDL ratio

Total Cholesterol/HDL ratio result

Patient: Mia LEANNE BANKS

Observation - Triglyceride

Triglyceride result

Patient: Ms. Mia LEANNE BANKS

Observation - Urea nitrogen [Mass/volume] in Serum or Plasma

Urea nitrogen [Mass/volume] in Serum or Plasma 24 mg/dL

Patient: Mr. Harry Dan

Observation - Waist Circumference

Waist Circumference

Patient: Mia LEANNE BANKS

Organization - Bobrester Medical Centre

Bobrester Medical Centre

Organization - Mitchells Hill Audiology

Mitchells Hill Audiology

Organization - Murrabit Public Hospital

Murrabit Public Hospital

Patient - Deangelo HOWE

Deangelo Howe

Patient - Mia Leanne Banks

Mia Leanne Banks

Patient - Mr. Harry Dan

Mr. Harry Dan

Patient - Mr. Li Wang

Mr. Li Wang

Patient - Mrs. Anne Bennelong

Mrs. Anne Bennelong

Practitioner - Darleen MACKAY

Darleen MACKAY

Practitioner - Dr. Bob Bobrester

Dr. Bob Bobrester

Practitioner - Dr. Chau FRYER

Dr. Chau Fryer

Practitioner - Dr. Sallie Sutherland

Dr. Sallie Sutherland

PractitionerRole - Cardiologist

Dr. Sallie Sutherland, Murrabit Public Hospital

PractitionerRole - General practitioner

Dr. Bob Bobrester, GP, at Bobrester Medical Centre

PractitionerRole - Nephrologist

Darleen MACKAY, Nephrologist

PractitionerRole - Surgeon

Chau FRYER, Surgeon, at Murrabit Public Hospital

Procedure - Dialysis

Dialysis

Patient: Mr. Harry Dan

Procedure - Stent insertion

Placement of stent in coronary artery

Patient: Mrs. Anne Bennelong

Provenance - Signature for advance care plan

Provenance of verification with signature for advance care plan

Specimen - Naso swab (COVID test)

Naso swab specimen for COVID test

Patient: Mr Li Wang