Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Questionnaire: AIR - Overseas, Historic, Not Done

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/Questionnaire/ImmsotVaccinationDataEntryQuestionnaire | Version: 0.4.5
Draft as of 2026-03-03 | Computable Name:
Other Identifiers: ImmsotVaccinationDataEntryQuestionnaire (use: usual, period: 7/5/23 --> (ongoing))

Submit an overseas, historic, or not-done vaccination to AIR

Structure

LinkID | Text | Cardinality | Type | Flags | Description & Constraints
--- | --- | --- | --- | --- | ---
| Submit an overseas, historic, or not-done vaccination to AIR |  | Questionnaire |  | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/Questionnaire/ImmsotVaccinationDataEntryQuestionnaire#0.4.5
p01-Immunisation | page 1. Page 1 | 0..1 | group |  |
p01-q01-Type | page 1 question 1. Type of vaccination | 1..1 | choice |  | Options: 3 options
p01-q02-StatusCompleted | page 1 question 2. Extract - Status completed | 1..1 | string |  | Definition: Immunization.status Enable When: p01-q01-Type = p01-q01-Type = Initial Value: string = completed
p01-q03-StatusNotDone | page 1 question 3. Extract - Status not done | 0..1 | string |  | Definition: Immunization.status Enable When: p01-q01-Type = Initial Value: string = not-done
p01-q04-StatusReasonOverseas | page 1 question 4. Extract - Status reason | 0..1 | choice |  | Definition: Immunization.statusReason.coding[] Enable When: p01-q01-Type = Initial Value: Coding = air-status-reason-terms#GIVNOS "Given overseas"
p01-q05-StatusReasonHistoric | page 1 question 5. Extract - Status reason | 0..1 | choice |  | Definition: Immunization.statusReason.coding[] Enable When: p01-q01-Type = Initial Value: Coding = air-status-reason-terms#HSTGIVN "Given historically"
p01-q06-StatusReasonNotDone | page 1 question 6. Status reason | 1..1 | choice |  | Definition: Immunization.statusReason.coding[] Enable When: p01-q01-Type = Options: 4 options
p01-q07-FacilityOverseas | page 1 question 7. Extract - Overseas facility | 0..1 | choice |  | Definition: Immunization.location Enable When: p01-q01-Type = Initial Value: Coding = [not stated]#F3R789-A "NIR Overseas Clinic"
p01-q08-FacilityHistoric | page 1 question 8. Extract - Historic facility | 0..1 | choice |  | Definition: Immunization.location Enable When: p01-q01-Type = p01-q01-Type = Initial Value: Coding = [not stated]#F3R790-H "NIR Unknown NZ Clinic"
p01-q09-Antigens | page 1 question 9. Vaccine antigens | 1..1 | choice |  | Definition: Immunization.vaccineCode.coding[] Enable When: p01-q01-Type exists Options: 82 options
p01-q10-DoseNumber | page 1 question 10. Dose number | 0..1 | integer |  | Definition: Immunization.protocolApplied[].doseNumberPositiveInt Enable When: p01-q01-Type = p01-q01-Type =
p01-q11-DoseNumber | page 1 question 11. Dose number | 1..1 | integer |  | Definition: Immunization.protocolApplied[].doseNumberPositiveInt Enable When: p01-q01-Type =
p01-q12-Indication | page 1 question 12. Indication (reason code) | 1..1 | choice |  | Definition: Immunization.reasonCode[].coding[] Enable When: p01-q01-Type exists Options: 33 options
p01-q13-DateAdministered | page 1 question 13. Date vaccine administered | 1..1 | date |  | Definition: Immunization.occurrenceDateTime Enable When: p01-q01-Type = p01-q01-Type =
p01-q14-DateNotDone | page 1 question 14. Date vaccine determined as not done | 1..1 | date |  | Definition: Immunization.occurrenceDateTime Enable When: p01-q01-Type =
p01-q15-SubjectMeta | page 1 question 15. null | 0..1 | boolean |  | Initial Value: boolean = true
Documentation for this format

Options Sets

Answer options for p01-q01-Type

- null#Overseas ("Overseas")
- null#Historic ("Historic")
- null#Not done ("Not done")

Answer options for p01-q06-StatusReasonNotDone

- https://standards.digital.health.nz/ns/air-status-reason-terms#DPC ("Declined by parent/guardian")
- https://standards.digital.health.nz/ns/air-status-reason-terms#DIC ("Declined by individual")
- https://standards.digital.health.nz/ns/air-status-reason-terms#DMC ("Permanent contraindication")
- https://standards.digital.health.nz/ns/air-status-reason-terms#DNI ("Immune")

Answer options for p01-q09-Antigens

- http://hl7.org/fhir/sid/cvx#03 ("03 - MMR")
- http://hl7.org/fhir/sid/cvx#05 ("05 - Measles")
- http://hl7.org/fhir/sid/cvx#06 ("06 - Rubella")
- http://hl7.org/fhir/sid/cvx#08 ("08 - HepB")
- http://hl7.org/fhir/sid/cvx#09 ("09 - Td")
- http://hl7.org/fhir/sid/cvx#10 ("10 - IPV")
- http://hl7.org/fhir/sid/cvx#19 ("19 - BCG")
- http://hl7.org/fhir/sid/cvx#20 ("20 - DTaP")
- http://hl7.org/fhir/sid/cvx#21 ("21 - VV")
- http://hl7.org/fhir/sid/cvx#22 ("22 - DTP-Hib")
- http://hl7.org/fhir/sid/cvx#25 ("25 - Typhoid")
- http://hl7.org/fhir/sid/cvx#26 ("26 - Cholera")
- http://hl7.org/fhir/sid/cvx#28 ("28 - DT")
- http://hl7.org/fhir/sid/cvx#30 ("30 - HBIG")
- http://hl7.org/fhir/sid/cvx#33 ("33 - 23PPV")
- http://hl7.org/fhir/sid/cvx#35 ("35 - Tetanus")
- http://hl7.org/fhir/sid/cvx#37 ("37 - YFV")
- http://hl7.org/fhir/sid/cvx#39 ("39 - JEV")
- http://hl7.org/fhir/sid/cvx#43 ("43 - HepB")
- http://hl7.org/fhir/sid/cvx#44 ("44 - HepB")
- http://hl7.org/fhir/sid/cvx#48 ("48 - Hib-PRP-T")
- http://hl7.org/fhir/sid/cvx#50 ("50 - DTaP-Hib")
- http://hl7.org/fhir/sid/cvx#51 ("51 - Hib-HepB")
- http://hl7.org/fhir/sid/cvx#52 ("52 - HepA")
- http://hl7.org/fhir/sid/cvx#56 ("56 - Dengue")
- http://hl7.org/fhir/sid/cvx#62 ("62 - HPV4")
- http://hl7.org/fhir/sid/cvx#75 ("75 - MPX")
- http://hl7.org/fhir/sid/cvx#83 ("83 - HepA")
- http://hl7.org/fhir/sid/cvx#100 ("100 - PCV7")
- http://hl7.org/fhir/sid/cvx#101 ("101 - Typhoid")
- http://hl7.org/fhir/sid/cvx#103 ("103 - MenC")
- http://hl7.org/fhir/sid/cvx#104 ("104 - HepB-HepA")
- http://hl7.org/fhir/sid/cvx#110 ("110 - DTaP-IPV-HepB")
- http://hl7.org/fhir/sid/cvx#114 ("114 - MenACWY")
- http://hl7.org/fhir/sid/cvx#115 ("115 - Tdap")
- http://hl7.org/fhir/sid/cvx#116 ("116 - RV5")
- http://hl7.org/fhir/sid/cvx#118 ("118 - HPV2")
- http://hl7.org/fhir/sid/cvx#119 ("119 - RV1")
- http://hl7.org/fhir/sid/cvx#120 ("120 - DTaP-IPV-Hib")
- http://hl7.org/fhir/sid/cvx#121 ("121 - rZV")
- http://hl7.org/fhir/sid/cvx#127 ("127 - Influenza A (H1N1)")
- http://hl7.org/fhir/sid/cvx#130 ("130 - DTaP-IPV")
- http://hl7.org/fhir/sid/cvx#133 ("133 - PCV13")
- http://hl7.org/fhir/sid/cvx#134 ("134 - JEV")
- http://hl7.org/fhir/sid/cvx#150 ("150 - Influenza")
- http://hl7.org/fhir/sid/cvx#160 ("160 - Influenza A (H5N1)")
- http://hl7.org/fhir/sid/cvx#161 ("161 - Influenza")
- http://hl7.org/fhir/sid/cvx#163 ("163 - MenB")
- http://hl7.org/fhir/sid/cvx#165 ("165 - HPV9")
- http://hl7.org/fhir/sid/cvx#182 ("182 - OPV")
- http://hl7.org/fhir/sid/cvx#187 ("187 - rZV")
- http://hl7.org/fhir/sid/cvx#202 ("202 - Influenza")
- http://hl7.org/fhir/sid/cvx#205 ("205 - Influenza")
- http://hl7.org/fhir/sid/cvx#208 ("208 - COVID-19")
- http://hl7.org/fhir/sid/cvx#210 ("210 - COVID-19")
- http://hl7.org/fhir/sid/cvx#211 ("211 - COVID-19")
- http://hl7.org/fhir/sid/cvx#217 ("217 - COVID-19")
- http://hl7.org/fhir/sid/cvx#218 ("218 - COVID-19")
- http://hl7.org/fhir/sid/cvx#219 ("219 - COVID-19")
- http://hl7.org/fhir/sid/cvx#222 ("222 - TBE")
- http://hl7.org/fhir/sid/cvx#300 ("300 - COVID-19")
- http://hl7.org/fhir/sid/cvx#303 ("303 - RSV")
- http://hl7.org/fhir/sid/cvx#500 ("500 - COVID-19")
- https://standards.digital.health.nz/ns/immunisation-code#52101 ("52101 - HepA-Typhoid")
- https://standards.digital.health.nz/ns/immunisation-code#090306 ("090306 - PCV unspecified")
- https://standards.digital.health.nz/ns/immunisation-code#90906 ("90906 - Td")
- https://standards.digital.health.nz/ns/immunisation-code#99001 ("99001 - DTaP-IPV")
- https://standards.digital.health.nz/ns/immunisation-code#99002 ("99002 - MeNZB")
- https://standards.digital.health.nz/ns/immunisation-code#99003 ("99003 - Diphtheria, paed")
- https://standards.digital.health.nz/ns/immunisation-code#99004 ("99004 - aP")
- https://standards.digital.health.nz/ns/immunisation-code#99005 ("99005 - Diphtheria, adult")
- https://standards.digital.health.nz/ns/immunisation-code#99006 ("99006 - Influenza")
- https://standards.digital.health.nz/ns/immunisation-code#99007 ("99007 - HepA")
- https://standards.digital.health.nz/ns/immunisation-code#99008 ("99008 - MenACWY")
- https://standards.digital.health.nz/ns/immunisation-code#99009 ("99009 - Rabies")
- https://standards.digital.health.nz/ns/immunisation-code#99010 ("99010 - RIG")
- https://standards.digital.health.nz/ns/immunisation-code#99011 ("99011 - Tdap-IPV")
- https://standards.digital.health.nz/ns/immunisation-code#99012 ("99012 - Tdap")
- https://standards.digital.health.nz/ns/immunisation-code#99013 ("99013 - MenC")
- https://standards.digital.health.nz/ns/immunisation-code#210307 ("210307 - DTaP-IPV-HepB/Hib")
- https://standards.digital.health.nz/ns/immunisation-code#260209 ("260209 - PCV10")
- https://standards.digital.health.nz/ns/immunisation-code#EVPMnC ("EVPMnC - MenC")

Answer options for p01-q12-Indication

- https://standards.digital.health.nz/ns/air-terms-code#1 ("Influenza, eligible over 65 years")
- https://standards.digital.health.nz/ns/air-terms-code#2 ("Influenza, eligible under 18 years")
- https://standards.digital.health.nz/ns/air-terms-code#3 ("Influenza, eligible criteria")
- https://standards.digital.health.nz/ns/air-terms-code#4 ("Sexual or household contact")
- https://standards.digital.health.nz/ns/air-terms-code#5 ("Primary course")
- https://standards.digital.health.nz/ns/air-terms-code#6 ("Booster")
- https://standards.digital.health.nz/ns/air-terms-code#7 ("Post partum")
- https://standards.digital.health.nz/ns/air-terms-code#8 ("Low birth weight")
- https://standards.digital.health.nz/ns/air-terms-code#9 ("HepB carrier mother")
- https://standards.digital.health.nz/ns/air-terms-code#10 ("At risk for TB")
- https://standards.digital.health.nz/ns/air-terms-code#11 ("Pre-post splenectomy schedule")
- https://standards.digital.health.nz/ns/air-terms-code#12 ("At risk, no previous history")
- https://standards.digital.health.nz/ns/air-terms-code#13 ("At risk, previous PCV history")
- https://standards.digital.health.nz/ns/air-terms-code#14 ("At risk, previous 23PPV")
- https://standards.digital.health.nz/ns/air-terms-code#15 ("Pre-emergency")
- https://standards.digital.health.nz/ns/air-terms-code#16 ("Pregnant")
- https://standards.digital.health.nz/ns/air-terms-code#21 ("PCV catch up")
- https://standards.digital.health.nz/ns/air-terms-code#Pre ("Pre-primary course")
- https://standards.digital.health.nz/ns/air-terms-code#Stn ("Funded, if not otherwise specified")
- https://standards.digital.health.nz/ns/air-terms-code#6W ("6 weeks")
- https://standards.digital.health.nz/ns/air-terms-code#3M ("3 months")
- https://standards.digital.health.nz/ns/air-terms-code#5M ("5 months")
- https://standards.digital.health.nz/ns/air-terms-code#12M ("12 months")
- https://standards.digital.health.nz/ns/air-terms-code#15M ("15 months")
- https://standards.digital.health.nz/ns/air-terms-code#4Y ("4 years")
- https://standards.digital.health.nz/ns/air-terms-code#11Y ("11 years")
- https://standards.digital.health.nz/ns/air-terms-code#14Y ("14 years")
- https://standards.digital.health.nz/ns/air-terms-code#45Y ("45 years")
- https://standards.digital.health.nz/ns/air-terms-code#65Y ("65 years")
- https://standards.digital.health.nz/ns/air-terms-code#96 ("HepB high risk, booster or extra dose")
- https://standards.digital.health.nz/ns/air-terms-code#TPW ("Tetanus-prone wound")
- https://standards.digital.health.nz/ns/air-terms-code#5P ("Privately funded, primary course")
- https://standards.digital.health.nz/ns/air-terms-code#6P ("Privately funded, booster")