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 IGs

A resource conforming to this profile is conformant to:

• IPA-Immunization
• and MAY be conformant to
  • Immunization (IPS) if patient is supported as Immunization.patient.reference
  • US Core Immunization noting that US Core extensibly binds to CVX which is not an AU vaccine terminology

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.

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU Core interactions is defined 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.

Mandatory Search Parameters:

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

1. SHALL support searching using the patient search parameter:
   • 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)