Calls made at Bill. Taught at /rail/stops/Bill.
Add a bill line.
Add a bill line.
Charges under an authorized service line, payer-first. The payer answers with the covered amount and the patient's copay; a line with no service_line_ref is self pay in full. To apportion one item across covers send splits[] instead of service_line_ref: each share posts to its own cover's claim and the remainder of amount is the patient's copay. practitioner_ref is required whenever a service line is named. invoice_number names the claim the charge belongs to. On a Slade cover it is required: the first charge to name a new invoice number opens that claim under the cover's authorization and later charges naming it join it, so one visit can carry several claims. On a SHA cover any invoice number is accepted and the charge still goes on the one SHA claim, under the invoice_number sent at open. With splits[], name invoice_number on each share and not on the item; a self-pay share takes none.
Keep from the response: bill_line_ref
Taught in: 07 · Bill
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.
Add a bill line. › Request Body
codenamequantityamountservice_line_refpractitioner_refinvoice_numberAdd a bill line. › Responses
Returns bill_line_ref.
bill_line_refcharge_item_refservice_line_refcoverstatusamountcoveredpatient_owesclaim_refAttach a document to a claim.
Attach a document to a claim.
Uploads one supporting document onto a cover's claim before the visit closes. The claim is minted at the cover's first covered service line, and the payer wants its documents (a claim form, an invoice, a report) before it accepts the claim at close. Multipart: the file rides in the attachment field, up to 10 MiB. Leave intervention_code out for claim-level documents such as a claim form: tying one to a preauth-gated intervention makes the payer demand that intervention's preauth first.
Keep from the response: claim_ref
Taught in: 07 · Bill
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.
Attach a document to a claim. › Request Body
coverWhich cover's claim the document attaches to.
document_typeThe payer's document-type code.
attachmentThe document file.
intervention_codeTies the document to one of the claim's interventions, such as a lab report to its test.
Attach a document to a claim. › Responses
Returns claim_ref.
visit_refcoverclaim_refdocument_typestatusAttach a document to a submitted preauth.
Attach a document to a submitted preauth.
Uploads one hospital-supplied document onto a service line's preauth after it has been submitted. It is per service line, not per cover. Multipart: the file rides in the attachment field, up to 10 MiB.
Keep from the response: preauth_reference
Taught in: 07 · Bill
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.
Attach a document to a submitted preauth. › Request Body
service_line_refWhich line's preauth the document attaches to.
document_typeThe payer's document-type code.
attachmentThe document file.
Attach a document to a submitted preauth. › Responses
Returns preauth_reference.
visit_refservice_line_refpreauth_referencedocument_typestatusAttach a required document against the visit.
Attach a required document against the visit.
Not implemented yet. No route attaches a document to a visit under this path. Claim documents go to POST /api/v2/visits/{visit_ref}/claim-attachments and preauth documents to POST /api/v2/visits/{visit_ref}/preauth-attachments. GET /api/v2/visits/{visit_ref}/documents lists the documents the visit's claims and preauths still require.
Keep from the response: document_id
Taught in: 07 · Bill
path Parameters
visit_idvisit id
Attach a required document against the visit. › Request Body
keydocument_typefile_refAttach a required document against the visit. › Responses
Returns document_id.
Retire a per-diem line and start a new one at a different level.
Retire a per-diem line and start a new one at a different level.
Not implemented yet. No /level-changes route is registered. A change of level of care is a service-line switch: POST /api/v2/visits/{visit_ref}/service-lines/{service_line_ref}/switch with new_code and reason CARE_LEVEL_CHANGED.
Keep from the response: new_line_id
Taught in: 07 · Bill
path Parameters
visit_idvisit id
Retire a per-diem line and start a new one at a different level. › Request Body
from_billing_codeto_billing_codeeffective_atreasonRetire a per-diem line and start a new one at a different level. › Responses
Returns new_line_id.

