Coverage
A resident's payer coverage / policies, mapped to FHIR Coverage — for eligibility, clearinghouse, and HIE partners. Read-only; real-time eligibility (X12 270/271) is surfaced here as coverage status.
FHIR CoverageRequires coverage.read
Read-only
This resource is read-only. Clinical and financial writes are confirmed by a human inside the product and are not exposed on the integration API.
Endpoints
GET
/api/v1/ofctx/{org_id}/{facility_id}/coverageList coverage records (FHIR Coverage search)
Requires scope coverage.read
Base URL
https://medflo-pcc-vendor-api-eez5kqwsxa-uw.a.run.app
| Parameter | In | Type | Description |
|---|---|---|---|
org_idrequired | path | string (uuid) | Your organization id. Must match the org bound to your credentials — mismatches are rejected (403). |
facility_idrequired | path | string (uuid) | A facility within your org that your credentials are granted. Out-of-scope facilities are rejected (403). |
resident_id | query | string (uuid) | Filter coverage records to a single resident. |
page | query | integer | 1-based page number. Default 1. |
page_size | query | integer | Rows per page (1–200). Default 50. |
Example response 200 OK
json
{
"data": [
{
"resourceType": "Coverage",
"id": "c1a2b3c4-...",
"status": "active",
"beneficiary": {
"reference": "Patient/8f2c1e4a-..."
},
"payor": [
{
"reference": "Organization/Medicare Part A"
}
],
"subscriberId": "1EG4-TE5-MK72",
"period": {
"start": "2026-01-01"
},
"order": 1
}
],
"meta": {
"page": {
"page": 1,
"page_size": 50,
"total": 3
}
},
"error": null
}GET
/api/v1/ofctx/{org_id}/{facility_id}/coverage/{coverage_id}Read a coverage record (FHIR Coverage/{id})
Requires scope coverage.read
Base URL
https://medflo-pcc-vendor-api-eez5kqwsxa-uw.a.run.app
| Parameter | In | Type | Description |
|---|---|---|---|
org_idrequired | path | string (uuid) | Your organization id. Must match the org bound to your credentials — mismatches are rejected (403). |
facility_idrequired | path | string (uuid) | A facility within your org that your credentials are granted. Out-of-scope facilities are rejected (403). |
coverage_idrequired | path | string (uuid) | The coverage record id. |
Example response 200 OK
json
{
"data": {
"resourceType": "Coverage",
"id": "c1a2b3c4-...",
"status": "active",
"beneficiary": {
"reference": "Patient/8f2c1e4a-..."
},
"payor": [
{
"reference": "Organization/Medicare Part A"
}
],
"subscriberId": "1EG4-TE5-MK72",
"period": {
"start": "2026-01-01"
},
"order": 1
},
"meta": null,
"error": null
}Notes
- All responses use the
{ data, meta, error }envelope. List responses carry pagination inmeta.page. - Identifiers and codes are returned exactly as the system of record provides them — identifier values stay masked; the API never unmasks.
- See Errors for the failure envelope and Rate limits for throttling headers.