Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v2.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Example Bundle: AIR Orchestration Service Immunisation Bundle Example

Bundle AIRBundleOrchestrationExample of type searchset


Entry 1 - fullUrl = https://air.api-dev.digital.health.nz/fhir/R4/Immunization/a757a62c-ef57-4480-85de-ac012a1ee1a9

Search:Mode = match

Resource Immunization:

version: 1; Last updated: 2023-03-01 16:45:46+1300

Profile: https://standards.digital.health.nz/fhir/air/StructureDefinition/orch-immunization

Immunization Diluent

  • diluentLotNumber: 33332222
  • diluentExpiryDate: 2026-01-01

mobileSiteId: FZZ958-K_MOB0001

AIR Administered Product Extension: M-M-R-II

AIR Age Given Extension

  • years: 1
  • months: 2
  • days: 22
  • daysSinceBirth: 445
  • precision: Day

status: Completed

statusReason: Active or passive immunisation

vaccineCode: MMR

lotNumber: 1234567

expirationDate: 2025-07-21

patient: BABY OF TESTING NEWMUM Female, DoB: 2015-09-09 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZAA0792 (use: official, ))

occurrence: 2016-12-02 13:21:46+1300

location: Location Medical Centre Flat-Unit

site: Structure of left deltoid muscle

route: Intramuscular route

Performers

-FunctionActor
*VaccinatorPractitioner: identifier = https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#90ZZLP (use: official, )

ProtocolApplieds

-TargetDisease
*14189004

patient: https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ9994

relationship: mother

name: Jane Jess Test-Dill

telecom: ph: 041111111(Home), ph: 091111111(Work), jadill@test.mail

address: 456 Main St Suite 256 Hamilton 1111 (home) (NZ Suburb: ccc)


status: Final

code: 278969009

interpretation: Indeterminate


Entry 2 - fullUrl = https://air.api-dev.digital.health.nz/fhir/R4/Immunization/b868b73d-ef57-4480-85de-ac012a1ee1a9

Search:Mode = match

Resource Immunization:

version: null; Last updated: 2023-03-01 16:45:46+1300

Profile: https://standards.digital.health.nz/fhir/air/StructureDefinition/orch-immunization

Immunization Diluent

  • diluentLotNumber: 33332222
  • diluentExpiryDate: 2026-01-01

mobileSiteId: FZZ958-K_MOB0001

AIR Administered Product Extension: M-M-R-II

AIR Age Given Extension

  • years: 0
  • months: 11
  • days: 20
  • daysSinceBirth: 355
  • precision: Day

status: Completed

statusReason: Active or passive immunisation

vaccineCode: MMR

lotNumber: ABCDEFG

expirationDate: 2024-08-11

patient: BABY OF TESTING NEWMUM Female, DoB: 2015-09-09 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZAA0792 (use: official, ))

occurrence: 2016-09-01 16:45:46+1300

location: Location Medical Centre Flat-Unit

site: Structure of left deltoid muscle

route: Intramuscular route

Performers

-FunctionActor
*VaccinatorPractitioner: identifier = https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#90ZZLP (use: official, )

ProtocolApplieds

-TargetDisease
*14189004

Entry 3 - fullUrl = https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZAA0792

Search:Mode = include

Resource Patient:

BABY OF TESTING NEWMUM Female, DoB: 2015-09-09 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZAA0792 (use: official, ))


Other Id:NHI/ZAA0806 (use: old, )
Contact Detail
  • Rue Mtsangani Bandrele 0606 (home) (NZ Suburb: Moutsamoudou)
  • 147 Quay Street Auckland 1010 NZ (home) (NZ Suburb: Auckland Central)
null:
  • source: HL7 applied
  • status: Permanent Resident
NZ Citizenship:
  • status: The citizenship status is unknown
NZ EthnicityNew Zealand European

Entry 4 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP

Search:Mode = include

Resource Practitioner:

identifier: HPIProvider/90ZZLP (use: official, )


Entry 5 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K

Search:Mode = include

Resource Location:

version: 10803; Last updated: 2022-11-09 12:00:14+1300

Profile: http://hl7.org.nz/fhir/StructureDefinition/HPILocation

Established: 1980-12-12 --> (ongoing)

identifier: HPIFacility/FZZ958-K (use: official, ), HPIFacility/9987 (use: official, )

status: Active

name: Medical Centre Flat-Unit

alias: Medical Centre Flat-Unit

type: Enrolling GP Practice

address: 2C/123 Molesworth Street, Thorndon, Wellington 6011(work) (NZ Suburb: Wellington 6011)

managingOrganization: Flat-Unit Address Org