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 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="DHOAppointmentBackfillStatus"/>
<text>
<status value="generated"/>
<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>
</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>
</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>
</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>
</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>
</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>
</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>
</div></td></tr></table></div>
</text>
<url
value="https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/DHOAppointmentBackfillStatus"/>
<version value="0.4.7"/>
<name value="DHOAppointmentBackfillStatus"/>
<title value="Get an Appointment backfill's status"/>
<status value="active"/>
<kind value="operation"/>
<date value="2026-10-13T01:26:02+00:00"/>
<publisher value="Te Whatu Ora"/>
<contact>
<name value="Te Whatu Ora"/>
<telecom>
<system value="url"/>
<value value="https://www.tewhatuora.govt.nz/"/>
</telecom>
</contact>
<contact>
<name value="Te Whatu Ora Integration Team"/>
<telecom>
<system value="email"/>
<value value="integration@tewhatuora.govt.nz"/>
<use value="work"/>
</telecom>
</contact>
<description
value="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)."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="NZ"/>
<display value="New Zealand"/>
</coding>
</jurisdiction>
<affectsState value="false"/>
<code value="backfill-status"/>
<resource value="Appointment"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="job"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The job id $backfill returned"/>
<type value="string"/>
</parameter>
<parameter>
<name value="status"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="running, completed, failed, cancelled or stale"/>
<type value="code"/>
</parameter>
<parameter>
<name value="mode"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="The mode $backfill was started with"/>
<type value="code"/>
</parameter>
<parameter>
<name value="startedAt"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="instant"/>
</parameter>
<parameter>
<name value="updatedAt"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="instant"/>
</parameter>
<parameter>
<name value="finishedAt"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="instant"/>
</parameter>
<parameter>
<name value="pagesProcessed"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="integer"/>
</parameter>
<parameter>
<name value="outcome"/>
<use value="out"/>
<min value="0"/>
<max value="*"/>
<documentation
value="How many Appointments ended with one outcome, e.g. updated, skipped, error"/>
<part>
<name value="code"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="code"/>
</part>
<part>
<name value="count"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="integer"/>
</part>
</parameter>
<parameter>
<name value="notFound"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Identifier runs only: how many requested identifiers FHIR CDR didn't have"/>
<type value="integer"/>
</parameter>
<parameter>
<name value="cancelRequested"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="true when $backfill-cancel has been called but the run hasn't stopped yet"/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="error"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation value="Failed runs only: why"/>
<type value="string"/>
</parameter>
</OperationDefinition>