Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.27.0 - release New Zealand

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

OperationDefinition: Reassign Patient Schedules

Official URL: https://standards.digital.health.nz/fhir/air/OperationDefinition/reassign-patient-schedules Version: 1.27.0
Active as of 2026-08-05 Computable Name: reassign-patient-schedules

Reassign immunisation schedules for a patient.

    Cancels the existing schedules and then creates a new set of schedules based on the new onboarding date. Input is the new onboarding date.

URL: [base]/Patient/$reassign-schedules

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INNHI1..1Patient

The logical id to identify patient/consumer.

INreassignDate1..1Patient

The new onboarding date for the consumer

OUTversion1..1Patient

The consumer version following the update.

OUTstate0..1Patient

The consumer state.

OUTsubStatus0..1Patient

The consumer subStatus.