Update the header and reconcile charges of an existing HIS inbound pre-appointment
PUT/v1/checkin/appointments/his-inbound/:externalAppointmentId
Updates the header fields (beneficiary, payer, doctor, specialty, agreement, service, notes, appointment date) of a pre-appointment identified by (provider from the token, external_appointment_id), and reconciles its charges against the request's charges list: charges not yet present are added, charges present in both are updated in place (quantity/provider_product_name), and charges no longer present are soft-deleted along with their documents. Only pre-appointments created by the HIS inbound integration (source HIS_INBOUND) in a non-terminal status (PENDING/CONFIRMED) can be updated. Requires valid OAuth2 authentication.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
- 502
Pre-appointment header updated and charges reconciled
Bad Request: the pre-appointment was not created by the HIS inbound integration (source is not HIS_INBOUND).
Unauthorized: missing or invalid Bearer token
Forbidden: your credentials are not authorised for this operation
Pre-appointment not found for the given external_appointment_id and provider, or provider/payer could not be found in rcm-api
Conflict: the pre-appointment is in a terminal status (COMPLETED or CANCELLED) and cannot be updated
Request validation failed. Returns validation errors with field paths and messages.
Bad Gateway: RCM API is unavailable or network timeout occurred.