Generated Narrative: OperationDefinition DHOAppointmentBackfill

URL: [base]/Appointment/$backfill

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INmode1..1code

location-correction, patient-instruction or touch

INlastUpdated0..1date

Select Appointments updated on or after this date. Not with apptDate or identifier.

INapptDate0..1date

Select Appointments starting on or after this date. Not with lastUpdated or identifier.

INapptDateTo0..1date

With apptDate: select Appointments starting from apptDate to this date, both included.

INidentifier0..*string

An appointment id value to select, under any appointment-id system. Not with a date.

INaudit0..1boolean

true: look everything up and report what would change, but write nothing. Not for touch.

OUTjob1..1string

The job id, for $backfill-status and $backfill-cancel

OUTstatus1..1code

accepted

 <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="Starts a backfill of DHO Appointments in FHIR CDR and returns straight away with a job id. The run carries on in the background. Follow it with $backfill-status and stop it with $backfill-cancel. Select Appointments with one of: - a date: `lastUpdated` (updated on or after it) or `apptDate` (starting on or after it, or from `apptDate` to `apptDateTo` inclusive) - one or more `identifier` values (SIPICS, legacy or Karisma SO appointment ids) Modes: - `location-correction` corrects each Appointment's location from SIPICS, or cancels it. Identifiers FHIR CDR doesn't have are created from SIPICS. - `patient-instruction` replaces each Appointment's patientInstruction from SIPICS. - `touch` re-saves each Appointment unchanged, so its meta.lastUpdated moves on."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="NZ"/> <display value="New Zealand"/> </coding> </jurisdiction> <affectsState value="true"/> <code value="backfill"/> <resource value="Appointment"/> <system value="false"/> <type value="true"/> <instance value="false"/> <parameter> <name value="mode"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="location-correction, patient-instruction or touch"/> <type value="code"/> </parameter> <parameter> <name value="lastUpdated"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Select Appointments updated on or after this date. Not with apptDate or identifier."/> <type value="date"/> </parameter> <parameter> <name value="apptDate"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Select Appointments starting on or after this date. Not with lastUpdated or identifier."/> <type value="date"/> </parameter> <parameter> <name value="apptDateTo"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="With apptDate: select Appointments starting from apptDate to this date, both included."/> <type value="date"/> </parameter> <parameter> <name value="identifier"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="An appointment id value to select, under any appointment-id system. Not with a date."/> <type value="string"/> </parameter> <parameter> <name value="audit"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="true: look everything up and report what would change, but write nothing. Not for touch."/> <type value="boolean"/> </parameter> <parameter> <name value="job"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The job id, for $backfill-status and $backfill-cancel"/> <type value="string"/> </parameter> <parameter> <name value="status"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="accepted"/> <type value="code"/> </parameter> </OperationDefinition>