Immunization-upsert
type: OperationDefinition
node role: treeRoot
resource.id:
  value: Immunization-upsert
domain resource.text:
  narrative.status:
    value: generated
  narrative.div: Generated Narrative: OperationDefinition Immunization-upsert URL: [base]/Immunization/$upsert Parameters Use Name Scope Cardinality Type Binding Documentation IN immunization 1..1 Immunization The Immunization resource to be either updated (if an algorithmic match is found) or inserted (if no match is found) into ImmSOT. OUT return 0..1 Immunization The updated or created immunisation event (as an Immunization resource). OUT failure 0..1 OperationOutcome Error response
operation definition.url:
  value: https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-upsert
operation definition.version:
  value: 1.31.0
operation definition.name:
  value: UpsertImmunisationEvent
operation definition.title:
  value: Upsert Immunisation Event
operation definition.status:
  value: active
operation definition.kind:
  value: operation
operation definition.experimental:
  value: false
operation definition.date:
  value: 2026-07-23T00:14:26+00:00
operation definition.publisher:
  value: Te Whatu Ora
operation 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
operation definition.description:
  value: Upsert an immunisation event based on a matching algorithm.
operation 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
operation definition.affects state:
  value: true
operation definition.code:
  value: upsert
operation definition.resource:
  value: Immunization
  index: 0
operation definition.system:
  value: false
operation definition.type:
  value: true
operation definition.instance:
  value: false
operation definition.parameter:
  index: 0
  operation definition.parameter.name:
    value: immunization
  operation definition.parameter.use:
    value: in
  operation definition.parameter.min:
    value: 1
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The Immunization resource to be either updated (if an algorithmic match is found) or inserted (if no match is found) into ImmSOT.
  operation definition.parameter.type:
    value: Immunization
operation definition.parameter:
  index: 1
  operation definition.parameter.name:
    value: return
  operation definition.parameter.use:
    value: out
  operation definition.parameter.min:
    value: 0
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The updated or created immunisation event (as an Immunization resource).
  operation definition.parameter.type:
    value: Immunization
operation definition.parameter:
  index: 2
  operation definition.parameter.name:
    value: failure
  operation definition.parameter.use:
    value: out
  operation definition.parameter.min:
    value: 0
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: Error response
  operation definition.parameter.type:
    value: OperationOutcome