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
| Active as of 2026-10-13 |
{
"resourceType" : "OperationDefinition",
"id" : "DHOAppointmentBackfillStatus",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition DHOAppointmentBackfillStatus</b></p><a name=\"DHOAppointmentBackfillStatus\"> </a><a name=\"hcDHOAppointmentBackfillStatus\"> </a><p>URL: [base]/Appointment/$backfill-status</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>job</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The job id $backfill returned</p>\n</div></td></tr><tr><td>OUT</td><td>status</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td><div><p>running, completed, failed, cancelled or stale</p>\n</div></td></tr><tr><td>OUT</td><td>mode</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td><div><p>The mode $backfill was started with</p>\n</div></td></tr><tr><td>OUT</td><td>startedAt</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td/></tr><tr><td>OUT</td><td>updatedAt</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td/></tr><tr><td>OUT</td><td>finishedAt</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td/></tr><tr><td>OUT</td><td>pagesProcessed</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td/></tr><tr><td>OUT</td><td>outcome</td><td/><td>0..*</td><td></td><td/><td><div><p>How many Appointments ended with one outcome, e.g. updated, skipped, error</p>\n</div></td></tr><tr><td>OUT</td><td>outcome.code</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td/></tr><tr><td>OUT</td><td>outcome.count</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td/></tr><tr><td>OUT</td><td>notFound</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Identifier runs only: how many requested identifiers FHIR CDR didn't have</p>\n</div></td></tr><tr><td>OUT</td><td>cancelRequested</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>true when $backfill-cancel has been called but the run hasn't stopped yet</p>\n</div></td></tr><tr><td>OUT</td><td>error</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Failed runs only: why</p>\n</div></td></tr></table></div>"
},
"url" : "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/DHOAppointmentBackfillStatus",
"version" : "0.4.7",
"name" : "DHOAppointmentBackfillStatus",
"title" : "Get an Appointment backfill's status",
"status" : "active",
"kind" : "operation",
"date" : "2026-10-13T01:26:02+00:00",
"publisher" : "Te Whatu Ora",
"contact" : [
{
"name" : "Te Whatu Ora",
"telecom" : [
{
"system" : "url",
"value" : "https://www.tewhatuora.govt.nz/"
}
]
},
{
"name" : "Te Whatu Ora Integration Team",
"telecom" : [
{
"system" : "email",
"value" : "integration@tewhatuora.govt.nz",
"use" : "work"
}
]
}
],
"description" : "Reports on a backfill started with $backfill. Returns 202 with an X-Progress header while it runs, and 200 once it has\nfinished. status is running, completed, failed, cancelled, or stale when a running job hasn't been updated for a\nwhile (its run was most likely cut short by a restart).",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "NZ",
"display" : "New Zealand"
}
]
}
],
"affectsState" : false,
"code" : "backfill-status",
"resource" : [
"Appointment"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "job",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The job id $backfill returned",
"type" : "string"
},
{
"name" : "status",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "running, completed, failed, cancelled or stale",
"type" : "code"
},
{
"name" : "mode",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The mode $backfill was started with",
"type" : "code"
},
{
"name" : "startedAt",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "instant"
},
{
"name" : "updatedAt",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "instant"
},
{
"name" : "finishedAt",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "instant"
},
{
"name" : "pagesProcessed",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "integer"
},
{
"name" : "outcome",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "How many Appointments ended with one outcome, e.g. updated, skipped, error",
"part" : [
{
"name" : "code",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "code"
},
{
"name" : "count",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "integer"
}
]
},
{
"name" : "notFound",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Identifier runs only: how many requested identifiers FHIR CDR didn't have",
"type" : "integer"
},
{
"name" : "cancelRequested",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "true when $backfill-cancel has been called but the run hasn't stopped yet",
"type" : "boolean"
},
{
"name" : "error",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Failed runs only: why",
"type" : "string"
}
]
}