Calls made at Treat. Taught at /rail/stops/Treat.
Search ICD-11 for a codable diagnosis. The picker is fetched, never typed.
Search ICD-11 for a codable diagnosis. The picker is fetched, never typed.
Not implemented yet. Not registered. The live coded-list surface is /api/v1/terminology — /concepts, /concepts/{concept_id} and /value-sets — which is where an ICD-11 search will resolve from.
Keep from the response: codes[].code
Taught in: 05 · Treat
query Parameters
versionversion
qdiagnosis query
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.
Search ICD-11 for a codable diagnosis. The picker is fetched, never typed. › Responses
Returns codes[].code.
value_setversionRecord a diagnosis on the visit's clinical record — a Condition on the encounter. A clinical fact first; no cover appears here.
Record a diagnosis on the visit's clinical record — a Condition on the encounter. A clinical fact first; no cover appears here.
Keep from the response: diagnosis_ref
Taught in: 05 · Treat
path Parameters
visit_refvisit ref
Record a diagnosis on the visit's clinical record — a Condition on the encounter. A clinical fact first; no cover appears here. › Request Body
systemcoderoleRecord a diagnosis on the visit's clinical record — a Condition on the encounter. A clinical fact first; no cover appears here. › Responses
Returns diagnosis_ref.
Every diagnosis on this visit, and which intervention each one supports.
Every diagnosis on this visit, and which intervention each one supports.
Not implemented yet. No diagnosis routes under a v1 visit. Writing one is live at POST /api/v2/visits/{visit_ref}/diagnoses; reading them back and withdrawing one are not.
Keep from the response: diagnoses[].diagnosis_id
Taught in: 05 · Treat
path Parameters
visit_idvisit id
Every diagnosis on this visit, and which intervention each one supports. › Responses
Returns diagnoses[].diagnosis_id.
Withdraw a diagnosis recorded in error. Refused once the claim is submitted.
Withdraw a diagnosis recorded in error. Refused once the claim is submitted.
Not implemented yet. No diagnosis routes under a v1 visit. The nearest registered withdrawal is PATCH /api/v1/claims/diagnoses, which acts on a claim rather than on a visit.
Keep from the response: status
Taught in: 05 · Treat
path Parameters
visit_idvisit id
diagnosis_iddiagnosis id
Withdraw a diagnosis recorded in error. Refused once the claim is submitted. › Responses
Returns status.
Read back what this visit has written — the encounter and every resource under it.
Read back what this visit has written — the encounter and every resource under it.
Not implemented yet. Same route as clinical.contribute, and equally unregistered. GET /api/v2/visits/{visit_ref}/documents reads what is attached to a visit; it is not a clinical read.
Keep from the response: resources[].id
Taught in: 05 · Treat
path Parameters
visit_idvisit id
Read back what this visit has written — the encounter and every resource under it. › Responses
Returns resources[].id.
Contribute the encounter to the shared health record as a FHIR bundle.
Contribute the encounter to the shared health record as a FHIR bundle.
Not implemented yet. There is no /clinical child under a visit, and the registered visits group is v2, not v1. The nearest live calls are POST /api/v2/visits/{visit_ref}/diagnoses and the /api/v1/shr group — neither is a drop-in.
Keep from the response: bundle_id
Taught in: 05 · Treat
path Parameters
visit_idvisit id
Contribute the encounter to the shared health record as a FHIR bundle. › Request Body
resource_typetypeContribute the encounter to the shared health record as a FHIR bundle. › Responses
Returns bundle_id.
bundle_idstatusThe episodes of care this patient has open — the thread visits hang from.
The episodes of care this patient has open — the thread visits hang from.
Keep from the response: episode_id
Taught in: 05 · Treat
The episodes of care this patient has open — the thread visits hang from. › Responses
Returns episode_id.
Open an episode, or attach this visit to one that is already running.
Open an episode, or attach this visit to one that is already running.
Keep from the response: episode_id
Taught in: 05 · Treat
Open an episode, or attach this visit to one that is already running. › Request Body
unique_patient_idvisit_idintentOpen an episode, or attach this visit to one that is already running. › Responses
Returns episode_id.
Order a lab, an image or a procedure. Routed to the performer, whether or not it is you.
Order a lab, an image or a procedure. Routed to the performer, whether or not it is you.
Not implemented yet. No /orders prefix exists under either version, and no orders domain in the service.
Keep from the response: order_id
Taught in: 05 · Treat
path Parameters
visit_idvisit id
Order a lab, an image or a procedure. Routed to the performer, whether or not it is you. › Request Body
categorypriorityperformer_facilityOrder a lab, an image or a procedure. Routed to the performer, whether or not it is you. › Responses
Returns order_id.
order_idstatusperformer_facilityOrders routed to this facility from anywhere on the rail — your work queue.
Orders routed to this facility from anywhere on the rail — your work queue.
Not implemented yet. No /orders prefix exists under either version.
Keep from the response: orders[].order_id
Taught in: 05 · Treat
query Parameters
performer_facilityfacility code
statusstatus
Orders routed to this facility from anywhere on the rail — your work queue. › Responses
Returns orders[].order_id.
Return the result against the order. It reaches the requester without a second integration.
Return the result against the order. It reaches the requester without a second integration.
Not implemented yet. No /orders prefix exists under either version.
Keep from the response: result_ref
Taught in: 05 · Treat
path Parameters
order_idorder id
Return the result against the order. It reaches the requester without a second integration. › Request Body
statusReturn the result against the order. It reaches the requester without a second integration. › Responses
Returns result_ref.
Prescriptions routed to this pharmacy, written anywhere. Nothing is carried in on paper.
Prescriptions routed to this pharmacy, written anywhere. Nothing is carried in on paper.
Keep from the response: prescriptions[].prescription_id
Taught in: 05 · Treat
Prescriptions routed to this pharmacy, written anywhere. Nothing is carried in on paper. › Responses
Returns prescriptions[].prescription_id.
Prescribe. Routed to the pharmacy the patient chooses, which may not be yours.
Prescribe. Routed to the pharmacy the patient chooses, which may not be yours.
Keep from the response: prescription_id
Taught in: 05 · Treat
Prescribe. Routed to the pharmacy the patient chooses, which may not be yours. › Request Body
route_to_facilityPrescribe. Routed to the pharmacy the patient chooses, which may not be yours. › Responses
Returns prescription_id.
Record what was actually handed over, including a substitution or a partial fill.
Record what was actually handed over, including a substitution or a partial fill.
Keep from the response: dispense_id
Taught in: 05 · Treat
Record what was actually handed over, including a substitution or a partial fill. › Request Body
Record what was actually handed over, including a substitution or a partial fill. › Responses
Returns dispense_id.
Remove a doctor from a prescription recorded against the wrong prescriber.
Remove a doctor from a prescription recorded against the wrong prescriber.
Keep from the response: status
Taught in: 05 · Treat
Remove a doctor from a prescription recorded against the wrong prescriber. › Responses
Returns status.
Generate the documents this claim requires from the clinical data already recorded.
Generate the documents this claim requires from the clinical data already recorded.
Not implemented yet. No document routes under a visit. Rendering is live at a different address: POST /api/v1/clinical/document-bundles/{id}/pdf renders a bundle, and POST /api/v1/clinical/html-to-pdf converts HTML you supply. Neither generates a document set from a visit's clinical data.
Keep from the response: documents[].document_id
Taught in: 05 · Treat
path Parameters
visit_idvisit id
Generate the documents this claim requires from the clinical data already recorded. › Request Body
document_typesformatGenerate the documents this claim requires from the clinical data already recorded. › Responses
Returns documents[].document_id.
Render a document on demand — HTML to show on screen, PDF to hand over or sign.
Render a document on demand — HTML to show on screen, PDF to hand over or sign.
Not implemented yet. No document routes under a visit. GET /api/v1/clinical/document-bundles/{id}/render is the live renderer, scoped to a bundle rather than to a visit and a document type.
Keep from the response: url
Taught in: 05 · Treat
path Parameters
visit_idvisit id
document_typedocument type
query Parameters
formatformat
Render a document on demand — HTML to show on screen, PDF to hand over or sign. › Responses
Returns url.
Refer onward, carrying the clinical record and the authorisation taken here.
Refer onward, carrying the clinical record and the authorisation taken here.
Not implemented yet. No /referrals prefix exists, and there is no referral surface in the service.
Keep from the response: referral_id
Taught in: 05 · Treat
path Parameters
visit_idvisit id
Refer onward, carrying the clinical record and the authorisation taken here. › Request Body
to_facilityurgencyinclude_clinicalauthorization_refspecimen_accompanyingRefer onward, carrying the clinical record and the authorisation taken here. › Responses
Returns referral_id.
referral_idstatusto_facilityReferrals sent to this facility, with the record and the authorisation already attached.
Referrals sent to this facility, with the record and the authorisation already attached.
Not implemented yet. No /referrals prefix exists.
Keep from the response: referrals[].referral_id
Taught in: 05 · Treat
query Parameters
facility_codefacility code
directiondirection
Referrals sent to this facility, with the record and the authorisation already attached. › Responses
Returns referrals[].referral_id.
Accept or decline a referral, and open the receiving visit against the same authorisation.
Accept or decline a referral, and open the receiving visit against the same authorisation.
Not implemented yet. No /referrals prefix exists.
Keep from the response: visit_id
Taught in: 05 · Treat
path Parameters
referral_idreferral id
Accept or decline a referral, and open the receiving visit against the same authorisation. › Request Body
decisionexpected_atAccept or decline a referral, and open the receiving visit against the same authorisation. › Responses
Returns visit_id.
Send a specimen to the hub, tracked against the order that asked for it.
Send a specimen to the hub, tracked against the order that asked for it.
Not implemented yet. Hangs off the unregistered /referrals prefix.
Keep from the response: sample_id
Taught in: 05 · Treat
path Parameters
referral_idreferral id
Send a specimen to the hub, tracked against the order that asked for it. › Request Body
order_idcold_chaincourier_refSend a specimen to the hub, tracked against the order that asked for it. › Responses
Returns sample_id.

