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

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

Change Log

Page standards status: Informative

Release 1.0.0

  • Expected Publication date: 2025-01-24
  • Expected Publication status: Working Standard
  • Based on FHIR version: 4.0.1

This change log documents the significant updates and resolutions implemented from version 1.0.0-ballot to 1.0.0.

Changes in this version

  • Made the following changes to AU Core Diagnostic Result Observation:
    • corrected base profile to AU Base Diagnostic Observation FHIR-47116
  • Made the following changes to AU Core Location:
    • removed Must Support flag and associated Obligation extensions from Location.identifier FHIR-47105 and Location.mode FHIR-47104
  • Changed the Observation search parameter ‘patient’ from SHALL to MAY FHIR-47171
  • Removed the requirement for including an offset in the Patient ‘birthdate’ search parameter FHIR-47150
  • Updated requirement for AU Core Requester to mandate both system and code values for identifier search parameters on Location, Organization, Practitioner and PractitionerRole FHIR-46782
  • Changed the Organization ‘name’ search parameter from SHOULD to SHALL FHIR-47109
  • Changed the Location ‘address’ search parameter from SHALL to SHOULD FHIR-47107
  • Added a PractitionerRole ‘role’ search parameter as a SHOULD FHIR-47115
  • Changed MedicationRequest search parameters ‘patient+intent’ and ‘patient+intent+status’ from SHALL to SHOULD, and added a new MedicationRequest search parameter ‘patient+status’ as a SHALL FHIR-47073

Release 1.0.0-ballot

  • Publication date: 2024-08-05
  • Publication status: Ballot
  • Based on FHIR version: 4.0.1

This change log documents the significant updates and resolutions implemented from version 0.3.0-ballot to 1.0.0-ballot.

Changes in this version

  • Added AUCDI element mapping Date/Time of Measurement and Date/Time of Observation, and added future consideration note for Last Updated
  • dependency to Smart App Launch changed to 2.1.0 instead of latest (2.2.0) due to missing dependency issue that causes failure to load in NPM Package registry FHIR-46398
  • FHIR Obligations, Actors, and Capabilities:
  • Added Security and Privacy page FHIR-45067, and added requirements on supporting TLS 1.2 and TLS 1.3 FHIR-46068.
  • Added AU Variance Statement page FHIR-46034.
  • Moved the Medicine Information section from the General Guidance page to a new Medicine Information page FHIR-45165.
  • Removed support for the following search parameters and search parameter combinations:
  • Made the following changes to AU Core Immunization:
    • removed Must Support from Immunization.encounter FHIR-45218
    • removed Must Support from Immunization.performer, Immunization.performer.function, Immunization.performer.actor FHIR-44653
    • removed Must Support from Immunization.protocolApplied, Immunization.protocolApplied.series, Immunization.protocolApplied.targetDisease, Immunization.protocolApplied.doseNumber[x] FHIR-44674, FHIR-44656, FHIR-44654
    • removed Must Support from Immunization.reasonCode FHIR-44654, FHIR-45968
    • added Must Support to Immunization.primarySource FHIR-44659
    • changed Immunization.vaccineCode slicing rule from slicing by system to slice by value set FHIR-46391
    • support for AIR codes and AMT Vaccine codes in Immunization.vaccineCode changed to define the slices in AU Core (no longer inherited from AU Base as per FHIR-44821). Slicing discriminator changed from slicing by value:system to slicing by value set and AMT value set binding strength has been corrected to required. FHIR-46391
  • Made the following changes to AU Core Encounter:
    • removed Must Support from Encounter.identifier FHIR-45212
    • removed Must Support from Encounter.type FHIR-44580
    • removed Must Support from Encounter.hospitalization, Encounter.hospitalization.dischargeDisposition FHIR-45210
    • in Encounter.participant.individual replaced RelatedPerson with AU Base RelatedPerson FHIR-45228
  • Removed Must Support from Location.description in AU Core Location FHIR-45029.
  • Made the following changes to AU Core MedicationRequest:
    • in MedicationRequest.requester replaced RelatedPerson with AU Base RelatedPerson FHIR-45228
    • removed Must Support from MedicationRequest.identifier FHIR-45208
    • removed Must Support from MedicationRequest.category FHIR-45207
    • removed Must Support from MedicationRequest.note FHIR-45209
    • removed Must Support from MedicationRequest.dispenseRequest, MedicationRequest.dispenseRequest.validityPeriod, MedicationRequest.dispenseRequest.numberOfRepeatsAllowed, MedicationRequest.dispenseRequest.quantity FHIR-45088
    • removed Must Support from MedicationRequest.substitution, MedicationRequest.substitution.allowed[x] FHIR-45088
    • added Must Support to MedicationRequest.reasonReference FHIR-45090
    • support for AMT codes and PBS Item Codes in MedicationRequest.medicationCodeableConcept changed to define slicing in AU Core (no longer inherited from AU Base as per FHIR-44821). Slicing discriminator changed from slicing by value:system to slicing by value set and the binding strength has been corrected to required. FHIR-46391
    • updated invariant au-core-medreq-01 to allow for a Data Absent Reason extension in order to meet AU Core Missing Data and Suppressed Data requirements FHIR-46417
  • Made the following changes to AU Core Medication:
    • removal of Must Support from Medication.manufacturer FHIR-45130
    • removed Must Support from Medication.form FHIR-45221
    • removed Must Support from Medication.ingredient FHIR-45220
    • removed Must Support from Medication.ingredient.item[x] FHIR-45220
    • removed Must Support from Medication.ingredient.isActive FHIR-45220, FHIR-45130, FHIR-45049
    • removed Must Support from Medication.ingredient.strength FHIR-45220
    • removed Must Support from Medication.amount FHIR-45219
    • support for AMT codes and PBS Item Codes in Medication.code changed to define slicing in AU Core (no longer inherited from AU Base as per FHIR-44821). Slicing discriminator changed from slicing by value:system to value set and the binding strength has been corrected to required. FHIR-46391
  • Made the following changes to AU Core Organizaton:
    • removed Must Support from Organization.alias FHIR-44585
    • corrected the invariant au-core-org-01 FHIRPath expression FHIR-46103
  • Made the following changes to AU Core Patient:
    • removed Must Support from Patient.extension:birthPlace FHIR-45018
    • removed Must Support from Patient.extension:interpreterRequired FHIR-45186
    • removed Must Support from Patient.birthDate.extension:birthTime FHIR-45028
    • removed Must Support from Patient.birthDate.extension:accuracyIndicator FHIR-45028
    • added Must Support on Patient.name.text FHIR-44818
    • added Must Support on Patient.name.family FHIR-44818
    • added Must Support on Patient.name.given FHIR-44818
  • updated invariants au-core-pat-01, au-core-pat-02, and au-core-pat-04 to allow for a Data Absent Reason extension in order to meet AU Core Missing Data and Suppressed Data requirements FHIR-46406
  • Made the following changes to AU Core Practitioner:
    • removed Must Support from Practitioner.communication FHIR-44588
    • removed Must Support from Practitioner.qualification, Practitioner.qualification.identifier, Practitioner.qualification.code, Practitioner.qualification.period, Practitioner.qualification.issuer: FHIR-45118, FHIR-44587
    • removed Must Support from Practitioner.address FHIR-43860
    • removed Must Support from Practitioner.telecom FHIR-43860
    • added Must Support on Practitioner.name.family FHIR-44819
    • added Must Support on Practitioner.name.given FHIR-44819
    • replaced constraint au-core-prac-01: At least text or family name shall be present with making Practitioner.name.family mandatory (1..1) FHIR-44819
  • Made the following changes to AU Core PractitionerRole:
    • removed Must Support from PractitionerRole.location FHIR-43841
    • updated invariant au-core-prarol-01 to allow for a Data Absent Reason extension in order to meet AU Core Missing Data and Suppressed Data requirements FHIR-46419
  • Made the following changes to AU Core Procedure:
    • removed Must Support from Procedure.statusReason FHIR-45013
    • removed Must Support from Procedure.category FHIR-45014
    • removed Must Support from Procedure.recorder FHIR-45015, FHIR-45082
    • removed Must Support from Procedure.asserter FHIR-45016, FHIR-45083
    • removed Must Support from Procedure.bodySite and added profile-specific implementation guidance on including body site information FHIR-45017, FHIR-45114
    • removed Must Support from Procedure.note FHIR-45114
    • removed the cardinality constraint on Procedure.performed[x], changing it from 1..1 to 0..1 FHIR-45109
    • removed Obligations on Procedure.bodySite FHIR-46728
  • Removed AU Core Provenance FHIR-45191.
  • Removed AU Core MedicationStatement and added to Future of AU Core that AU Core MedicationStatement is planned for AU Core R2 FHIR-45052.
  • Updated mapping of AUCDI Procedure Completed Event to be represented by Procedure only au-fhir-core #147.
  • Updated mapping of AUCDI Medication Use Statement to be represented by MedicationStatement only au-fhir-core #145.
  • Made the following changes to AU Core Condition:
  • Made the following changes to AU Core AllergyIntolerance:
    • removed profile-specific implementation guidance “AllergyIntolerance.verificationStatus is “unconfirmed” where a sending system does not clearly have this element or “confirmed” depending on the level of certainty” FHIR-45039
    • removed Must Support from AllergyIntolerance.asserter FHIR-44699, FHIR-45083
    • removed Must Support from AllergyIntolerance.recorder FHIR-45082, FHIR-45066
    • removed Must Support from AllergyIntolerance.encounter FHIR-45123
    • removed Must Support from AllergyIntolerance.note FHIR-45188
    • changed the AllergyIntolerance.code
      • changed Indicator of Hypersensitivity or Intolerance to Substance value set binding strength from preferred to extensible FHIR-44713
      • added Additional Binding, Adverse Reaction Substances and Negated Findings value set as candidate FHIR-44713
  • Made the following changes to AU Core Smoking Status:
    • removed Must Support from Observation.encounter FHIR-45222
    • removed Must Support from Observation.performer FHIR-45223
    • removed the fixed value constraint ‘final’ on Observation.status FHIR-45120
    • replaced Observation.code patternCodeableConcept constraint of 266918002 Tobacco smoking consumption with 1747861000168109 Smoking status FHIR-45124
    • updated invariant au-core-obs-01 to change the length check from >= 10 to >= 8 to match required precision to the day FHIR-46407
  • Removed Must Support from the following elements in AU Core Immunization:
  • Made the following changes to AU Core Blood Pressure:
    • removed Must Support from Observation.encounter FHIR-45134
    • removed Must Support from Observation.performer FHIR-44786
    • removed the fixed value constraint ‘final’ on Observation.status FHIR-45120
    • removed invariant au-core-obs-01 (duplicates invariant vs-1) FHIR-46486
  • Made the following changes to AU Core Body Height:
    • removed Must Support from Observation.encounter FHIR-45134
    • removed Must Support from Observation.performer FHIR-44786
    • removed the fixed value constraint ‘final’ on Observation.status FHIR-45120
    • removed the required binding to Metric Body Length Units value set from Observation.value[x]:valueQuantity to allow the FHIR standard profile binding, and added the Metric Body Length Units value set as a candidate additional binding FHIR-44787
    • removed invariant au-core-obs-01 (duplicates invariant vs-1) FHIR-46486
  • Made the following changes to AU Core Body Temperature:
    • removed Must Support from Observation.encounter FHIR-45134
    • removed Must Support from Observation.performer FHIR-44786
    • removed the fixed value constraint ‘final’ on Observation.status FHIR-45120
    • removed the required binding to Metric Body Temperature Units value set from Observation.value[x]:valueQuantity to allow the FHIR standard profile binding, and added the Metric Body Temperature Units value set as a candidate additional binding FHIR-44787
    • removed invariant au-core-obs-01 (duplicates invariant vs-1) FHIR-46486
  • Made the following changes to AU Core Body Weight:
    • removed Must Support from Observation.encounter FHIR-45134
    • removed Must Support from Observation.performer FHIR-44786
    • removed the fixed value constraint ‘final’ on Observation.status FHIR-45120
    • removed the required binding to Metric Body Weight Units value set from Observation.value[x]:valueQuantity to allow the FHIR standard profile binding, and added the Metric Body Weight Units value set as a candidate additional binding FHIR-44787
    • removed invariant au-core-obs-01 (duplicates invariant vs-1) FHIR-46486
  • Made the following changes to AU Core Heart Rate:
    • removed Must Support from Observation.encounter FHIR-45134
    • removed Must Support from Observation.performer FHIR-44786
    • removed the fixed value constraint ‘final’ on Observation.status FHIR-45120
    • added profile-specific implementation guidance on representing pulse rate observations FHIR-44861
    • removed invariant au-core-obs-01 (duplicates invariant vs-1) FHIR-46486
  • Made the following changes to AU Core Respiration Rate:
    • removed Must Support from Observation.encounter FHIR-45134
    • removed Must Support from Observation.performer FHIR-44786
    • removed the fixed value constraint ‘final’ on Observation.status FHIR-45120
    • removed invariant au-core-obs-01 (duplicates invariant vs-1) FHIR-46486
  • Made the following changes to AU Core Waist Circumference:
    • removed Must Support from Observation.encounter FHIR-45134
    • removed Must Support from Observation.performer FHIR-44786
    • removed the fixed value constraint ‘final’ on Observation.status FHIR-45120
    • removed the required binding to Metric Body Length Units value set from Observation.valueQuantity.code to allow the FHIR standard profile binding, and added the Metric Body Length Units value set as a candidate additional binding FHIR-44787
    • removed invariant au-core-obs-01 (duplicates invariant vs-1) FHIR-46486
  • Corrected the search parameter for gender identity to be gender-identity not patient-gender-identity FHIR-45057.
  • Clarified that multipleAnd requires comparator support for AU Core date search parameters. FHIR46309
  • Changed the following Patient search parameters:
    • birthdate search parameter support for comparators gt, le, lt, ge to be SHOULD instead of SHALL and multipleAnd support introduced as SHOULD FHIR-45410
    • _id search parameter for AU Core Requester to be SHOULD instead of SHALL FHIR-46390
  • Changed the following Organization search parameters:
    • address search parameter to be SHOULD instead of SHALL FHIR-45133
    • name search parameter to be SHOULD instead of SHALL FHIR-45133
  • Made the following changes to AU Core Diagnostic Result Observation:
    • in Observation.performer replaced RelatedPerson with AU Base RelatedPerson FHIR-45228
    • removed the required binding to ObservationStatus Result Available value set from Observation.status FHIR-45125
    • updated invariant au-core-obs-01 to change the length check from >= 10 to >= 8 to match required precision to the day FHIR-46407
    • removed constraints from Observation.hasMember.reference FHIR-46728, FHIR-48331
    • removed Must Support and Obligations from Observation.identifier, Observation.interpretation, Observation.note, Observation.method, Observation.referenceRange, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.type and Observation.referenceRange.text FHIR-46737
  • Made the following changes to AU Core Pathology Result Observation:
    • in Observation.performer replaced RelatedPerson with AU Base RelatedPerson FHIR-45228
    • removed the required binding to ObservationStatus Result Available value set from Observation.status FHIR-45125
    • updated invariant au-core-obs-01 to change the length check from >= 10 to >= 8 to match required precision to the day FHIR-46407
    • removed constraints from Observation.hasMember.reference and Observation.specimen.reference FHIR-46728, FHIR-46731
    • removed Must Support and Obligations from Observation.identifier, Observation.method and Observation.note FHIR-46732
  • Made the following changes in AU Core Requester CapabilityStatement:
    • removed reference to Bulk Data Access implementation guide FHIR-45113
    • corrected the Observation combined search parameter ‘patient+category+status’ from SHALL to SHOULD FHIR-45390
    • corrected narrative of Location identifier parameter requester requirements on providing both the system and code values from SHOULD to MAY FHIR-46209
    • replaced security and authorization requirements with pointer to Security and Privacy page FHIR-46067
    • added missing entries for DocumentReference and RelatedPerson resources FHIR-46546
  • Made the following changes in AU Core Responder CapabilityStatement:
    • removed reference to Bulk Data Access implementation guide FHIR-45113
    • corrected the Observation combined search parameter ‘patient+category+status’ from SHALL to SHOULD FHIR-45390
    • corrected MedicationRequest combined search parameter ‘patient+intent+authoredon’ from SHALL to SHOULD FHIR-46167
    • corrected narrative of Location identifier parameter requester requirements on providing both the system and code values from SHOULD to MAY FHIR-46209
    • replaced security and authorization requirements with pointer to Security and Privacy page FHIR-46067
    • corrected narrative of PractitionerRole practitioner.identifier search parameter from Medicare Provider Number to HPI-I FHIR-47013
    • corrected support for Practitioner _id search parameter to be SHOULD instead of SHALL FHIR-46777
    • added missing entries for DocumentReference and RelatedPerson resources FHIR-46546