air-scheduled-event
type: StructureDefinition
node role: treeRoot
resource.id:
  value: air-scheduled-event
domain resource.text:
  narrative.status:
    value: extensions
  narrative.div: Generated Narrative: StructureDefinition air-scheduled-event Name Flags Card. Type Description & Constraints Extension 0..* Extension AIR Scheduled Event #xD; extension 1..* Extension Extension #xD; Slices for extension Content/Rules for all slices #xD; extension:type 1..1 Extension Extension #xD; extension 0..0 Extension #xD; url 1..1 uri "type" #xD; value[x] 0..1 Coding Value of extension #xD; url 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event" #xD; value[x] 0..0 Value of extension #xD; Documentation for this format
structure definition.url:
  value: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
structure definition.version:
  value: 2.0.0
structure definition.name:
  value: AIRScheduledEvent
structure definition.title:
  value: AIR Scheduled Event
structure definition.status:
  value: active
structure definition.date:
  value: 2026-08-04T03:24:20+00:00
structure definition.publisher:
  value: Te Whatu Ora
structure definition.contact:
  index: 0
  contact detail.name:
    value: Te Whatu Ora
  contact detail.telecom:
    index: 0
    contact point.system:
      value: url
    contact point.value:
      value: https://tewhatuora.govt.nz
structure definition.description:
  value: The extension to the AIR ImmunizationRecommendation profile is used to convey information about scheduled events, including the event type, the schedule type, the series type, and the antigen group.
structure definition.jurisdiction:
  index: 0
  codeable concept.coding:
    index: 0
    coding.system:
      value: urn:iso:std:iso:3166
    coding.code:
      value: US
    coding.display:
      value: New Zealand
structure definition.fhir version:
  value: 4.0.1
structure definition.mapping:
  index: 0
  structure definition.mapping.identity:
    value: rim
  structure definition.mapping.uri:
    value: http://hl7.org/v3
  structure definition.mapping.name:
    value: RIM Mapping
structure definition.kind:
  value: complex-type
structure definition.abstract:
  value: false
structure definition.context:
  index: 0
  structure definition.context.type:
    value: element
  structure definition.context.expression:
    value: ImmunizationRecommendation.recommendation
structure definition.type:
  value: Extension
structure definition.base definition:
  value: http://hl7.org/fhir/StructureDefinition/Extension
  link: http://hl7.org/fhir/StructureDefinition/Extension
structure definition.derivation:
  value: constraint
structure definition.snapshot:
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    extension.value string:
      value: 4.0.1
  structure definition.snapshot.element:
    index: 0
    element.id:
      value: Extension
    element definition.path:
      value: Extension
    element definition.short:
      value: AIR Scheduled Event
    element definition.definition:
      value: The extension to the AIR ImmunizationRecommendation profile is used to convey information about scheduled events, including the event type, the schedule type, the series type, and the antigen group.
    element definition.min:
      value: 0
    element definition.max:
      value: *
    element definition.base:
      element definition.base.path:
        value: Extension
      element definition.base.min:
        value: 0
      element definition.base.max:
        value: *
    element definition.condition:
      value: ele-1
      index: 0
    element definition.constraint:
      index: 0
      element definition.constraint.key:
        value: ele-1
      element definition.constraint.severity:
        value: error
      element definition.constraint.human:
        value: All FHIR elements must have a @value or children
      element definition.constraint.expression:
        value: hasValue() or (children().count() > id.count())
      element definition.constraint.xpath:
        value: @value|f:*|h:div
      element definition.constraint.source:
        value: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    element definition.constraint:
      index: 1
      element definition.constraint.key:
        value: ext-1
      element definition.constraint.severity:
        value: error
      element definition.constraint.human:
        value: Must have either extensions or value[x], not both
      element definition.constraint.expression:
        value: extension.exists() != value.exists()
      element definition.constraint.xpath:
        value: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
      element definition.constraint.source:
        value: http://hl7.org/fhir/StructureDefinition/Extension
        link: http://hl7.org/fhir/StructureDefinition/Extension
    element definition.is modifier:
      value: false
  structure definition.snapshot.element:
    index: 1
    element.id:
      value: Extension.id
    element definition.path:
      value: Extension.id
    element definition.representation:
      value: xmlAttr
      index: 0
    element definition.short:
      value: Unique id for inter-element referencing
    element definition.definition:
      value: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    element definition.min:
      value: 0
    element definition.max:
      value: 1
    element definition.base:
      element definition.base.path:
        value: Element.id
      element definition.base.min:
        value: 0
      element definition.base.max:
        value: 1
    element definition.type:
      index: 0
      element.extension:
        index: 0
      element definition.type.code:
        value: http://hl7.org/fhirpath/System.String
    element definition.is modifier:
      value: false
    element definition.is summary:
      value: false
    element definition.mapping:
      index: 0
      element definition.mapping.identity:
        value: rim
      element definition.mapping.map:
        value: n/a
  structure definition.snapshot.element:
    index: 2
    element.id:
      value: Extension.extension
    element definition.path:
      value: Extension.extension
    element definition.slicing:
      element definition.slicing.discriminator:
        index: 0
      element definition.slicing.description:
        value: Extensions are always sliced by (at least) url
      element definition.slicing.rules:
        value: open
    element definition.short:
      value: Extension
    element definition.definition:
      value: An Extension
    element definition.min:
      value: 1
    element definition.max:
      value: *
    element definition.base:
      element definition.base.path:
        value: Element.extension
      element definition.base.min:
        value: 0
      element definition.base.max:
        value: *

value: string

value: value

value: url

index: 0
element definition.type.code:
  value: Extension

index: 0
element definition.constraint.key:
  value: ele-1
element definition.constraint.severity:
  value: error
element definition.constraint.human:
  value: All FHIR elements must have a @value or children
element definition.constraint.expression:
  value: hasValue() or (children().count() > id.count())
element definition.constraint.xpath:
  value: @value|f:*|h:div
element definition.constraint.source:
  value: http://hl7.org/fhir/StructureDefinition/Element
  link: http://hl7.org/fhir/StructureDefinition/Element

index: 1
element definition.constraint.key:
  value: ext-1
element definition.constraint.severity:
  value: error
element definition.constraint.human:
  value: Must have either extensions or value[x], not both
element definition.constraint.expression:
  value: extension.exists() != value.exists()
element definition.constraint.xpath:
  value: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
element definition.constraint.source:
  value: http://hl7.org/fhir/StructureDefinition/Extension
  link: http://hl7.org/fhir/StructureDefinition/Extension

value: false

value: false

index: 3
element.id:
  value: Extension.extension:type
element definition.path:
  value: Extension.extension
element definition.slice name:
  value: type
element definition.short:
  value: Extension
element definition.definition:
  value: An Extension
element definition.min:
  value: 1
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Element.extension
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: *
element definition.type:
  index: 0
  element definition.type.code:
    value: Extension
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.constraint:
  index: 1
  element definition.constraint.key:
    value: ext-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: Must have either extensions or value[x], not both
  element definition.constraint.expression:
    value: extension.exists() != value.exists()
  element definition.constraint.xpath:
    value: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
element definition.is modifier:
  value: false
element definition.is summary:
  value: false

index: 4
element.id:
  value: Extension.extension:type.id
element definition.path:
  value: Extension.extension.id
element definition.representation:
  value: xmlAttr
  index: 0
element definition.short:
  value: Unique id for inter-element referencing
element definition.definition:
  value: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
element definition.min:
  value: 0
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Element.id
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    extension.value url:
      value: string
  element definition.type.code:
    value: http://hl7.org/fhirpath/System.String
element definition.is modifier:
  value: false
element definition.is summary:
  value: false
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: n/a

index: 5
element.id:
  value: Extension.extension:type.extension
element definition.path:
  value: Extension.extension.extension
element definition.slicing:
  element definition.slicing.discriminator:
    index: 0
    element definition.slicing.discriminator.type:
      value: value
    element definition.slicing.discriminator.path:
      value: url
  element definition.slicing.description:
    value: Extensions are always sliced by (at least) url
  element definition.slicing.rules:
    value: open
element definition.short:
  value: Extension
element definition.definition:
  value: An Extension
element definition.min:
  value: 0
element definition.max:
  value: 0
element definition.base:
  element definition.base.path:
    value: Element.extension
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: *
element definition.type:
  index: 0
  element definition.type.code:
    value: Extension
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.constraint:
  index: 1
  element definition.constraint.key:
    value: ext-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: Must have either extensions or value[x], not both
  element definition.constraint.expression:
    value: extension.exists() != value.exists()
  element definition.constraint.xpath:
    value: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
element definition.is modifier:
  value: false
element definition.is summary:
  value: false

index: 6
element.id:
  value: Extension.extension:type.url
element definition.path:
  value: Extension.extension.url
element definition.representation:
  value: xmlAttr
  index: 0
element definition.short:
  value: identifies the meaning of the extension
element definition.definition:
  value: Source of the definition for the extension code - a logical name or a URL.
element definition.comment:
  value: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
element definition.min:
  value: 1
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Extension.url
  element definition.base.min:
    value: 1
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    extension.value url:
      value: uri
  element definition.type.code:
    value: http://hl7.org/fhirpath/System.String
element definition.fixed uri:
  value: type
element definition.is modifier:
  value: false
element definition.is summary:
  value: false
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: N/A

index: 7
element.id:
  value: Extension.extension:type.value[x]
element definition.path:
  value: Extension.extension.value[x]
element definition.short:
  value: Value of extension
element definition.definition:
  value: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
element definition.min:
  value: 0
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Extension.value[x]
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element definition.type.code:
    value: Coding
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.is modifier:
  value: false
element definition.is summary:
  value: false
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: N/A

index: 8
element.id:
  value: Extension.url
element definition.path:
  value: Extension.url
element definition.representation:
  value: xmlAttr
  index: 0
element definition.short:
  value: identifies the meaning of the extension
element definition.definition:
  value: Source of the definition for the extension code - a logical name or a URL.
element definition.comment:
  value: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
element definition.min:
  value: 1
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Extension.url
  element definition.base.min:
    value: 1
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    extension.value url:
      value: uri
  element definition.type.code:
    value: http://hl7.org/fhirpath/System.String
element definition.fixed uri:
  value: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
element definition.is modifier:
  value: false
element definition.is summary:
  value: false
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: N/A

index: 9
element.id:
  value: Extension.value[x]
element definition.path:
  value: Extension.value[x]
element definition.short:
  value: Value of extension
element definition.definition:
  value: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
element definition.min:
  value: 0
element definition.max:
  value: 0
element definition.base:
  element definition.base.path:
    value: Extension.value[x]
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element definition.type.code:
    value: base64Binary
element definition.type:
  index: 1
  element definition.type.code:
    value: boolean
element definition.type:
  index: 2
  element definition.type.code:
    value: canonical
element definition.type:
  index: 3
  element definition.type.code:
    value: code
element definition.type:
  index: 4
  element definition.type.code:
    value: date
element definition.type:
  index: 5
  element definition.type.code:
    value: dateTime
element definition.type:
  index: 6
  element definition.type.code:
    value: decimal
element definition.type:
  index: 7
  element definition.type.code:
    value: id
element definition.type:
  index: 8
  element definition.type.code:
    value: instant
element definition.type:
  index: 9
  element definition.type.code:
    value: integer
element definition.type:
  index: 10
  element definition.type.code:
    value: markdown
element definition.type:
  index: 11
  element definition.type.code:
    value: oid
element definition.type:
  index: 12
  element definition.type.code:
    value: positiveInt
element definition.type:
  index: 13
  element definition.type.code:
    value: string
element definition.type:
  index: 14
  element definition.type.code:
    value: time
element definition.type:
  index: 15
  element definition.type.code:
    value: unsignedInt
element definition.type:
  index: 16
  element definition.type.code:
    value: uri
element definition.type:
  index: 17
  element definition.type.code:
    value: url
element definition.type:
  index: 18
  element definition.type.code:
    value: uuid
element definition.type:
  index: 19
  element definition.type.code:
    value: Address
element definition.type:
  index: 20
  element definition.type.code:
    value: Age
element definition.type:
  index: 21
  element definition.type.code:
    value: Annotation
element definition.type:
  index: 22
  element definition.type.code:
    value: Attachment
element definition.type:
  index: 23
  element definition.type.code:
    value: CodeableConcept
element definition.type:
  index: 24
  element definition.type.code:
    value: Coding
element definition.type:
  index: 25
  element definition.type.code:
    value: ContactPoint
element definition.type:
  index: 26
  element definition.type.code:
    value: Count
element definition.type:
  index: 27
  element definition.type.code:
    value: Distance
element definition.type:
  index: 28
  element definition.type.code:
    value: Duration
element definition.type:
  index: 29
  element definition.type.code:
    value: HumanName
element definition.type:
  index: 30
  element definition.type.code:
    value: Identifier
element definition.type:
  index: 31
  element definition.type.code:
    value: Money
element definition.type:
  index: 32
  element definition.type.code:
    value: Period
element definition.type:
  index: 33
  element definition.type.code:
    value: Quantity
element definition.type:
  index: 34
  element definition.type.code:
    value: Range
element definition.type:
  index: 35
  element definition.type.code:
    value: Ratio
element definition.type:
  index: 36
  element definition.type.code:
    value: Reference
element definition.type:
  index: 37
  element definition.type.code:
    value: SampledData
element definition.type:
  index: 38
  element definition.type.code:
    value: Signature
element definition.type:
  index: 39
  element definition.type.code:
    value: Timing
element definition.type:
  index: 40
  element definition.type.code:
    value: ContactDetail
element definition.type:
  index: 41
  element definition.type.code:
    value: Contributor
element definition.type:
  index: 42
  element definition.type.code:
    value: DataRequirement
element definition.type:
  index: 43
  element definition.type.code:
    value: Expression
element definition.type:
  index: 44
  element definition.type.code:
    value: ParameterDefinition

index: 45
element definition.type.code:
  value: RelatedArtifact

index: 46
element definition.type.code:
  value: TriggerDefinition

index: 47
element definition.type.code:
  value: UsageContext

index: 48
element definition.type.code:
  value: Dosage

index: 49
element definition.type.code:
  value: Meta

index: 0
element definition.constraint.key:
  value: ele-1
element definition.constraint.severity:
  value: error
element definition.constraint.human:
  value: All FHIR elements must have a @value or children
element definition.constraint.expression:
  value: hasValue() or (children().count() > id.count())
element definition.constraint.xpath:
  value: @value|f:*|h:div
element definition.constraint.source:
  value: http://hl7.org/fhir/StructureDefinition/Element
  link: http://hl7.org/fhir/StructureDefinition/Element

value: false

value: false

index: 0
element definition.mapping.identity:
  value: rim
element definition.mapping.map:
  value: N/A

structure definition.differential.element:
  index: 0
  element.id:
    value: Extension
  element definition.path:
    value: Extension
  element definition.short:
    value: AIR Scheduled Event
  element definition.definition:
    value: The extension to the AIR ImmunizationRecommendation profile is used to convey information about scheduled events, including the event type, the schedule type, the series type, and the antigen group.
structure definition.differential.element:
  index: 1
  element.id:
    value: Extension.extension
  element definition.path:
    value: Extension.extension
  element definition.min:
    value: 1
structure definition.differential.element:
  index: 2
  element.id:
    value: Extension.extension:type
  element definition.path:
    value: Extension.extension
  element definition.slice name:
    value: type
  element definition.min:
    value: 1
  element definition.max:
    value: 1
structure definition.differential.element:
  index: 3
  element.id:
    value: Extension.extension:type.extension
  element definition.path:
    value: Extension.extension.extension
  element definition.max:
    value: 0
structure definition.differential.element:
  index: 4
  element.id:
    value: Extension.extension:type.url
  element definition.path:
    value: Extension.extension.url
  element definition.fixed uri:
    value: type
structure definition.differential.element:
  index: 5
  element.id:
    value: Extension.extension:type.value[x]
  element definition.path:
    value: Extension.extension.value[x]
  element definition.type:
    index: 0
    element definition.type.code:
      value: Coding
structure definition.differential.element:
  index: 6
  element.id:
    value: Extension.url
  element definition.path:
    value: Extension.url
  element definition.fixed uri:
    value: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
structure definition.differential.element:
  index: 7
  element.id:
    value: Extension.value[x]
  element definition.path:
    value: Extension.value[x]
  element definition.max:
    value: 0