NZ Shared Digital Health Record API
1.1.3 - release
NZ Shared Digital Health Record API
1.1.3 - release
NZ Shared Digital Health Record API - Local Development build (v1.1.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRImmunization | Version: 1.1.3 | |||
| Draft as of 2026-08-12 | Computable Name: SDHRImmunization | |||
Immunization resource for the Shared Digital Health Record. This profile constrains AIR Immunization content to the subset required for direct clinical care.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Immunization |
C | 0..* | AIRImmunization | Immunization event information Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1, sdhr-imm-status-1 |
  id |
Σ | 1..1 | id | Unique identifier for the immunization event assigned by ImmSOT |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
   extension:administeredProduct |
0..1 | CodeableConcept | AIR Administered Product Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product Binding: AIR Administered Product Code  (required) | |
 extension:AgeGiven |
0..1 | (Complex) | AIR Age Given Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given | |
| status |
?!Σ | 1..1 | code | Status of the immunization event Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
 statusReason |
0..1 | CodeableConcept | Reason for the immunization event status Binding: AIR Status Reason Code (preferred) | |
 coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: AIR Vaccine Product (preferred) |
 extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
 coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
 extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
 patient |
Σ | 1..1 | Reference(Patient) | NHI of the person who was immunized |
| occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date |
| location |
0..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location) | Facility where the immunization event occurred | |
| display |
Σ | 0..1 | string | Facility name supplied by SDHR from the included AIR Location |
| lotNumber |
0..1 | string | Vaccine batch or lot number | |
| expirationDate |
0..1 | date | Vaccine batch expiry date | |
| site |
0..1 | CodeableConcept | Body site where the vaccine was administered Binding: AIR Body Site (preferred) | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| route |
0..1 | CodeableConcept | Route by which the vaccine was administered Binding: AIR Route of Administration (preferred) | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| reasonCode |
0..* | CodeableConcept | Clinical or funding indication for the immunization Binding: AIR Indication Code (preferred) | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition, observation, or report supporting the indication | |
| protocolApplied |
0..1 | BackboneElement | Protocol followed by the provider | |
| targetDisease |
0..* | CodeableConcept | Vaccine-preventable disease targeted by this dose Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |
| doseNumber[x] |
1..1 | positiveInt | Dose number administered | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | preferred |
AIR Status Reason Code
|
⏿2.0.0 | nzhts.digital.health.nz |
| Immunization.vaccineCode | Base | preferred |
AIR Vaccine Product
|
⏿2.0.1 | nzhts.digital.health.nz |
| Immunization.site | Base | preferred |
AIR Body Site
|
⏿2.0.0 | nzhts.digital.health.nz |
| Immunization.route | Base | preferred |
AIR Route of Administration
|
⏿2.0.0 | nzhts.digital.health.nz |
| Immunization.reasonCode | Base | preferred |
AIR Indication Code
|
⏿2.0.1 | nzhts.digital.health.nz |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| air-resched-1 | error | Immunization | Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling. |
extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()
|
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| nz-performer-function-1 | error | Immunization | If the performer function has a system, then it must have a code. |
performer.function.coding.system.exists() implies performer.function.coding.code.exists()
|
| nz-performer-function-2 | error | Immunization | If the performer function has a code, then it must have a system. |
performer.function.coding.code.exists() implies performer.function.coding.system.exists()
|
| nz-reasonCode-1 | error | Immunization | If the reasonCode aka indication has a system, then it must have a code. |
reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()
|
| nz-reasonCode-2 | error | Immunization | If the reasonCode aka indication has a code, then it must have a system. |
reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()
|
| nz-route-1 | error | Immunization | If the route of admin has a system, then it must have a code. |
route.coding.system.exists() implies route.coding.code.exists()
|
| nz-route-2 | error | Immunization | if the route of admin has a code, then it must have a system. |
route.coding.code.exists() implies route.coding.system.exists()
|
| nz-site-1 | error | Immunization | If the body site has a system, then it must have a code. |
site.coding.system.exists() implies site.coding.code.exists()
|
| nz-site-2 | error | Immunization | If the body site has a code, then it must have a system. |
site.coding.code.exists() implies site.coding.system.exists()
|
| nz-status-reason-1 | error | Immunization | If the status reason has a system, then it must have a code. |
statusReason.coding.system.exists() implies statusReason.coding.code.exists()
|
| nz-status-reason-2 | error | Immunization | If the status reason has a code, then it must have a system. |
statusReason.coding.code.exists() implies statusReason.coding.system.exists()
|
| sdhr-imm-status-1 | error | Immunization | SDHR does not return immunization records that AIR has marked as entered in error. |
status != 'entered-in-error'
|
This structure is derived from AIRImmunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
C | 0..* | AIRImmunization | Immunization event information Constraints: sdhr-imm-status-1 |
 id |
1..1 | id | Unique identifier for the immunization event assigned by ImmSOT | |
| meta |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:DataQualityAssessment |
0..0 | Data Quality Assessment | ||
| extension:PlannedEventMatch |
0..0 | Planned Event Match | ||
| extension:PlannedEventMatchQuality |
0..0 | Planned Event Match Quality | ||
| extension:CreatedBy |
0..0 | AIR Created By User | ||
| extension:ModifiedBy |
0..0 | AIR Modified By User | ||
| source |
0..0 | Identifies where the resource comes from | ||
| profile |
0..0 | Profiles this resource claims to conform to | ||
| tag |
0..0 | Tags applied to this resource | ||
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:Diluent |
0..0 | Immunization Diluent | ||
| extension:MobileSiteId |
0..0 | Immunization Facility Mobile Site | ||
| extension:relatedPersonExtension |
0..0 | AIR Related Person | ||
| extension:serologyReportExtension |
0..0 | AIR Serology Report Extension | ||
| extension:rescheduleDateExtension |
0..0 | AIR Reschedule Date Extension | ||
 modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | Business identifier | ||
| status |
1..1 | code | Status of the immunization event | |
| statusReason |
0..1 | CodeableConcept | Reason for the immunization event status | |
| vaccineCode |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| coding |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| version |
0..0 | Version of the system - if relevant | ||
| patient |
1..1 | Reference(Patient) | NHI of the person who was immunized | |
| display |
0..0 | Text alternative for the resource | ||
| recorded |
0..0 | When the immunization was first captured in the subject's record | ||
| location |
0..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location) | Facility where the immunization event occurred | |
| display |
0..1 | string | Facility name supplied by SDHR from the included AIR Location | |
| lotNumber |
0..1 | string | Vaccine batch or lot number | |
| expirationDate |
0..1 | date | Vaccine batch expiry date | |
| site |
0..1 | CodeableConcept | Body site where the vaccine was administered | |
| route |
0..1 | CodeableConcept | Route by which the vaccine was administered | |
| performer |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| function |
0..1 | CodeableConcept | Role performed by the vaccinator | |
| actor |
1..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner) | Identifier or reference for the vaccinator | |
| reasonCode |
0..* | CodeableConcept | Clinical or funding indication for the immunization | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition, observation, or report supporting the indication | |
| protocolApplied |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| series |
0..0 | Name of vaccine series | ||
| authority |
0..0 | Who is responsible for publishing the recommendations | ||
| targetDisease |
0..* | CodeableConcept | Vaccine-preventable disease targeted by this dose | |
| doseNumber[x] |
1..1 | positiveInt | Dose number administered | |
| seriesDoses[x] |
0..0 | Recommended number of doses for immunity | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| sdhr-imm-status-1 | error | Immunization | SDHR does not return immunization records that AIR has marked as entered in error. |
status != 'entered-in-error'
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
C | 0..* | AIRImmunization | Immunization event information Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1, sdhr-imm-status-1 |
| id |
Σ | 1..1 | id | Unique identifier for the immunization event assigned by ImmSOT |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:CreatedSourceSystem |
0..1 | string | AIR Created Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system | |
| extension:ModifiedSourceSystem |
0..1 | string | AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system | |
| extension:CreatedDate |
0..1 | instant | The instant when this resource ID was first associated with content on this server URL: http://hl7.org/fhir/StructureDefinition/firstCreated | |
| versionId |
Σ | 0..1 | id | Version specific identifier |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:administeredProduct |
0..1 | CodeableConcept | AIR Administered Product Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product Binding: AIR Administered Product Code (required) | |
| extension:AgeGiven |
0..1 | (Complex) | AIR Age Given Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given | |
| status |
?!Σ | 1..1 | code | Status of the immunization event Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
| statusReason |
0..1 | CodeableConcept | Reason for the immunization event status Binding: AIR Status Reason Code (preferred) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: AIR Vaccine Product (preferred) |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| patient |
Σ | 1..1 | Reference(Patient) | NHI of the person who was immunized |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date |
| location |
0..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location) | Facility where the immunization event occurred | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Facility name supplied by SDHR from the included AIR Location |
| lotNumber |
0..1 | string | Vaccine batch or lot number | |
| expirationDate |
0..1 | date | Vaccine batch expiry date | |
| site |
0..1 | CodeableConcept | Body site where the vaccine was administered Binding: AIR Body Site (preferred) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| route |
0..1 | CodeableConcept | Route by which the vaccine was administered Binding: AIR Route of Administration (preferred) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| performer |
Σ | 0..* | BackboneElement | Who performed event |
| function |
Σ | 0..1 | CodeableConcept | Role performed by the vaccinator Binding: AIR Performer Health Worker Function (extensible) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| actor |
Σ | 1..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner) | Identifier or reference for the vaccinator |
| reasonCode |
0..* | CodeableConcept | Clinical or funding indication for the immunization Binding: AIR Indication Code (preferred) | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition, observation, or report supporting the indication | |
| protocolApplied |
0..1 | BackboneElement | Protocol followed by the provider | |
| targetDisease |
0..* | CodeableConcept | Vaccine-preventable disease targeted by this dose Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |
| doseNumber[x] |
1..1 | positiveInt | Dose number administered | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| air-resched-1 | error | Immunization | Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling. |
extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()
|
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| nz-performer-function-1 | error | Immunization | If the performer function has a system, then it must have a code. |
performer.function.coding.system.exists() implies performer.function.coding.code.exists()
|
| nz-performer-function-2 | error | Immunization | If the performer function has a code, then it must have a system. |
performer.function.coding.code.exists() implies performer.function.coding.system.exists()
|
| nz-reasonCode-1 | error | Immunization | If the reasonCode aka indication has a system, then it must have a code. |
reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()
|
| nz-reasonCode-2 | error | Immunization | If the reasonCode aka indication has a code, then it must have a system. |
reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()
|
| nz-route-1 | error | Immunization | If the route of admin has a system, then it must have a code. |
route.coding.system.exists() implies route.coding.code.exists()
|
| nz-route-2 | error | Immunization | if the route of admin has a code, then it must have a system. |
route.coding.code.exists() implies route.coding.system.exists()
|
| nz-site-1 | error | Immunization | If the body site has a system, then it must have a code. |
site.coding.system.exists() implies site.coding.code.exists()
|
| nz-site-2 | error | Immunization | If the body site has a code, then it must have a system. |
site.coding.code.exists() implies site.coding.system.exists()
|
| nz-status-reason-1 | error | Immunization | If the status reason has a system, then it must have a code. |
statusReason.coding.system.exists() implies statusReason.coding.code.exists()
|
| nz-status-reason-2 | error | Immunization | If the status reason has a code, then it must have a system. |
statusReason.coding.code.exists() implies statusReason.coding.system.exists()
|
| sdhr-imm-status-1 | error | Immunization | SDHR does not return immunization records that AIR has marked as entered in error. |
status != 'entered-in-error'
|
This structure is derived from AIRImmunization
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
C | 0..* | AIRImmunization | Immunization event information Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1, sdhr-imm-status-1 |
| id |
Σ | 1..1 | id | Unique identifier for the immunization event assigned by ImmSOT |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:administeredProduct |
0..1 | CodeableConcept | AIR Administered Product Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product Binding: AIR Administered Product Code (required) | |
| extension:AgeGiven |
0..1 | (Complex) | AIR Age Given Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given | |
| status |
?!Σ | 1..1 | code | Status of the immunization event Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
| statusReason |
0..1 | CodeableConcept | Reason for the immunization event status Binding: AIR Status Reason Code (preferred) | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: AIR Vaccine Product (preferred) |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| patient |
Σ | 1..1 | Reference(Patient) | NHI of the person who was immunized |
| occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date |
| location |
0..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location) | Facility where the immunization event occurred | |
| display |
Σ | 0..1 | string | Facility name supplied by SDHR from the included AIR Location |
| lotNumber |
0..1 | string | Vaccine batch or lot number | |
| expirationDate |
0..1 | date | Vaccine batch expiry date | |
| site |
0..1 | CodeableConcept | Body site where the vaccine was administered Binding: AIR Body Site (preferred) | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| route |
0..1 | CodeableConcept | Route by which the vaccine was administered Binding: AIR Route of Administration (preferred) | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| reasonCode |
0..* | CodeableConcept | Clinical or funding indication for the immunization Binding: AIR Indication Code (preferred) | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition, observation, or report supporting the indication | |
| protocolApplied |
0..1 | BackboneElement | Protocol followed by the provider | |
| targetDisease |
0..* | CodeableConcept | Vaccine-preventable disease targeted by this dose Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |
| doseNumber[x] |
1..1 | positiveInt | Dose number administered | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | preferred |
AIR Status Reason Code
|
⏿2.0.0 | nzhts.digital.health.nz |
| Immunization.vaccineCode | Base | preferred |
AIR Vaccine Product
|
⏿2.0.1 | nzhts.digital.health.nz |
| Immunization.site | Base | preferred |
AIR Body Site
|
⏿2.0.0 | nzhts.digital.health.nz |
| Immunization.route | Base | preferred |
AIR Route of Administration
|
⏿2.0.0 | nzhts.digital.health.nz |
| Immunization.reasonCode | Base | preferred |
AIR Indication Code
|
⏿2.0.1 | nzhts.digital.health.nz |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| air-resched-1 | error | Immunization | Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling. |
extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()
|
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| nz-performer-function-1 | error | Immunization | If the performer function has a system, then it must have a code. |
performer.function.coding.system.exists() implies performer.function.coding.code.exists()
|
| nz-performer-function-2 | error | Immunization | If the performer function has a code, then it must have a system. |
performer.function.coding.code.exists() implies performer.function.coding.system.exists()
|
| nz-reasonCode-1 | error | Immunization | If the reasonCode aka indication has a system, then it must have a code. |
reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()
|
| nz-reasonCode-2 | error | Immunization | If the reasonCode aka indication has a code, then it must have a system. |
reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()
|
| nz-route-1 | error | Immunization | If the route of admin has a system, then it must have a code. |
route.coding.system.exists() implies route.coding.code.exists()
|
| nz-route-2 | error | Immunization | if the route of admin has a code, then it must have a system. |
route.coding.code.exists() implies route.coding.system.exists()
|
| nz-site-1 | error | Immunization | If the body site has a system, then it must have a code. |
site.coding.system.exists() implies site.coding.code.exists()
|
| nz-site-2 | error | Immunization | If the body site has a code, then it must have a system. |
site.coding.code.exists() implies site.coding.system.exists()
|
| nz-status-reason-1 | error | Immunization | If the status reason has a system, then it must have a code. |
statusReason.coding.system.exists() implies statusReason.coding.code.exists()
|
| nz-status-reason-2 | error | Immunization | If the status reason has a code, then it must have a system. |
statusReason.coding.code.exists() implies statusReason.coding.system.exists()
|
| sdhr-imm-status-1 | error | Immunization | SDHR does not return immunization records that AIR has marked as entered in error. |
status != 'entered-in-error'
|
Differential View
This structure is derived from AIRImmunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
C | 0..* | AIRImmunization | Immunization event information Constraints: sdhr-imm-status-1 |
| id |
1..1 | id | Unique identifier for the immunization event assigned by ImmSOT | |
| meta |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:DataQualityAssessment |
0..0 | Data Quality Assessment | ||
| extension:PlannedEventMatch |
0..0 | Planned Event Match | ||
| extension:PlannedEventMatchQuality |
0..0 | Planned Event Match Quality | ||
| extension:CreatedBy |
0..0 | AIR Created By User | ||
| extension:ModifiedBy |
0..0 | AIR Modified By User | ||
| source |
0..0 | Identifies where the resource comes from | ||
| profile |
0..0 | Profiles this resource claims to conform to | ||
| tag |
0..0 | Tags applied to this resource | ||
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:Diluent |
0..0 | Immunization Diluent | ||
| extension:MobileSiteId |
0..0 | Immunization Facility Mobile Site | ||
| extension:relatedPersonExtension |
0..0 | AIR Related Person | ||
| extension:serologyReportExtension |
0..0 | AIR Serology Report Extension | ||
| extension:rescheduleDateExtension |
0..0 | AIR Reschedule Date Extension | ||
| modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | Business identifier | ||
| status |
1..1 | code | Status of the immunization event | |
| statusReason |
0..1 | CodeableConcept | Reason for the immunization event status | |
| vaccineCode |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| coding |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| version |
0..0 | Version of the system - if relevant | ||
| patient |
1..1 | Reference(Patient) | NHI of the person who was immunized | |
| display |
0..0 | Text alternative for the resource | ||
| recorded |
0..0 | When the immunization was first captured in the subject's record | ||
| location |
0..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location) | Facility where the immunization event occurred | |
| display |
0..1 | string | Facility name supplied by SDHR from the included AIR Location | |
| lotNumber |
0..1 | string | Vaccine batch or lot number | |
| expirationDate |
0..1 | date | Vaccine batch expiry date | |
| site |
0..1 | CodeableConcept | Body site where the vaccine was administered | |
| route |
0..1 | CodeableConcept | Route by which the vaccine was administered | |
| performer |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| function |
0..1 | CodeableConcept | Role performed by the vaccinator | |
| actor |
1..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner) | Identifier or reference for the vaccinator | |
| reasonCode |
0..* | CodeableConcept | Clinical or funding indication for the immunization | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition, observation, or report supporting the indication | |
| protocolApplied |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| series |
0..0 | Name of vaccine series | ||
| authority |
0..0 | Who is responsible for publishing the recommendations | ||
| targetDisease |
0..* | CodeableConcept | Vaccine-preventable disease targeted by this dose | |
| doseNumber[x] |
1..1 | positiveInt | Dose number administered | |
| seriesDoses[x] |
0..0 | Recommended number of doses for immunity | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| sdhr-imm-status-1 | error | Immunization | SDHR does not return immunization records that AIR has marked as entered in error. |
status != 'entered-in-error'
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
C | 0..* | AIRImmunization | Immunization event information Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1, sdhr-imm-status-1 |
| id |
Σ | 1..1 | id | Unique identifier for the immunization event assigned by ImmSOT |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:CreatedSourceSystem |
0..1 | string | AIR Created Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system | |
| extension:ModifiedSourceSystem |
0..1 | string | AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system | |
| extension:CreatedDate |
0..1 | instant | The instant when this resource ID was first associated with content on this server URL: http://hl7.org/fhir/StructureDefinition/firstCreated | |
| versionId |
Σ | 0..1 | id | Version specific identifier |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:administeredProduct |
0..1 | CodeableConcept | AIR Administered Product Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product Binding: AIR Administered Product Code (required) | |
| extension:AgeGiven |
0..1 | (Complex) | AIR Age Given Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given | |
| status |
?!Σ | 1..1 | code | Status of the immunization event Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
| statusReason |
0..1 | CodeableConcept | Reason for the immunization event status Binding: AIR Status Reason Code (preferred) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: AIR Vaccine Product (preferred) |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| patient |
Σ | 1..1 | Reference(Patient) | NHI of the person who was immunized |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date |
| location |
0..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location) | Facility where the immunization event occurred | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Facility name supplied by SDHR from the included AIR Location |
| lotNumber |
0..1 | string | Vaccine batch or lot number | |
| expirationDate |
0..1 | date | Vaccine batch expiry date | |
| site |
0..1 | CodeableConcept | Body site where the vaccine was administered Binding: AIR Body Site (preferred) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| route |
0..1 | CodeableConcept | Route by which the vaccine was administered Binding: AIR Route of Administration (preferred) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| performer |
Σ | 0..* | BackboneElement | Who performed event |
| function |
Σ | 0..1 | CodeableConcept | Role performed by the vaccinator Binding: AIR Performer Health Worker Function (extensible) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| actor |
Σ | 1..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner) | Identifier or reference for the vaccinator |
| reasonCode |
0..* | CodeableConcept | Clinical or funding indication for the immunization Binding: AIR Indication Code (preferred) | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition, observation, or report supporting the indication | |
| protocolApplied |
0..1 | BackboneElement | Protocol followed by the provider | |
| targetDisease |
0..* | CodeableConcept | Vaccine-preventable disease targeted by this dose Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |
| doseNumber[x] |
1..1 | positiveInt | Dose number administered | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| air-resched-1 | error | Immunization | Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling. |
extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()
|
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| nz-performer-function-1 | error | Immunization | If the performer function has a system, then it must have a code. |
performer.function.coding.system.exists() implies performer.function.coding.code.exists()
|
| nz-performer-function-2 | error | Immunization | If the performer function has a code, then it must have a system. |
performer.function.coding.code.exists() implies performer.function.coding.system.exists()
|
| nz-reasonCode-1 | error | Immunization | If the reasonCode aka indication has a system, then it must have a code. |
reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()
|
| nz-reasonCode-2 | error | Immunization | If the reasonCode aka indication has a code, then it must have a system. |
reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()
|
| nz-route-1 | error | Immunization | If the route of admin has a system, then it must have a code. |
route.coding.system.exists() implies route.coding.code.exists()
|
| nz-route-2 | error | Immunization | if the route of admin has a code, then it must have a system. |
route.coding.code.exists() implies route.coding.system.exists()
|
| nz-site-1 | error | Immunization | If the body site has a system, then it must have a code. |
site.coding.system.exists() implies site.coding.code.exists()
|
| nz-site-2 | error | Immunization | If the body site has a code, then it must have a system. |
site.coding.code.exists() implies site.coding.system.exists()
|
| nz-status-reason-1 | error | Immunization | If the status reason has a system, then it must have a code. |
statusReason.coding.system.exists() implies statusReason.coding.code.exists()
|
| nz-status-reason-2 | error | Immunization | If the status reason has a code, then it must have a system. |
statusReason.coding.code.exists() implies statusReason.coding.system.exists()
|
| sdhr-imm-status-1 | error | Immunization | SDHR does not return immunization records that AIR has marked as entered in error. |
status != 'entered-in-error'
|
This structure is derived from AIRImmunization
Other representations of profile: CSV, Excel, Schematron