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 |
@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/DHOAppointmentBackfillStatus> a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:Resource.id [ fhir:value "DHOAppointmentBackfillStatus"] ;
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 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><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>"
] ;
fhir:OperationDefinition.url [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/DHOAppointmentBackfillStatus"] ;
fhir:OperationDefinition.version [ fhir:value "0.4.7"] ;
fhir:OperationDefinition.name [ fhir:value "DHOAppointmentBackfillStatus"] ;
fhir:OperationDefinition.title [ fhir:value "Get an Appointment backfill's status"] ;
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 "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)."] ;
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 "false"^^xsd:boolean] ;
fhir:OperationDefinition.code [ fhir:value "backfill-status"] ;
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 "job" ] ;
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 "The job id $backfill returned" ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
], [
fhir:index 1 ;
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 "running, completed, failed, cancelled or stale" ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "code" ]
], [
fhir:index 2 ;
fhir:OperationDefinition.parameter.name [ fhir:value "mode" ] ;
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 mode $backfill was started with" ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "code" ]
], [
fhir:index 3 ;
fhir:OperationDefinition.parameter.name [ fhir:value "startedAt" ] ;
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.type [ fhir:value "instant" ]
], [
fhir:index 4 ;
fhir:OperationDefinition.parameter.name [ fhir:value "updatedAt" ] ;
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.type [ fhir:value "instant" ]
], [
fhir:index 5 ;
fhir:OperationDefinition.parameter.name [ fhir:value "finishedAt" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "instant" ]
], [
fhir:index 6 ;
fhir:OperationDefinition.parameter.name [ fhir:value "pagesProcessed" ] ;
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.type [ fhir:value "integer" ]
], [
fhir:index 7 ;
fhir:OperationDefinition.parameter.name [ fhir:value "outcome" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "*" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "How many Appointments ended with one outcome, e.g. updated, skipped, error" ] ;
fhir:OperationDefinition.parameter.part [
fhir:index 0 ;
fhir:OperationDefinition.parameter.name [ fhir:value "code" ] ;
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.type [ fhir:value "code" ]
], [
fhir:index 1 ;
fhir:OperationDefinition.parameter.name [ fhir:value "count" ] ;
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.type [ fhir:value "integer" ]
]
], [
fhir:index 8 ;
fhir:OperationDefinition.parameter.name [ fhir:value "notFound" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Identifier runs only: how many requested identifiers FHIR CDR didn't have" ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "integer" ]
], [
fhir:index 9 ;
fhir:OperationDefinition.parameter.name [ fhir:value "cancelRequested" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "true when $backfill-cancel has been called but the run hasn't stopped yet" ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 10 ;
fhir:OperationDefinition.parameter.name [ fhir:value "error" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Failed runs only: why" ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
] .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/OperationDefinition/DHOAppointmentBackfillStatus.ttl> a owl:Ontology ;
owl:imports fhir:fhir.ttl ;
owl:versionIRI <http://build.fhir.org/OperationDefinition/DHOAppointmentBackfillStatus.ttl> .
IG © 2022+ Te Whatu Ora. Package tewhatuora.sharedcare#0.4.7 based on FHIR 4.0.1. Generated 2026-10-13
Links: Table of Contents |
QA Report