Calls made at Preauthorize. Taught at /rail/stops/Preauth.
Check a held line is ready to preauthorise.
Check a held line is ready to preauthorise.
Runs the preauth gates over one held service line with no side effects: a missing doctor, a missing diagnosis, a required document not yet uploaded, clinical data missing or malformed. Each reason is a blocker or a warning. A submit requires the last preflight on the line to have passed.
Keep from the response: ready
Taught in: 06 · Preauthorize
path Parameters
visit_refvisit ref
Headers
X-Facility-IdThe facility this call is made from.
X-Facility-Id-TypeHow to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.
Check a held line is ready to preauthorise. › Responses
Returns ready.
Submit a preauthorisation for approval.
Submit a preauthorisation for approval.
Submits one held service line. The request is thin: the diagnoses, the doctors and the intervention's requirements are taken from the visit's record, and diagnoses are never sent. items[] is the itemised estimate and every item needs code, name, unit_price and quantity, all as strings. doctors[] is optional and falls back to the visit's practitioners; each entry names a practitioner already on the visit. It is asynchronous: the 202 carries a reference to watch, not a decision. There is no consent token on this call, the service reads it from the line.
Keep from the response: reference
Taught in: 06 · Preauthorize
path Parameters
visit_refvisit ref
Headers
X-Facility-IdThe facility this call is made from.
X-Facility-Id-TypeHow to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.
Submit a preauthorisation for approval. › Request Body
service_line_refidempotency_keyservice_startservice_endprovider_emailnarrativeSubmit a preauthorisation for approval. › Responses
Returns reference.
referenceservice_line_refstatepoll_after_msPoll for the decision.
Poll for the decision.
The preauth's current state and the payer's own status. It works on a closed visit, because the final verdict outlives the visit that raised it. GET /api/v2/visits/{visit_ref}/preauths lists every preauth the visit raised.
Keep from the response: authorization_code
Taught in: 06 · Preauthorize
path Parameters
visit_refvisit ref
preauth_referencepreauth reference
Headers
X-Facility-IdThe facility this call is made from.
X-Facility-Id-TypeHow to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.
Poll for the decision. › Responses
Returns authorization_code.

