Calls made at Verify cover. Taught at /rail/stops/Entitle.
List every cover the member holds.
List every cover the member holds.
Each payer is asked at once. A cover the payer will not honour today comes back with selectable false and the payer's reason, not as an error. A payer that could not be asked is named in unavailable[] inside a 200.
Keep from the response: covers[].cover_id
Taught in: 02 · Verify cover
path Parameters
unique_patient_idunique patient id
query Parameters
facility_patient_noWhat this facility calls the patient. Optional; send it only when a source keyed on it (a SMART card session) is in play, and send the same value again on covers/select. It does not filter payers.
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.
List every cover the member holds. › Responses
Returns covers[].cover_id.
unique_patient_idis_aliveSelect one cover.
Select one cover.
Send its cover_id, plus facility_patient_no again if the covers call took one. The payers are asked again first, then the choice is recorded as a FHIR Coverage in the clinical store. Selecting the same cover twice returns the same selection_ref.
Keep from the response: selection_ref
Taught in: 02 · Verify cover
path Parameters
unique_patient_idunique patient id
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.
Select one cover. › Responses
Returns selection_ref.
selection_refunique_patient_idselected_atWalk the selected cover's benefit tree.
Walk the selected cover's benefit tree.
One level per call. Call it with no parent_code for the top level, then follow each node's next_action: filter_benefits descends, and any other type ends the walk at that node. Every node carries its balance in coverage.
Keep from the response: nodes[].code
Taught in: 02 · Verify cover
path Parameters
unique_patient_idunique patient id
selection_refselection ref
query Parameters
parent_codeThe code whose children to return. Omit it for the top level; pass a node's code (the endpoint in its filter_benefits next_action) for the level below it. Do not assume a depth. A code with nothing beneath it answers 404 BENEFIT_NOT_FOUND.
searchFilter this level only, by name or code. SHA ignores it at the top level.
access_pointFilter billable lines to the access point of the current visit — outpatient, inpatient, and so on.
page1-based page number. An unreadable value falls back to 1.
page_sizeRows per page. Default 50, capped at 200. An unreadable value falls back to the default.
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.
Walk the selected cover's benefit tree. › Responses
Returns nodes[].code.
unique_patient_idselection_refparent_codeas_of