Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build
New Zealand
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
| Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs | Version: 2.7.0 | |||
| Active as of 2026-07-20 | Computable Name: AIRAGVS | |||
This extension to the AIR ImmunizationRecommendation profile is used to convey information about the antigen group vaccination schedule associated with a Scheduled Event, including the schedule type, the series type, the antigen group, and the version.
Context of Use
This extension may be used on the following element(s)
ImmunizationRecommendation.recommendation
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | AIR Antigen Group Vaccination Schedule | |
  extension |
4..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:schedule-type |
1..1 | Extension | Extension | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "schedule-type" | |
  value[x] |
0..1 | Coding | Value of extension | |
| extension:series-type |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "series-type" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:antigen-group |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "antigen-group" | |
| value[x] |
0..1 | Coding | Value of extension | |
 extension:version |
1..1 | Extension | Extension | |
 extension |
0..0 | Extension | ||
| url |
1..1 | uri | "version" | |
 value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs" | |
 value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Antigen Group Vaccination Schedule | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:schedule-type |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "schedule-type" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:series-type |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "series-type" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:antigen-group |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "antigen-group" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:version |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "version" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: This extension to the AIR ImmunizationRecommendation profile is used to convey information about the antigen group vaccination schedule associated with a Scheduled Event, including the schedule type, the series type, the antigen group, and the version.
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Antigen Group Vaccination Schedule | |
| extension |
4..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:schedule-type |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "schedule-type" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:series-type |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "series-type" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:antigen-group |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "antigen-group" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:version |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "version" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Antigen Group Vaccination Schedule | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:schedule-type |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "schedule-type" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:series-type |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "series-type" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:antigen-group |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "antigen-group" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:version |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "version" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: This extension to the AIR ImmunizationRecommendation profile is used to convey information about the antigen group vaccination schedule associated with a Scheduled Event, including the schedule type, the series type, the antigen group, and the version.
Other representations of profile: CSV, Excel, Schematron
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|