Soft-delete an existing HIS inbound pre-appointment

DELETE 
/v1/checkin/appointments/his-inbound/:externalAppointmentId

Soft-deletes a pre-appointment identified by (provider from the token, external_appointment_id) along with its charges and documents (S3 objects are left intact). Only pre-appointments created by the HIS inbound integration (source HIS_INBOUND) can be deleted. If the pre-appointment is already CANCELLED, this operation is an idempotent no-op and still returns 204. If it is COMPLETED, the deletion is rejected. Requires valid OAuth2 authentication.

Request

Responses

204

Pre-appointment soft-deleted, or already CANCELLED (idempotent no-op)

400

Bad Request: the pre-appointment was not created by the HIS inbound integration (source is not HIS_INBOUND).

401

Unauthorized: missing or invalid Bearer token

403

Forbidden: your credentials are not authorised for this operation

404

Pre-appointment not found for the given external_appointment_id and provider

409

Conflict: the pre-appointment is COMPLETED and cannot be deleted

502

Bad Gateway: RCM API is unavailable or network timeout occurred.