Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/DHOAppointmentBackfillStatus | Version: 0.4.7 | |||
| Active as of 2026-10-13 | Computable Name: DHOAppointmentBackfillStatus | |||
Reports on a backfill started with $backfill. Returns 202 with an X-Progress header while it runs, and 200 once it has finished. status is running, completed, failed, cancelled, or stale when a running job hasn't been updated for a while (its run was most likely cut short by a restart).
URL: [base]/Appointment/$backfill-status
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | job | 1..1 | string | The job id $backfill returned | ||
| OUT | status | 1..1 | code | running, completed, failed, cancelled or stale | ||
| OUT | mode | 1..1 | code | The mode $backfill was started with | ||
| OUT | startedAt | 1..1 | instant | |||
| OUT | updatedAt | 1..1 | instant | |||
| OUT | finishedAt | 0..1 | instant | |||
| OUT | pagesProcessed | 1..1 | integer | |||
| OUT | outcome | 0..* | How many Appointments ended with one outcome, e.g. updated, skipped, error | |||
| OUT | outcome.code | 1..1 | code | |||
| OUT | outcome.count | 1..1 | integer | |||
| OUT | notFound | 0..1 | integer | Identifier runs only: how many requested identifiers FHIR CDR didn't have | ||
| OUT | cancelRequested | 0..1 | boolean | true when $backfill-cancel has been called but the run hasn't stopped yet | ||
| OUT | error | 0..1 | string | Failed runs only: why |