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

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

: Start an Appointment backfill - TTL Representation

Active as of 2026-10-13

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/DHOAppointmentBackfill> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "DHOAppointmentBackfill"] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ] ;
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition DHOAppointmentBackfill</b></p><a name=\"DHOAppointmentBackfill\"> </a><a name=\"hcDHOAppointmentBackfill\"> </a><p>URL: [base]/Appointment/$backfill</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>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>location-correction, patient-instruction or touch</p>\n</div></td></tr><tr><td>IN</td><td>lastUpdated</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>Select Appointments updated on or after this date. Not with apptDate or identifier.</p>\n</div></td></tr><tr><td>IN</td><td>apptDate</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>Select Appointments starting on or after this date. Not with lastUpdated or identifier.</p>\n</div></td></tr><tr><td>IN</td><td>apptDateTo</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>With apptDate: select Appointments starting from apptDate to this date, both included.</p>\n</div></td></tr><tr><td>IN</td><td>identifier</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>An appointment id value to select, under any appointment-id system. Not with a date.</p>\n</div></td></tr><tr><td>IN</td><td>audit</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: look everything up and report what would change, but write nothing. Not for touch.</p>\n</div></td></tr><tr><td>OUT</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, for $backfill-status and $backfill-cancel</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>accepted</p>\n</div></td></tr></table></div>"
  ] ;
  fhir:OperationDefinition.url [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/DHOAppointmentBackfill"] ;
  fhir:OperationDefinition.version [ fhir:value "0.4.7"] ;
  fhir:OperationDefinition.name [ fhir:value "DHOAppointmentBackfill"] ;
  fhir:OperationDefinition.title [ fhir:value "Start an Appointment backfill"] ;
  fhir:OperationDefinition.status [ fhir:value "active"] ;
  fhir:OperationDefinition.kind [ fhir:value "operation"] ;
  fhir:OperationDefinition.date [ fhir:value "2026-10-13T01:26:02+00:00"^^xsd:dateTime] ;
  fhir:OperationDefinition.publisher [ fhir:value "Te Whatu Ora"] ;
  fhir:OperationDefinition.contact [
     fhir:index 0 ;
     fhir:ContactDetail.name [ fhir:value "Te Whatu Ora" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "https://www.tewhatuora.govt.nz/" ]
     ]
  ], [
     fhir:index 1 ;
     fhir:ContactDetail.name [ fhir:value "Te Whatu Ora Integration Team" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "email" ] ;
       fhir:ContactPoint.value [ fhir:value "integration@tewhatuora.govt.nz" ] ;
       fhir:ContactPoint.use [ fhir:value "work" ]
     ]
  ] ;
  fhir:OperationDefinition.description [ fhir:value "Starts a backfill of DHO Appointments in FHIR CDR and returns straight away with a job id. The run carries on in the\nbackground. Follow it with $backfill-status and stop it with $backfill-cancel.\n\nSelect Appointments with one of:\n- a date: `lastUpdated` (updated on or after it) or `apptDate` (starting on or after it, or from `apptDate` to\n  `apptDateTo` inclusive)\n- one or more `identifier` values (SIPICS, legacy or Karisma SO appointment ids)\n\nModes:\n- `location-correction` corrects each Appointment's location from SIPICS, or cancels it. Identifiers FHIR CDR\n  doesn't have are created from SIPICS.\n- `patient-instruction` replaces each Appointment's patientInstruction from SIPICS.\n- `touch` re-saves each Appointment unchanged, so its meta.lastUpdated moves on."] ;
  fhir:OperationDefinition.jurisdiction [
     fhir:index 0 ;
     fhir:CodeableConcept.coding [
       fhir:index 0 ;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ] ;
       fhir:Coding.code [ fhir:value "NZ" ] ;
       fhir:Coding.display [ fhir:value "New Zealand" ]
     ]
  ] ;
  fhir:OperationDefinition.affectsState [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.code [ fhir:value "backfill"] ;
  fhir:OperationDefinition.resource [
     fhir:value "Appointment" ;
     fhir:index 0
  ] ;
  fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.type [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.parameter [
     fhir:index 0 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "mode" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "location-correction, patient-instruction or touch" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "code" ]
  ], [
     fhir:index 1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "lastUpdated" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Select Appointments updated on or after this date. Not with apptDate or identifier." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "date" ]
  ], [
     fhir:index 2 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "apptDate" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Select Appointments starting on or after this date. Not with lastUpdated or identifier." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "date" ]
  ], [
     fhir:index 3 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "apptDateTo" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "With apptDate: select Appointments starting from apptDate to this date, both included." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "date" ]
  ], [
     fhir:index 4 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "identifier" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "*" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "An appointment id value to select, under any appointment-id system. Not with a date." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
  ], [
     fhir:index 5 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "audit" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "true: look everything up and report what would change, but write nothing. Not for touch." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
  ], [
     fhir:index 6 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "job" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The job id, for $backfill-status and $backfill-cancel" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
  ], [
     fhir:index 7 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "status" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "accepted" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "code" ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/DHOAppointmentBackfill.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/OperationDefinition/DHOAppointmentBackfill.ttl> .