AU Base Implementation Guide
4.2.1-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.2.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, 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: 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.

AustralianIndigenousStatus

This search parameter returns patients with an Australian Indigenous Status extension matching the specified code.

EncounterDischargeDisposition

This search parameter returns encounters with a discharge-disposition matching the specified code.

GenderIdentity

This search parameter returns resources with the Individual Gender Identity extension matching the specified code.

Structures: Resource Profiles

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

AU Assertion of No Relevant Finding

This profile provides an observation information structure for asserting a clinical judgement that there are no items of specific interest, (e.g. no current medications or no history of vaccination), for a patient. An assertion of no relevant finding may be used in continuity of care or transfer or care related lists and composition sections.

AU Base Allergy Intolerance

This profile defines an allergy intolerance structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Body Structure

This profile defines a body structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Composition

This profile defines a composition structure that localises core concepts for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Condition

This profile defines a condition structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Coverage

This profile defines a coverage structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Diagnostic Imaging Report

This profile defines a diagnostic report structure to represent a diagnostic imaging report issued by a diagnostic service provider in an Australian context.

AU Base Diagnostic Imaging Result

This profile defines an observation structure to represent a imaging examination result issued by a diagnostic service provider in an Australian context. The observation may represent the result of a simple test such as haemoglobin or it may group the set of results produced by a multi-test study or panel such as a full blood count, or urine specimen study.

AU Base Diagnostic Report

This profile defines a diagnostic report structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Diagnostic Request

This profile defines a service request structure to represent a request for a diagnostic investigation in an Australian context. This profile is intended to support ordering for pathology, radiology, and specialist diagnostic investigations.

AU Base Diagnostic Result

This profile defines an observation structure to represent a diagnostic investigation result issued by a diagnostic service provider in an Australian context. This profile may be used to represent a specialist or other diagnostic (not imaging or pathology) observation including results of audiology studies, sleep studies or speech pathology. The observation may represent the result of a simple investigation or it may group the set of results of a multi-modality procedure or multi-test study / panel.

AU Base Encounter

This profile defines an encounter structure that localises core concepts, including terminology, for use in an Australian context. This profile is intended to be applicable for recording details of ambulatory and non-ambulatory patient encounters in an Australian healthcare context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Healthcare Service

This profile defines a healthcare service structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Immunisation

This profile defines an immunisation structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Location

This profile defines a location structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Medication

This profile defines a medication structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Medication Administration

This profile defines a medication administration structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Medication Dispense

This profile defines a medication dispense structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Medication Request

This profile defines a medication request structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Medication Statement

This profile defines a medication statement structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Organisation

This profile defines an organisation structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Pathology Report

This profile defines a diagnostic report structure to represent a pathology report issued by a diagnostic service provider in an Australian context. This profile is intended to be capable of supporting reporting for all pathology disciplines (e.g. including microbiology, histopathology, cytology, blood transfusion) with the exception of genomics.

This profile does not provide full support for structured pathology reporting. It is expected that this support is best handled by a set of profiles that represent the structured reporting requirements for each specific protocol (see for example RCPA’s structured pathology reporting of cancer); this is not in the scope of this implementation guide at this time.

AU Base Pathology Result

This profile defines an observation structure to represent a pathology test result issued by a diagnostic service provider in an Australian context. This profile is intended to be capable of supporting reporting for all pathology disciplines (e.g. including microbiology, histopathology, cytology, blood transfusion) with the exception of genomics. The observation may represent the result of a simple test such as haemoglobin or it may group the set of results produced by a multi-test study or panel such as a full blood count, or urine specimen study.

This profile does not provide full support for structured pathology reporting. It is expected that this support is best handled by a set of profiles that represent the structured reporting requirements for each specific protocol (see for example RCPA’s structured pathology reporting of cancer); this is not in the scope of this implementation guide at this time.

AU Base Patient

This profile defines a patient structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Practitioner

This profile defines a practitioner structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Practitioner Role

This profile defines a practitioner role structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Procedure

This profile defines a procedure structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Related Person

This profile defines a related person structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Specimen

This profile defines a specimen structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Base Substance

This profile defines a substance structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU Health Program Participation Summary

This profile defines an observation information structure for a summary of an individual’s participation in a health program, e.g. weight management, disease screening, or substance use therapy. Participation information may include information on an individual’s eligibility for a program, suspension of participation in a program, or status of participation in a program.

AU Medicine List

This profile defines a list structure that localises core concepts for use as a medicines list in an Australian context. This profile is intended to offer a common structure and expectations for a list of medications associated with a patient in an Australian healthcare context.

Structures: Data Type Profiles

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

AU Accession Number

This identifier profile defines an accession number in an Australian context. Accession numbers are typically assigned by a diagnostic imaging system or clinical laboratory system and depending on the domain an accession number may for example identify a specimen, imaging examination, or biological polymer sequence.

AU Ahpra Registration Number

This identifier profile defines an Australian Health Practitioner Regulation Agency (Ahpra) registration number in an Australian context (see Ahpra for further information).

AU Australian Business Number

This identifier profile defines an Australian Business Number (ABN) in an Australian context. An ABN is issued to all entities registered in the Australian Business Register (ABR).

AU Australian Company Number

This identifier profile defines an Australian Company Number in an Australian context. An ACN is allocated by the Australian Securities and Investments Commission (ASIC) when a body becomes registered as a company under Corporations Law.

AU Australian Registered Body Number

This identifier profile defines an Australian Registered Body Number (ARBN) in an Australian context. ARBNs are issued to registrable Australian bodies and foreign companies.

AU Base Dosage

This profile defines a dosage structure that localises core concepts for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

AU CSP Registration Number

This identifier profile defines a Contracted Service Provider (CSP) registration number in an Australian context (see My Health Record for further information). A CSP registration number may be issued to organisations who wish to participate in the My Health Record and/or the Healthcare Identifiers Service as a CSP.

AU Care Agency Employee Identifier

This identifier profile defines a care agency employee (CAE) identifier in an Australian context. A CAE identifier may be issued to an employee of, or person under contracted arrangement with, a care agency who wishes to participate in the My Health Record.

AU Commonwealth Seniors Health Card Number

This identifier profile defines a Commonwealth Seniors Health Card number in an Australian context (see Services Australia or Department of Veterans’ Affairs for further information).

This definition supports sending the Centrelink Customer Reference Number (CRN) (also referred to as unique identifier number (UIN) in the Centrelink Confirmation eServices (CCeS)) as displayed on the individual’s Commonwealth Seniors Health Card (see Services Australia for further information). An individual’s CRN is present as the primary identifier on different concession cards and is used to confirm concessions by most government agencies and utility providers.

A Commonwealth Seniors Health Card may be issued by Services Australia or Department of Veterans’ Affairs (DVA) to retirees of age pension qualification age to assist with certain living costs by allowing access to specific goods and services at a concessional rate.

AU DVA Number

This identifier profile defines a Department of Veterans’ Affairs (DVA) number) in an Australian context. This definition supports sending an individual’s state-based DVA file number as displayed on a Veteran Card, i.e. a Gold, White, or Orange Card. A Veteran Card may be issued by DVA to eligible individuals to allowing access to specific goods and services at a concessional rate.

AU Delivery Point Identifier

This identifier profile defines an Australia Post Delivery Point Identifier (DPID) in an Australian context (see Australia Post for further information). A DPID is a randomly generated, unique 8-digit number, allocated by Australia Post to an address. A DPID enables each delivery point in Australia to be uniquely identified.

AU ETP Prescription Identifier

This identifier profile defines an Electronic Transfer of Prescription (ETP) prescription identifier in an Australian context. An ETP prescription identifier is assigned to a prescription by an ETP vendor, e.g. ERx or Medisecure, and is the assigned numeric value of the barcode on a prescription instance.

AU Employee Number

This identifier profile defines an employee number (sometimes referred to as an employee identifier (EI)) in an Australian context. An employee number is an organisation’s identifier for an individual employed by that organisation.

AU G-NAF Identifier

This identifier profile defines a Geocoded National Address File (G-NAF) identifier in an Australian context. The PSMA G-NAF is Australia’s authoritative, geocoded address file. A G-NAF identifier (sometimes referred to as G-NAF ID, or G-NAF PID, or GNAF ID, or address_detail_pid) identifies an address in the PSMA G-NAF.

AU HPI-I

This identifier profile defines a Healthcare Provider Identifier - Individual (HPI-I) in an Australian context (see Australian Digital Health Agency for further information). An HPI-I is assigned under the HI Service to healthcare providers involved in providing patient care.

AU HPI-O

This identifier profile defines a Healthcare Provider Identifier – Organisation in an Australian context (see Australian Digital Health Agency for further information). An HPI-O is assigned under the HI Service to an organisation (such as a hospital or medical clinic) where healthcare is provided.

AU Health Care Card Number

This identifier profile defines Health Care Card number in an Australian context (see Services Australia for further information).

This definition supports sending the Centrelink Customer Reference Number (CRN) (also referred to as unique identifier number (UIN) in the Centrelink Confirmation eServices (CCeS)) as displayed on the individual’s Health Care Card (see Services Australia for further information). An individual’s CRN is present as the primary identifier on different concession cards and is used to confirm concessions by most government agencies and utility providers.

A Health Care Card is a concession card assigned by Services Australia to benefit recipients, low income earners and selected other groups (e.g. foster children) to assist with certain health costs, by allowing access to specific services at a concessional rate.

AU IHI

This identifier profile defines an Individual Healthcare Identifier in an Australian context (see Australian Digital Health Agency for further information). An IHI is assigned under the Healthcare Identifiers (HI) Service to a patient.

AU Insurance Member Number

This identifier profile defines an insurance member number in an Australian context. An insurance member number is the unique member number assigned to an individual by an insurer and is typically displayed on their insurance card. An individual will not have more than one member number per insurer.

This definition supports the sending of an insurance member number that is relevant in a healthcare context and may be used to capture Australian and International health insurer issued member numbers. In Australia this will typically be a private health insurance member number. This identifier should not be confused with an insurance policy number.

AU Local Dispense Identifier

This identifier profile defines a local dispense identifier in an Australian context. A local dispense identifier is an organisation’s identifier for a dispense record in that organisation’s local system set of dispense records. A dispense record identifier is typically assigned by the dispensing system and allows linking of a dispensing record to the dispensing system’s local identifier.

AU Local Order Identifier

This identifier profile defines a local order identifier in an Australian context.A local order identifier is an organisation’s identifier for an order in that organisation’s local system set of orders.

Typically a local order identifier will be either a placer identifier or a filler identifier (sometimes known as filler order number). A placer identifier is an identifier for a request or group of requests where the identifier is issued by the entity making the request. A filler identifier is an identifier for a request or group of requests where the identifier is issued by the entity that produces the observations or fulfills the request.

AU Local Prescription Identifier

This identifier profile defines a local prescription identifier (sometimes referred to as prescription number) in an Australian context. A local prescription identifier is an organisation’s identifier for a prescription in that organisation’s local system set of prescriptions. A local prescription identifier allows linking of a prescription to a system’s local identifier.

AU Local Report Identifier

This identifier profile defines a local report identifier in an Australian context. A local report identifier is an organisation’s identifier for a report in that organisation’s local system set of reports. A report identifier must uniquely identify the report from all other reports in a particular system (e.g. diagnostic imaging system, clinical laboratory system, document management system, referral systems). In some laboratory systems, the report identifier may be a concatenation of a lab number and report panel code (e.g. 19P123456-FBC), where the panel code makes the identifier unique from other reports under the same lab number.

AU Location Specific Practice Number

This identifier profile defines a Location Specific Practice Number (LSPN) in an Australian context (see Services Australia and Department of Health and Aged Care for further information). An LSPN is an identifier assigned to a specific location by Services Australia under the Medicare program and identifies an accredited practice site that provides diagnostic imaging and radiation oncology services.

AU Medical Record Number

This identifier profile defines a (MRN) (sometimes referred to as unit record number (URN) or (UR)) in an Australian context. An MRN is an institution’s identifier for a patient’s record at that institution. A patient may have more than one MRN for a single institution due to organisational restructures.

AU Medicare Card Number

This identifier profile defines a Medicare card number in an Australian context. A Medicare card is provided to individuals who are enrolled in Medicare. This definition supports sending either the 10 digit Medicare card number or the 11 digit number (includes the individual reference number (IRN)).

AU Medicare Provider Number

This identifier profile defines a Medicare provider number assigned by Services Australia to practitioners who provide services covered by the Medicare Benefits Schedule (MBS) at a specific location. A practitioner may have more than one Medicare provider number if they deliver health services in different locations or are registered in multiple health professions.

AU NATA Accreditation Number

This identifier profile defines a National Association of Testing Authorities (NATA) accreditation number in an Australian context (see NATA for further information).

AU NATA Site Number

This identifier profile defines a National Association of Testing Authorities (NATA) site number in an Australian context (see NATA for further information).

AU National Provider Identifier At Organisation

This identifier profile defines a National Provider Identifier at Organisation (NPIO) in an Australian context. An NPIO identifies an individual practitioner at an organisation using the practitioner’s HPI-I and organisation’s HPI-O to form the NPIO.

AU PAI-D Identifier

This identifier profile defines a My Health Record Assigned Identity - Device (PAI-D) identifier in an Australian context. A PAI-D is typically used to identify a device that plays a role, for example an authoring or observing, in the exchange of digital health data with the My Health Record system.

AU PAI-O Identifier

This identifier profile defines a My Health Record Assigned Identity - Organisation (PAI-O) identifier in an Australian context. A PAI-O may be issued to organisations who wish to participate in the My Health Record and who are not eligible for a Healthcare Provider Identifier - Organisation (HPI-O).

AU PBS Prescriber Number

This identifier profile defines a Pharmaceutical Benefits Scheme (PBS) prescriber number in an Australian context (see PBS for further information). A PBS prescriber number, previously referred to as Medicare prescriber number in earlier versions of this implementation guide, is assigned by Services Australia under the Pharmaceutical Benefits Scheme to practitioners who are approved to prescribe PBS medicines under the National Health Act 1953.

AU Pensioner Concession Card Number

This identifier profile defines a Pensioner Concession Card number in an Australian context (see Services Australia or Department of Veterans’ Affairs).

This definition supports sending the Centrelink Customer Reference Number (CRN) (also referred to as unique identifier number (UIN) in the Centrelink Confirmation eServices (CCeS)) as displayed on the individual’s Pensioner Concession Card (see Services Australia for further information). An individual’s CRN is present as the primary identifier on different concession cards and is used to confirm concessions by most government agencies and utility providers.

A Pensioner Concession Card may be issued by Services Australia or Department of Veterans’ Affairs (DVA) to pensioners and selected benefit recipients to assist them with certain living costs, by allowing access to specific goods and services at a concessional rate.

AU Pharmacy Approval Number

This identifier profile defines a pharmacy approval number in an Australian context (see Department of Health and Aged Care for further information). A pharmacy approval number, also known as a PBS approval number, is assigned by the Department of Health to pharmacies that are approved to supply pharmaceutical benefits at particular premises under the National Health Act 1953.

AU Residential Aged Care Service Identifier

This identifier profile defines a residential aged care service identifier (RACS ID) in an Australian context.

Australian Address

This profile defines an address structure that localises core concepts, including identifiers and terminology, for use in an Australian context, to specifically represent an Australian (location) address. The purpose of this profile is to provide best practice guidance on Australian address representation, where some constraint on content is desirable to guarantee the quality of an Australian address.

Structures: Extension Definitions

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

Address Identifier

This extension applies to the Address data type and is used to represent an identifier for an address. An address identifier does not form part of the address itself, e.g. a street number. It is a unique identifier associated with a location address and may be used to look up an address, validate an address, or link to other data relating to an address.

Ahpra Profession Details

This extension applies to the Practitioner.qualification element and is used to represent Australian Health Practitioner Regulation Agency (Ahpra) profession details (see Ahpra for further information). This extension supports the inclusion of the Ahpra profession code and information about conditions, undertakings, reprimands and cautions in a qualification element instance representing a practitioner’s Ahpra profession.

Ahpra Registration Details

This extension applies to the Practitioner.qualification element and is used to represent Australian Health Practitioner Regulation Agency (Ahpra) registration details (see Ahpra for further information). This extension supports the inclusion of the Ahpra profession code and information about division, speciality, registration status, endorsements and notations in a qualification element instance representing a practitioner’s Ahpra registration.

Associated Healthcare Service

This extension applies to any resource and is used to represent a healthcare service relating to a resource, e.g. healthcare services under which the patient was managed during an encounter.

Australian Indigenous Status

This extension applies to the Patient, Person, and RelatedPerson resources and is used to indicate whether a person identifies as being of Aboriginal or Torres Strait Islander origin.

Australian Time Zone

This extension applies to the time data type and is used to represent an Australian time zone.

Australian Veteran Status

This extension applies to the Patient resource and is used to indicate whether a person is serving, or has served, in the Australian Defence Force.

Author as a RelatedPerson

This extension applies to any resource and is used to represent an author who is a related person.

Change Description

This extension applies to the List resource and is used to represent a narrative description of the change to an item in a list entry. The narrative description may include the reason for the change to an item.

Closing the Gap Registration

This extension applies to the Patient resource and provides an indicator of whether the patient is eligible for a Closing the Gap (CTG) co-payment.

Contact Purpose

This extension applies to the ContactPoint data type and is used to represent the purpose for which a contact can be reached, e.g. after hours or billing.

Date Accuracy Indicator

This extension applies to the date and dateTime data types and is used to represent the accuracy of the associated date.

Date of Arrival in Australia

This extension applies to the Patient, RelatedPerson, and Practitioner resources and is used to represent a person’s date of arrival in an Australian context (see Australian Bureau of Statistics for further information). The date of arrival is when a person (born outside of Australia) first arrived in Australia, from another country, with the intention of living in Australia for one year or more. This date is recorded once for a person and is not subsequently updated with subsequent arrivals. This element is a part of Cultural and Linguistic Diversity (CALD) data set. It is an important indicator of cultural identity, and provides further information about a person’s cultural values and practices which can be significant in determining service type, support required, and possible needs.

Dispense Number

This extension applies to the MedicationDispense resource and is used to represent the dispense number or sequence number that has been reached for a therapeutic good prescribed with repeats.

Encounter Description

This extension applies to the Encounter resource and is used to represent a narrative description of the healthcare event or encounter. The description may include a summary of the issues or problems, management strategies, outcomes or progress, possible prognosis, and the patient’s understanding of the healthcare event. The description may capture text about the encounter that is not captured in other fields.

Encryption Certificate PEM X509

This extension applies to the Endpoint resource and is used to support encrypted certificate content for use with an endpoint. This extension allows an endpoint entry to define a suitable certificate for use in communications on the associated channel.

Ethnicity

This extension applies to the Patient resource and is used to represent ethnic identity (see Australian Bureau of Statistics for further information). This extension is to support the provision of healthcare services to patients with specific cultural identities. This extension provides further information about a person’s cultural values and practices which can be significant in determining service type, support required and possible needs.

The words ‘ethnicity’ and ‘ethnic’ are associated with many different meanings, but for the purpose of this extension ethnicity refers to the shared identity or similarity of a group of people on the basis of one or more distinguishing sociological characteristics, such as language, shared history, religion, cultural traditions or geographic origin etc. This extension supports Australian Aboriginal and Torres Strait Islander peoples as well as ethnicities originating from outside of Australia.

HL7 V2 Assigning Authority

This extension applies to the Identifier data type and is used to represent HL7 V2 assigning authority details for HL7 V2 identification for routing.

HL7 V2 Receiving Application

This extension applies to the Endpoint resource and is used to represent routing HL7 V2 message payload details associated with an endpoint. This content allows a sender using these endpoint details to include Receiving Application (MSH-5) information in HL7 V2 messages sent via this channel which allow correct delivery within the receiving system.

HL7 V2 Receiving Facility

This extension applies to the Endpoint resource and is used to represent HL7 V2 receiving facility details for HL7 V2 routing purposes associated with an endpoint. This content allows a sender using these endpoint details to include Receiving Facility (MSH-6) information in HL7 V2 messages sent via this channel which allow correct delivery within the receiving system.

IHI Record Status

This extension applies to the Identifier data type and is used to indicate whether verification of the Individual Healthcare Identifier (IHI) has occurred and is based on the evidence available for a person’s identity.

IHI Status

This extension applies to the Identifier data type and is used to represent the status of the associated Individual Healthcare Identifier (IHI) and indicates whether the status of the IHI is active or otherwise.

IHI Verification Date

This extension applies to the Identifier data type and is used to represent the date, and optionally time, that the IHI was verified with HI Services. This is not the date that it was created by the HI Services, but when it was checked. This is often required to know how recently the identifier was checked, and if it must be re-verified before using it.

Identifier Routability

This extension applies to the Identifier data type. Identifier routability preferences for an asserter.

Information Recipient

This extension applies to the Composition resource and is used to represent an intended recipient of the composition.

Long Term

This extension applies to the MedicationStatement resource and is used to indicate long term use of a medication.

Medication Brand Name

This extension applies to the Medication, MedicationRequest, MedicationDispense amd MedicationStatement resources and is used to represent the brand name of a medication. This extension is not to be the sole representation of the medication concept; it shall not be used as a substitute for medication code (e.g. Medication.code or MedicationStatement.medicationCodeableConcept).

If a system can only supply branded product information in text form, that information will be supplied in the text portion of that code e.g. code.text or medicationCodeableConcept.text. This extension only supports the name portion of a medication concept, not the branded product or product pack information. It is available for use for where a system needs to separate out the brand name string for handling or other processing.

Medication Generic Drug Name

This extension applies to the Medication, MedicationRequest, MedicationDispense and MedicationStatement resources and is used to represent the generic name of a medication. The generic medication text name may not be the same as the subject medication (prescribed, dispensed or stated) but may be used to provide an additional or equivalent drug name that is a generic medication concept. This extension is not to be the sole representation of the medication concept; it shall not be used as a substitute for medication code (e.g. Medication.code or MedicationStatement.medicationCodeableConcept).

If a system can only supply generic product information, and only in text form, that information will be supplied in the text portion of that code e.g. code.text or medicationCodeableConcept.text. This extension only supports the name portion of a medication concept, not the generic product or product pack information. It is available for use for where a system needs to separate out the generic name string for handling or other processing.

Medication Strength

This extension applies to the Medication resource and is used to represent the strength of a medication as text.

Medication Type

This extension applies to the Coding data type and and is used to indicate the type of information covered by the code e.g. branded product with no strength or form. This is useful when there are multiple codings from the same coding system at different levels/classifications.

No Fixed Address

This extension applies to the Address data type and is used to indicate that a location address is not a fixed address for an individual.

Result Copies To

This extension applies to the ServiceRequest resource and is used to indicate an additional recipient to whom a copy of the outcome of the request (i.e. the results) should be sent. The service requester will typically receive a result as part of the normal processing from the filler of the request and this extension is only relevant for any additional result copy recipients indicated on the request.

Subsidised Concurrent Supply

This extension applies to the MedicationRequest or MedicationDispense resources and is used to represent the grounds (e.g. Regulation 49) that authorise a PBS or RPBS subsidy for the concurrent supply of an item specified in a prescription and all of its repeats (see PBS for further information).

Vaccine Vial Serial Number

This extension applies to the Immunization resource and is used to represent the serial number of the vial of vaccine. Vial serial number is part of the Australian Immunisation Register Rule 2015 data elements to report for COVID-19 vaccines.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

AMT Medicinal Product and Substances

The AMT Medicinal Product and Substances value set includes values that may be used to identify a substance or a medicinal product that is an ingredient of a medication.

AU Time Zone

Australian time zones.

Accession Number Type

Identifier types that may be associated with an accession number in an Australian context.

ActEncounterCode - AU Extended

v3 Act Encounter Code extended for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set.

Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction

The Common AU Recorded Sex or Gender (RSG) Source Document Jurisdiction value set includes codes that can be used to identify the jurisdiction that issued the source document where the sex or gender value is recorded.

Common AU Recorded Sex or Gender (RSG) Source Document Type

The Common AU Recorded Sex or Gender (RSG) Source Document Type value set includes codes that can be used to represent the type of document where this sex or gender value is recorded.

Common AU Recorded Sex or Gender Type

The Common AU Recorded Sex or Gender Type value set includes codes that can be used to represent the type or category of sex or gender that is recorded.

Contact Purpose

The purpose for which an associated contact can be reached.

Coverage SelfPay Codes - AU Extended

Coverage SelfPay Codes extended for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set.

Coverage Type and Self-Pay Codes - AU Extended

Coverage Type and Self-Pay Codes extended for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set.

DVA Entitlement

Entitlement types that may be associated with an individual’s Department of Veterans’ Affairs (DVA) File Number on a DVA issued health card in an Australian context.

Location Type (Physical) - AU Extended

Location type (physical) extended for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set.

MIMS

The MIMS value set includes all values from the Monthly Index of Medical Specialties (MIMS) published by MIMS Australia. Further details can be found at https://www.mims.com.au/.

Medication Type

The Medication Type value set may be used to classify the nature of properties defined by the code e.g. branded product with no strength or form. This allows the distinction between codes provided containing container, pack, strength and form explicitly especially where terminologies supplied are unknown or terminology services are unavailable.

Medicine Item Change

The Medicine Item Change value set includes values that may be used to identify that a change that has been made, or is recommended to be made, to a medicine item.

Observation Category Codes - AU Extended

Observation Category Codes extended for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set.

Order Identifier Type

Identifier types that may be associated with an order identifier in an Australian context.

PBS Item Codes

The PBS Item Codes value set includes all values from Australian Pharmaceutical Benefits Scheme (PBS) schedule published by the Department of Health. Further details can be found at https://www.pbs.gov.au/pbs/.

Service Provision Conditions Australian Concepts

The Service Provision Conditions Australian Concepts value set includes values that may be used to identify the type of service provision conditions in an Australian context.

ServiceDeliveryLocationRoleType - AU Extended

ServiceDeliveryLocationRoleType extended for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set.

hl7VS-degreeLicenseCertificate - AU Extended

hl7VS-degreeLicenseCertificate extended for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set.

hl7VS-identifierType - AU Extended

Extended value set of identifier types for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set. NOTE: codes contained LACN Laboratory Accession ID and ACN Accession ID are exclusive concepts and not consider related in this terminology.

hl7VS-providerRole - AU Extended

hl7VS-providerRole extended for use in an Australian context. Includes HL7 international codes plus Australian additions to create a complete set.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

AU Recorded Sex or Gender Source Document Type

The AU Recorded Sex or Gender Source Document Type code system defines concepts that represent the type of document where this sex or gender value is recorded.

AU Recorded Sex or Gender Type

The AU Recorded Sex or Gender Type code system defines concepts that represent the type or category of sex or gender that is recorded.

ActCode AU

Additional concept codes for act coding defined for use in an Australian context. These codes are used as extensions to the HL7 International code set.

Contact Purpose

Purpose for associated contact information.

Coverage SelfPay Codes AU

Additional concept codes for coverage self pay type defined for use in Australian context. These codes are used as extensions to the HL7 International code set.

DegreeLicenseCertificate AU

Additional concept codes for qualification defined for use in an Australian context. These codes are used as extensions to the HL7 International code set.

IdentifierType AU

Additional concept codes for identifier type defined for use in an Australian context. These are additional identifier type codes to the HL7 International code set and suitable for use with Australian identifiers and may be used in HL7 V2.x identifier representations.

Location Type (Physical) AU

Additional concept codes for location physical type defined for use in Australian context. These codes are used as extensions to the HL7 International code set.

Location Type AU

Additional concept codes for location type defined for use in an Australian context. These codes are used as extensions to the HL7 International code set.

Medication Type

The Medication Type code system defines concepts in a classification scheme for medication coding. The classification scheme defines the nature of the properties defined by the code e.g. branded product with no strength or form. This allows the distinction between codes provided containing container, pack, strength and form explicitly especially where terminologies supplied are unknown or terminology services are unavailable.

Medicine Item Change

The Medicine Item Change code system defines concepts that identify a change that has been made, or is recommended to be made, to a medicine item.

Monthly Index of Medical Specialties (MIMS)

This CodeSystem resource represents the Monthly Index of Medical Specialties (MIMS) code system published by MIMS Australia. The intended use of MIMS data is to fully specify the product as a combination of product code, form code, and pack code. For example, when providing a MIMS Code within a Clinical Document Architecture (CDA) document, the MIMS code will be a minimum of 5 digits (in most cases, will be 8 digits).This is not the canonical publication of this code system nor it is intended to be publication on behalf of the MIMS Australia. For the complete content of the code system contact the publisher.

Observation Category Codes AU

Additional concept codes for observation category codes defined for use in an Australian context. These codes are used as extensions to the HL7 International code set.

PBS Item Codes

This CodeSystem resource represents the items listed on the Australian Pharmaceutical Benefits Scheme (PBS) schedule published by the Department of Health. Codes are represented as five or six characters in format (n)nnnna and the display is the PBS prescribing rule preferred term. This is not the canonical publication of this code system nor it is intended to be publication on behalf of the Department of Health. For the complete content of the code system contact the publisher.

Service Provision Conditions Australian Concepts

The Service Provision Conditions Australian Concepts code system defines concepts that identify the conditions under which a healthcare service is available/offered.

providerRole AU

Additional concept codes for specifying the functional involvement with the activity being transmitted (e.g., Case Manager, Evaluator, Transcriber, Nurse Care Practitioner, Midwife, Physician Assistant, etc.) defined for use in an Australian context. These codes are used as extensions to the HL7 International code set.

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 - ibuprofen allergy

AllergyIntolerance - ibuprofen allergy

AllergyIntolerance - no known allergy

AllergyIntolerance - no known allergy

AllergyIntolerance - self-reported allergy to eggs

AllergyIntolerance - self-reported allergy to eggs

AllergyIntolerance - self-reported intolerance to lactose

AllergyIntolerance - self-reported intolerance to lactose

BodyStructure - Blister of right foot

Blister of right foot

BodyStructure - Bone tissue of left shoulder

Bone tissue of left shoulder

Bundle - Medicine list in a bundle

Shows a medicine list in a bundle

Composition - Patient’s preference upon death

Shows a typical composition showing the patient’s preference upon death

Composition - with multiple information recipients

Shows a typical composition author role and multiple information recipients of different resource types

Condition - with evidence and onset date-time

Condition with evidence and onset date-time

Coverage - DVA Gold Card

Coverage with DVA Gold Card

Coverage - private health insurer

Coverage with private health insurer

Device - as a registered repository service

A registered repository service

Encounter - Annual check up

Shows an annual check up encounter for Observation-healthprogramparticipation-example0

Encounter - with description

Encounter with encounter description

Encounter - with narative description

Encounter with narrative description

Endpoint - a secure messaging endpoint example

Shows a secure messaging endpoint example

HealthcareService - Leafy Grove Home for the Aged

Shows Leafy Grove Home for the Aged healthcare service

HealthcareService - Leafy Grove Home for the Not Very Aged

Shows Leafy Grove Home for the Not Very Aged healthcare service

HealthcareService - a typical Healthcare Service the Radiologist belongs to

Shows a typical Healthcare Service the Radiologist belongs to

HealthcareService - general practice

Shows a typical Healthcare Service the General Practitioner belongs while also describing communication languages

HealthcareService - of a Pathologist

Shows a typical Healthcare Service the Pathologist belongs to

HealthcareService - with HPI-O and eligibility

Shows a typical healthcare service using the identifier profile for HPI-O, and eligibility information

Immunization - Administration of Pfizer Comirnaty dose 1 for Sarah Simmons

Administration of Pfizer Comirnaty dose 1 for Sarah Simmons

Immunization - Administration of a vaccine - record compliant with Australian Immunisation Register (AIR)

Administration of a vaccine - record compliant with Australian Immunisation Register (AIR)

Immunization - Administration of a vaccine with administering provider and protocol

Administration of a vaccine with administering provider and protocol

Immunization - Non-administration of varicella-zoster live vaccine due to refusal

Non-administration of varicella-zoster live vaccine due to refusal

List - Medicine list authored by a related person

Shows a medicine list authored by a related person

List - Medicine list with changes

Shows a medicine list with changes

List - Medicine list with no known current medicine

Medicine list - with no known current medicine

List - Medicine list with referenced entries

Medicine list with referenced entries

Location - Leafy Grove Home for the Aged

Shows Leafy Grove Home for the Aged as a location

Location - Leafy Grove Home for the Not Very Aged

Shows Leafy Grove Home for the Not Very Aged as a location

Location - a hospital location with managing organisation of example0

Shows a typical hospital location with a managing organisation

Location - for mobile services that can be delivered in a person's house, apartment, or unit

Shows a typical location where services can be delivered in a person’s house, apartment, or unit

Location - for mobile services that can be delivered in residential care facilities

Shows a typical location where services can be delivered in residential care facilities

Location - for mobile services that can be delivered in schools

Shows a typical location where services can be delivered in schools

Location - for services delivered by phone, video or online

Shows a typical location where services are delivered by phone, video or online

Location - of a Practitioner as a General Practitioner

Shows a typical location at which this General Practitioner provides care

Location - of a Practitioner as a Pathologist

Shows a typical location at which this practitioner provides care

Location - of a Practitioner as a Radiologist

Shows a typical location at which this practitioner provides care

Medication - Branded Pack With Single Active Ingredient

Shows a branded pack with a single active ingredient

Medication - Branded Pack of Nexium HP7 20;500;500

Shows a branded pack of Nexium HP7 20;500;500

Medication - Branded Pack with Batch Details

Shows a branded pack with batch details

Medication - Generic Pack of paracetamol 500mg (100)

Shows a generic pack of paracetamol 500mg (100)

Medication - Unbranded Product of clarithromycin 500mg tablet

Shows an unbranded product of clarithromycin 500mg tablet

Medication - Unbranded Product of esomeprazole 20mg tablet

Shows an unbranded product of esomeprazole 20mg tablet

Medication - Unbranded product of amoxicillin 500mg capsule

Shows an unbranded product of amoxicillin 500mg capsule

Medication - branded pack

Medication with brand and generic name extensions

Medication - dose based

Shows a typical dose based medication

Medication - uncoded medicinal product information

Medication with uncoded medicinal product information

Medication - with four or more active ingredients

Shows a medication with four or more active ingredients

Medication - with two active ingredients product

Shows a medication product with 2 active ingredients

MedicationAdministration - Administration of Chlorsig eye drops

Shows a medication administration of Chlorsig eye drops

MedicationAdministration - Self-administration of lantus 100 units/mL injection

Shows medication administration that is a self-administration of lantus 100 units/mL injection

MedicationDispense - First dispense for Reaptan

Shows a first medication dispense for Reaptan

MedicationDispense - Second dispense for Reaptan

Shows a second medication dispense for Reaptan

MedicationRequest - Prescription with brand and generic name extensions

Shows a prescription with brand and generic name extensions

MedicationRequest - a prescription for Stribild tablet

Shows a prescription for Stribild tablet

MedicationRequest - a prescription for codeine with paracetamol

Shows a prescription for codeine with paracetamol

MedicationStatement - Practitioner reports patient has taken Diflucan in the past but is not taking it any more

Practitioner reports patient has taken Diflucan in the past but is not taking it any more

MedicationStatement - of a record of a patient's long-term use of medication

Shows a typical informative record of a patient’s long-term use of medication

MedicationStatement - of a record of a patient's use of medication

Shows a typical informative record of a patient’s use of medication

Observation - Measurement of Hepatitis B surface antibody

Hepatitis B surface antibody measurement

Observation - active participation in 12 step alcohol program

Active participation in 12 step alcohol program

Observation - deferred BreastScreen Australia screening due to travel

Deferred BreastScreen Australia screening due to travel

Observation - of no relevant finding of immunisations

Shows an example of no history of immunisation

Observation - of no relevant finding of known history of conditions

Shows an example of no known history of conditions

Observation - of no relevant finding of patient taking any medications

Shows an example of patient not taking any medications

Observation - of no relevant finding of procedure

Shows an example of no history of procedure

Organization - Holistic Medical Pty Ltd with ABN and HPI-O

Shows a typical Organisation with ABN and HPI-O identifiers

Organization - The Corporation of the Council of the Ward of Nundah

Shows the organisation of The Corporation of the Council of the Ward of Nundah

Organization - a Pathology organisation with HPI-O and is a parent organization

Shows a parent pathology organisation using the identifier profile for HPI-O

Organization - a Pathology organisation with NATA Number, ARBN, ABN, ACN, HPI-O and PAI-O

Shows a pathology organisation using the identifier profile for NATA Number, ARBN, ABN, ACN, HPI-O and PAI-O

Organization - a typical Organisation the General Practitioner belongs to

Shows a typical Organisation the General Practitioner belongs to

Organization - a typical Organisation the Radiologist belongs to

Shows a typical Organisation the Radiologist belongs to

Organization - with HPI-O

Shows a typical organisation using the identifier profile for HPI-O

Organization - with source

Shows a typical organisation with a source reference

Patient - Australian No Fixed Address

Shows a typical Address with Australian no fixed address

Patient - Australian address with identifiers

Shows a typical Address with identifiers

Patient - Transgender Person Example

Shows an example of a patient that demonstrates the adopted extensions for sex and gender. This example is taken and adapted from the R5 Transgender Person Example.

Patient - as a Culturally and linguistically diverse (CALD) patient 1

Shows a patient who requires an interpreter and their preferred communication language

Patient - as a Culturally and linguistically diverse (CALD) patient 2

Shows a patient who requires an interpreter and their country of birth

Patient - as a child born in 2008

Shows a typical child patient born in 2008

Patient - as a mother for the patient in example 4

Shows a typical Patient as a mother for the patient in example 4

Patient - male born in 1949 with address and contact details

Shows a typical male born in 1949 with address and contact details

Patient - structured Australian Address

Shows a typical Address with structured Australian address

Patient - unstructured Australian Address

Shows a typical Address with unstructured Australian address

Patient - with Birth Date Accuracy Indicator of AAA

Shows a typical Patient Date Accuracy Indicator extension Accurate Year, Accurate Month and Accurate Date

Patient - with Birth Date Accuracy Indicator of AAU

Shows a typical Patient Date Accuracy Indicator extension Accurate Year, Accurate Month and Unknown Date

Patient - with Birth Date Accuracy Indicator of UAA

Shows a typical Patient Date Accuracy Indicator extension Unknown Year, Accurate Month and Accurate Date

Patient - with Birth Date Accuracy Indicator of UEA

Shows a typical Patient Date Accuracy Indicator extension Unknown Year, Estimated Month and Accurate Date

Patient - with Birth Date Accuracy Indicator of UUU

Shows a typical Patient Date Accuracy Indicator extension Unknown Year, Unknown Month and Unknown Date

Patient - with IHI, DVA Number (with specific card colour) and the extension for Indigenous Status

Shows a typical patient using identifier profiles for IHI, DVA Number (with specific card colour) and the extension for Indigenous Status

Patient - with IHI, Medicare Card Number and the extension for Indigenous Status

Shows a typical patient using identifier profiles for IHI, Medicare Card Number and the extension for Indigenous Status

Patient - with birth date and birth time

Shows a typical patient with birth date and birth time

Patient - with no birth date, and is eligible for Closing the Gap registration

Shows a patient with the extension for indigenous Status and the extension for Closing the Gap registration, with no birth date.

Practitioner - a typical Ahpra registered professional

Shows a typical Ahpra registered professional

Practitioner - a typical Practitioner as a General Practitioner

Shows a typical Practitioner as a General Practitioner

Practitioner - as a Pathologist

Shows a typical Practitioner as a Pathologist

Practitioner - as a Radiologist

Shows a typical Practitioner as a Radiologist

Practitioner - for use in sex and gender

Shows an example of a practitioner that demonstrates the adopted extensions for sex and gender.

Practitioner - with HPI-I and Prescriber Number

Shows a typical practitioner using identifier profiles for HPI-I and Prescriber Number

PractitionerRole - a typical Practitioner Role as a General Practitioner

Shows a typical Practitioner Role as a General Practitioner

PractitionerRole - a typical Practitioner Role as a Radiologist

Shows a typical Practitioner Role as a Radiologist

PractitionerRole - as a Pathologist

Shows a typical Practitioner Role as a Pathologist

PractitionerRole - with Provider Number and ANZSCO coded role

Shows a typical practitioner role using the identifier profile for Provider Number at a specific location, with role using ANZSCO

PractitionerRole - with assigning authority

PractitionerRole with identifier including assigning authority

Procedure - Cardiac catheterisation

Shows a cardiac catheterisation procedure

Procedure - Cryotherapy

Shows a cryotherapy procedure

Procedure - Stent placement

Shows a stent placement procedure

RelatedPerson - as a carer for an older patient

Shows an example of a carer as a related person for an older patient

RelatedPerson - as a mother for the patient in example 4

Shows a typical related person as a mother of a patient

RelatedPerson - as attester party

Shows a typical related person example

RelatedPerson - as family member, for use in sex and gender

Shows an example of a related person that demonstrates the adopted extensions for sex and gender.

RelatedPerson - as father

Shows a typical related person example as the father of a patient

ServiceRequest - for Hepatitis B surface antibody measurement

Service request for Hepatitis B surface antibody measurement

ServiceRequest - with multiple result copies to indicated

A service request with multiple result copies to indicated

Specimen - Serum sample

Serum sample as a specimen

Substance - body substance of epiglottic mucus

Shows a body substance of epiglottic mucus

Substance - medication substance with two active ingredients

Medication substance with two active ingredients

Substance - peanuts as an allergen

Peanuts as an allergen

​Composition - with some sections having a different section author to the composition author

Shows a composition with some sections having a different section author to the composition author