Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.29.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.29.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: AIR Antigen Group Extension

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-antigen-group-extension Version: 1.29.0-SNAPSHOT
Draft as of 2026-10-12 Computable Name: air-antigen-group-extension

Describes the antigen group used in AGVS.

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension AIR Antigen Group Extension
Extension.url This element must be supported. 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-antigen-group-extension"
Extension.Slices for value[x] 0..1 base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta Value of extension
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Extension.Slices for value[x].value[x]:valueCoding 0..1 Coding Value of extension
Extension.Slices for value[x].value[x]:valueCoding.system This element must be supported. 1..1 uri Identity of the terminology system
Extension.Slices for value[x].value[x]:valueCoding.code This element must be supported. 1..1 code Symbol in syntax defined by the system
Extension.Slices for value[x].value[x]:valueCoding.display This element must be supported. 1..1 string Representation defined by the system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension AIR Antigen Group Extension
Extension.id 0..1 string Unique id for inter-element referencing
Extension.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.url This element must be supported. 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-antigen-group-extension"
Extension.Slices for value[x] 0..1 Value of extension
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Extension.Slices for value[x].valueBase64Binary base64Binary
Extension.Slices for value[x].valueBoolean boolean
Extension.Slices for value[x].valueCanonical canonical(Any)
Extension.Slices for value[x].valueCode code
Extension.Slices for value[x].valueDate date
Extension.Slices for value[x].valueDateTime dateTime
Extension.Slices for value[x].valueDecimal decimal
Extension.Slices for value[x].valueId id
Extension.Slices for value[x].valueInstant instant
Extension.Slices for value[x].valueInteger integer
Extension.Slices for value[x].valueMarkdown markdown
Extension.Slices for value[x].valueOid oid
Extension.Slices for value[x].valuePositiveInt positiveInt
Extension.Slices for value[x].valueString string
Extension.Slices for value[x].valueTime time
Extension.Slices for value[x].valueUnsignedInt unsignedInt
Extension.Slices for value[x].valueUri uri
Extension.Slices for value[x].valueUrl url
Extension.Slices for value[x].valueUuid uuid
Extension.Slices for value[x].valueAddress Address
Extension.Slices for value[x].valueAge Age
Extension.Slices for value[x].valueAnnotation Annotation
Extension.Slices for value[x].valueAttachment Attachment
Extension.Slices for value[x].valueCodeableConcept CodeableConcept
Extension.Slices for value[x].valueCoding Coding
Extension.Slices for value[x].valueContactPoint ContactPoint
Extension.Slices for value[x].valueCount Count
Extension.Slices for value[x].valueDistance Distance
Extension.Slices for value[x].valueDuration Duration
Extension.Slices for value[x].valueHumanName HumanName
Extension.Slices for value[x].valueIdentifier Identifier
Extension.Slices for value[x].valueMoney Money
Extension.Slices for value[x].valuePeriod Period
Extension.Slices for value[x].valueQuantity Quantity
Extension.Slices for value[x].valueRange Range
Extension.Slices for value[x].valueRatio Ratio
Extension.Slices for value[x].valueReference Reference(Any)
Extension.Slices for value[x].valueSampledData SampledData
Extension.Slices for value[x].valueSignature Signature
Extension.Slices for value[x].valueTiming Timing
Extension.Slices for value[x].valueContactDetail ContactDetail
Extension.Slices for value[x].valueContributor Contributor
Extension.Slices for value[x].valueDataRequirement DataRequirement
Extension.Slices for value[x].valueExpression Expression
Extension.Slices for value[x].valueParameterDefinition ParameterDefinition
Extension.Slices for value[x].valueRelatedArtifact RelatedArtifact
Extension.Slices for value[x].valueTriggerDefinition TriggerDefinition
Extension.Slices for value[x].valueUsageContext UsageContext
Extension.Slices for value[x].valueDosage Dosage
Extension.Slices for value[x].valueMeta Meta
Extension.Slices for value[x].value[x]:valueCoding 0..1 Coding Value of extension
Extension.Slices for value[x].value[x]:valueCoding.id 0..1 string Unique id for inter-element referencing
Extension.Slices for value[x].value[x]:valueCoding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for value[x].value[x]:valueCoding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Extension.Slices for value[x].value[x]:valueCoding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Extension.Slices for value[x].value[x]:valueCoding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Extension.Slices for value[x].value[x]:valueCoding.display This element must be supported. This element is included in summaries. 1..1 string Representation defined by the system
Extension.Slices for value[x].value[x]:valueCoding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta: Describes the antigen group used in AGVS.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension AIR Antigen Group Extension
Extension.url This element must be supported. 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-antigen-group-extension"
Extension.Slices for value[x] 0..1 base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta Value of extension
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Extension.Slices for value[x].value[x]:valueCoding 0..1 Coding Value of extension
Extension.Slices for value[x].value[x]:valueCoding.system This element must be supported. 1..1 uri Identity of the terminology system
Extension.Slices for value[x].value[x]:valueCoding.code This element must be supported. 1..1 code Symbol in syntax defined by the system
Extension.Slices for value[x].value[x]:valueCoding.display This element must be supported. 1..1 string Representation defined by the system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension AIR Antigen Group Extension
Extension.id 0..1 string Unique id for inter-element referencing
Extension.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.url This element must be supported. 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-antigen-group-extension"
Extension.Slices for value[x] 0..1 Value of extension
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Extension.Slices for value[x].valueBase64Binary base64Binary
Extension.Slices for value[x].valueBoolean boolean
Extension.Slices for value[x].valueCanonical canonical(Any)
Extension.Slices for value[x].valueCode code
Extension.Slices for value[x].valueDate date
Extension.Slices for value[x].valueDateTime dateTime
Extension.Slices for value[x].valueDecimal decimal
Extension.Slices for value[x].valueId id
Extension.Slices for value[x].valueInstant instant
Extension.Slices for value[x].valueInteger integer
Extension.Slices for value[x].valueMarkdown markdown
Extension.Slices for value[x].valueOid oid
Extension.Slices for value[x].valuePositiveInt positiveInt
Extension.Slices for value[x].valueString string
Extension.Slices for value[x].valueTime time
Extension.Slices for value[x].valueUnsignedInt unsignedInt
Extension.Slices for value[x].valueUri uri
Extension.Slices for value[x].valueUrl url
Extension.Slices for value[x].valueUuid uuid
Extension.Slices for value[x].valueAddress Address
Extension.Slices for value[x].valueAge Age
Extension.Slices for value[x].valueAnnotation Annotation
Extension.Slices for value[x].valueAttachment Attachment
Extension.Slices for value[x].valueCodeableConcept CodeableConcept
Extension.Slices for value[x].valueCoding Coding
Extension.Slices for value[x].valueContactPoint ContactPoint
Extension.Slices for value[x].valueCount Count
Extension.Slices for value[x].valueDistance Distance
Extension.Slices for value[x].valueDuration Duration
Extension.Slices for value[x].valueHumanName HumanName
Extension.Slices for value[x].valueIdentifier Identifier
Extension.Slices for value[x].valueMoney Money
Extension.Slices for value[x].valuePeriod Period
Extension.Slices for value[x].valueQuantity Quantity
Extension.Slices for value[x].valueRange Range
Extension.Slices for value[x].valueRatio Ratio
Extension.Slices for value[x].valueReference Reference(Any)
Extension.Slices for value[x].valueSampledData SampledData
Extension.Slices for value[x].valueSignature Signature
Extension.Slices for value[x].valueTiming Timing
Extension.Slices for value[x].valueContactDetail ContactDetail
Extension.Slices for value[x].valueContributor Contributor
Extension.Slices for value[x].valueDataRequirement DataRequirement
Extension.Slices for value[x].valueExpression Expression
Extension.Slices for value[x].valueParameterDefinition ParameterDefinition
Extension.Slices for value[x].valueRelatedArtifact RelatedArtifact
Extension.Slices for value[x].valueTriggerDefinition TriggerDefinition
Extension.Slices for value[x].valueUsageContext UsageContext
Extension.Slices for value[x].valueDosage Dosage
Extension.Slices for value[x].valueMeta Meta
Extension.Slices for value[x].value[x]:valueCoding 0..1 Coding Value of extension
Extension.Slices for value[x].value[x]:valueCoding.id 0..1 string Unique id for inter-element referencing
Extension.Slices for value[x].value[x]:valueCoding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for value[x].value[x]:valueCoding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Extension.Slices for value[x].value[x]:valueCoding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Extension.Slices for value[x].value[x]:valueCoding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Extension.Slices for value[x].value[x]:valueCoding.display This element must be supported. This element is included in summaries. 1..1 string Representation defined by the system
Extension.Slices for value[x].value[x]:valueCoding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta: Describes the antigen group used in AGVS.

 

Other representations of profile: CSV, Excel, Schematron

Constraints

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()