AU Core Implementation Guide
1.0.0-ci-build - CI Build
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
Page standards status: Informative |
AU Core aligns to, and leverages, international standards and other national standards, in particular:
Relationships between AU Core, AUCDI, and the above key implementation guides is described in Relationship with other IGs.
Corresponding profiles, conformance requirements, and capability statements included in the key FHIR implementation guides were reviewed and considered during AU Core's development to ensure alignment, and to facilitate adoption of, this standard.
The below comparison evaluates AU Core conformance requirements with the key implementation guides identifying where compliance with AU Core satisfies the expectations established by the referenced implementation guide.
At this time only profile comparison is available. Future versions of AU Core will compare capability statements.
As part of profile comparison, the requirements, constraints, and standards specified in a particular FHIR profile are evaluated. These requirements can include mandatory elements, cardinality constraints, data types, terminology bindings, usage rules, extensions, rules on missing or suppressed data.
The table below provides a profile only comparison from AU Core to profiles in key implementation guides. Compliance in the reverse direction is not guaranteed, i.e. a resource that is compliant with an International Patient Access profile MAY NOT be compliant with AU Core.
Legend:
Compliant: An AU Core compliant resource meets all requirements of the compared profile.
Additional requirements: An AU Core compliant resource is compatible, but additional changes may be needed to meet all requirements of the compared profile. Where additional requirements are identified, more information is provided in the sections below.
Incompatible: An AU Core compliant resource is incompatible with the compared profile. A resource cannot be compliant to both. Where incompatible requirements are identified, more information is provided in the sections below.
No equivalent profile: No equivalent profile for comparison.
International Patient Access 1.0.0 describes how an application acting on behalf of a patient can access patient information from a clinical records system using a FHIR-based API.
The following IPA profile(s) contain incompatible requirements with the equivalent AU Core profile. Implementers are advised to note that substantial code changes may be required to support these profiles.
AU Core | International Patient Access 1.0.0 | Element | Incompatible requirements |
---|---|---|---|
AU Core MedicationRequest | IPA-MedicationRequest | MedicationRequest.requester | IPA prohibits reference to Organization and RelatedPerson resources. |
AU Core compliant resources are compliant with IPA requirements for Missing Data.
IPA does not include requirements for Suppressed Data.
This version of AU Core has no equivalent profile for the following IPA profiles:
International Patient Summary Implementation Guide 1.1.0 describes how to represent the International Patient Summary (IPS) using HL7 FHIR. An International Patient Summary document is an electronic health record extract containing essential healthcare information about a subject of care.
The following IPS profile(s) contain additional requirements. Implementers are advised to note that some code changes may be required to support these profiles.
AU Core | International Patient Summary 1.1.0 | Element | Additional requirements |
---|---|---|---|
AU Core AllergyIntolerance | Allergy Intolerance (IPS) | AllergyIntolerance.patient.reference | IPS requires minimum of 1. |
AU Core Condition | Condition (IPS) | Condition.clinicalStatus | IPS requires minimum of 1. |
Condition.subject.reference | IPS requires minimum of 1. | ||
AU Core Diagnostic Result Observation | Observation Results (IPS) | Observation.status | IPS requires value 'final'. |
Observation.subject.reference | IPS requires minimum of 1. | ||
AU Core Immunization | Immunization (IPS) | Immunization.patient.reference | IPS requires minimum of 1. |
AU Core Medication | Medication (IPS) | Medication.ingredient.strength | IPS requires UCUM for coded quantity units. |
AU Core MedicationRequest | Medication Request (IPS) | MedicationRequest.subject.reference | IPS requires minimum of 1. |
AU Core Pathology Result Observation | Observation Results: laboratory (IPS) | Observation.status | IPS requires value 'final'. |
Observation.subject.reference | IPS requires minimum of 1. | ||
Observation.performer | IPS requires minimum of 1. | ||
Observation.value | IPS requires UCUM for coded quantity units. | ||
Observation Results: pathology (IPS) | Observation.status | IPS requires value 'final'. | |
Observation.subject.reference | IPS requires minimum of 1. | ||
Observation.performer | IPS requires minimum of 1. | ||
Observation.value | IPS requires UCUM for coded quantity units. | ||
AU Core Procedure | Procedure (IPS) | Procedure.subject.reference | IPS requires minimum of 1. |
Procedure.performed[x] | IPS requires minimum of 1. | ||
AU Core Smoking Status | Observation - SH: tobacco use | Observation.subject.reference | IPS requires minimum of 1. |
Observation.code | IPS requires LOINC code 72166-2. | ||
Observation.value[x] | IPS requires value from Current Smoking Status - IPS. |
AU Core compliant resources are compliant with IPS requirements for Missing Data.
IPS does not include requirements for Suppressed Data.
This version of AU Core has no equivalent profile for the following IPS profiles:
US Core Implementation Guide 7.0.0 serves as the foundation for FHIR implementation guides in the US Realm. It establishes the minimum constraints on FHIR resources to define US Core Profiles, specifying the required elements, extensions, vocabularies, and value sets, as well as their usage. It also outlines the minimum FHIR RESTful interactions needed to access patient data for each US Core Profile.
The following US Core profile(s) contain additional requirements. Implementers are advised to note that some code changes may be required to support these profiles.
AU Core | US Core 7.0.0 | Element | Additional requirements |
---|---|---|---|
AU Core Condition | US Core Condition Problems and Health Concerns Profile | Condition.category | US Core requires category of 'problem-list-item' or 'health-concern'. |
US Core Condition Encounter Diagnosis Profile | Condition.category | US Core requires category of 'encounter-diagnosis'. | |
AU Core Diagnostic Result Observation | US Core Observation Clinical Result Profile | Observation.code | US Core extensible binding to LOINC Codes. |
Observation.value[x] | US Core requires UCUM for coded quantity units. | ||
AU Core Encounter | US Core Encounter Profile | Encounter.type | US Core requires minimum of 1. |
AU Core Immunization | US Core Immunization Profile | Immunization.vaccineCode | US Core extensible binding to CVX Vaccines Administered Vaccine Set. |
AU Core Location | US Core Location Profile | Location.name | US Core requires minimum of 1. |
AU Core Medication | US Core Medication Profile | Medication.code | US Core extensible binding to Medication Clinical Drug. |
AU Core MedicationRequest | US Core MedicationRequest Profile | MedicationRequest.medicationCodeableConcept | US Core extensible binding to Medication Clinical Drug. |
AU Core Organization | US Core Organization Profile | Organization.active | US Core requires minimum of 1. |
AU Core Pathology Result Observation | US Core Laboratory Result Observation Profile | Observation.code | US Core extensible binding to US Core Laboratory Test Codes. |
Observation.referenceRange | US Core requires UCUM for coded quantity units. | ||
AU Core Patient | US Core Patient Profile | Patient.identifier | US Core requires all identifiers to have system and value. |
Patient.name | US Core requires all name to have family or given or Data Absent Reason extension. | ||
Gender identity | US Core requires US Core Gender Identity extension. | ||
Patient.telecom | US Core requires all telecom to have system and value. | ||
AU Core Practitioner | US Core Practitioner Profile | Practitioner.identifier | US Core requires minimum of 1, and all identifiers to have system and value. |
AU Core PractitionerRole | US Core PractitionerRole Profile | PractitionerRole.telecom, PractitionerRole.endpoint | US Core requires telecom or endpoint to be present (pd-1). |
PractitionerRole.telecom | US Core requires all telecom to have system and value. | ||
AU Core Smoking Status | US Core Smoking Status Observation Profile | Observation.status | US Core requires status of 'final' or 'entered-in-error'. |
Observation.code | US Core extensible binding to Smoking Status Type. | ||
Observation.value[x]:valueCodeableConcept | US Core extensible binding to Smoking status comprehensive. |
AU Core compliant resources are compliant with US Core requirements for Missing Data.
US Core does not include requirements for Suppressed Data.
This version of AU Core has no equivalent profile for the following US Core profiles: