Health New Zealand Te Whatu Ora Shared Care FHIR API
1.4.8 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v1.4.8) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

OperationDefinition: Cancel an Appointment backfill

Official URL: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/DHOAppointmentBackfillCancel Version: 1.4.8
Active as of 2026-11-04 Computable Name: DHOAppointmentBackfillCancel

Asks a running backfill to stop. It stops before its next page, so the current page's writes still complete, and nothing already written is undone. Returns 202, or 409 for a job that has already finished.

URL: [base]/Appointment/$backfill-cancel

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INjob1..1string

The job id $backfill returned

OUTstatus1..1code

cancelling