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

• Narrative Content
• XML
• JSON
• TTL

: Cancel an Appointment backfill - JSON Representation

Active as of 2026-10-13

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "DHOAppointmentBackfillCancel",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition DHOAppointmentBackfillCancel</b></p><a name=\"DHOAppointmentBackfillCancel\"> </a><a name=\"hcDHOAppointmentBackfillCancel\"> </a><p>URL: [base]/Appointment/$backfill-cancel</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>cancelling</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/DHOAppointmentBackfillCancel",
  "version" : "0.4.7",
  "name" : "DHOAppointmentBackfillCancel",
  "title" : "Cancel an Appointment backfill",
  "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" : "Asks a running backfill to stop. It stops before its next page, so the current page's writes still complete, and\nnothing already written is undone. Returns 202, or 409 for a job that has already finished.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "NZ",
          "display" : "New Zealand"
        }
      ]
    }
  ],
  "affectsState" : true,
  "code" : "backfill-cancel",
  "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" : "cancelling",
      "type" : "code"
    }
  ]
}