AU Core Implementation Guide
0.3.0-ballot - R1 Australia flag

This page is part of the AU Core (v0.3.0-ballot: AU Core R1 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Immunization

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-immunization Version: 0.3.0-ballot
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreImmunization

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

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

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for a patient’s immunisations
  • Record or update an immunisation record for a patient

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • Use the status code: not-done to represent that an immunization was not given.

Feedback is requested on the proposals to remove Must Support from the following elements:

  • Immunization.performer and its children: please comment on FHIR-44653.
  • Immunization.note: please comment on HL7 JIRA FHIR-44672.
  • Immunization.reasonCode: please comment on HL7 JIRA Comment on FHIR-44654.
  • Immunization.protocolApplied.series: please comment on HL7 JIRA FHIR-44656.
  • Immunization.protocolApplied.targetDisease: please comment on HL7 JIRA FHIR-44654.
  • Immunization.protocolApplied.doseNumber: please comment on HL7 JIRA FHIR-44674.

Feedback is requested on the proposals to add Must Support to the following elements:

  • Immunization.primarySource: please comment on HL7 JIRA FHIR-44659.
  • Immunization.location: please comment on HL7 JIRA FHIR-44671.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AUBaseImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*AUBaseImmunisationAn immunisation statement in an Australian healthcare context
... status S1..1codecompleted | entered-in-error | not-done
... vaccineCode S1..1CodeableConceptVaccine product administered
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:amtVaccineCode S0..1CodingAMT Vaccine
..... coding:airVaccineCode S0..1CodingAIR Vaccine
... patient S1..1Reference(AU Core Patient)Who was immunized
... occurrence[x] S1..1dateTime, stringVaccine administration date
... performer S0..*BackboneElementWho performed event
.... function S0..1CodeableConceptWhat type of performance was done
.... actor S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Individual or organization who was performing
... note S0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy immunization occurred
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... series S0..1stringName of vaccine series
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
.... doseNumber[x] S1..1positiveInt, stringDose number within series

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both
patient+status SHALL reference+token
patient+date SHOULD reference+date
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both.

The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
date MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
patient+vaccine-code MAY reference+token
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
vaccine-code MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the patient search parameter:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Immunization?patient={Type/}[id] or optionallyGET [base]/Immunization?patient.identifier=[system|][code]

    Example:

    1. GET [base]/Immunization?patient=5678
    2. GET [base]/Immunization?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/Immunization?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

    Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and status search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Immunization?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Immunization?patient=5678&status=not-done

    Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient and status (how to search by reference and how to search by token)

Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and date search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Immunization?patient={Type/}[id]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Immunization?patient=5678&date=ge2020-01-01T00:00:00Z
    2. GET [base]/Immunization?patient.identifier=http://example.org/fhir/mrn|12345&date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient and date (how to search by reference and how to search by date)

  2. SHOULD support searching using the combination of the patient and vaccine-code search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
    • SHOULD support multipleOr search on vaccine-code (e.g.vaccine-code={system|}[code],{system|}[code],...)

    GET [base]/Immunization?patient={Type/}[id]&vaccine-code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Immunization?patient=5678&vaccine-code=https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats|COMIRN,http://snomed.info/sct|1525011000168107
    2. GET [base]/Immunization?patient.identifier=http://example.org/fhir/mrn|12345&vaccine-code=https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats|COMIRN,http://snomed.info/sct|1525011000168107

    Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient and immunization code(s). SHOULD support search by multiple codes. (how to search by reference and how to search by token)