The FHIR R4 Coverage resource is used to capture insurance and financial support details for a patient, including information about payers, policyholders, and coverage periods. It helps ensure healthcare services are billed appropriately and supports the management of healthcare costs.
Health Gorilla exposes Coverage as part of its FHIR R4 API to support patient-centric access to insurance and financial coverage information.
Use Cases
- Retrieving insurance details before procedures
- Validating coverage for patient eligibility
- Updating coverage information during intake
- Monitoring changes in coverage periods
- Supporting claims processing based on coverage status
Scope and Behavior
This documentation describes the FHIR R4 API interface for Coverage. Health Gorilla’s platform may use additional internal services and data standards to acquire, normalize, and route clinical information. Only the FHIR R4–exposed behavior is documented here.
Health Gorilla supports a subset of the HL7 FHIR R4 Coverage resource. Not all optional elements defined in the HL7 specification may be stored, indexed, or returned. Unsupported or unrecognized elements may be ignored or normalized during processing.
In Health Gorilla, Coverage is most commonly accessed as part of patient record retrieval workflows, where insurance and financial data may be aggregated and normalized for eligibility verification and billing-related use cases. This resource supports financial coordination, payer identification, and coverage validation alongside other patient administrative data.
Authentication
All requests to the FHIR R4 API require OAuth 2.0 authentication using a bearer token. Unauthorized requests return 401 Unauthorized responses.
Required scopes:
coverage.readfor GETcoverage.writefor POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Search Behavior
Searches are scoped to the authenticated tenant. The patient parameter is required for patient-scoped searches and is recommended for most search use cases.
Results are returned as a FHIR Bundle. Pagination may be applied. Use standard FHIR pagination links (Bundle.link) to retrieve additional result pages.
Note: The parameters listed below are not exhaustive and reflect commonly used fields in typical Health Gorilla workflows. Supported parameters and behavior may vary by configuration.
Frequently Used Search Parameters
| Parameter | Description | Example Values | FHIR Data Type |
|---|---|---|---|
patient | Filters by patient | Patient/{id} | Reference |
status | Filters by coverage status | active, cancelled, draft | token |
type | Filters by coverage type | private, public, self-pay | token |
period | Filters by coverage effective period | ge2022-01-01, le2023-12-31 | date |
Commonly Returned Resource Attributes
| Attribute | Description | Example Values | FHIR Data Type |
|---|---|---|---|
beneficiary | Individual receiving benefits from the coverage | Patient/{id} | Reference(Patient) |
status | Current status of the coverage | active, cancelled | code |
type | Type of insurance coverage | private, public | CodeableConcept |
period | Coverage effective period | 2024-01-01 to 2024-12-31 | Period |
payor | Organization or individual providing coverage | Organization/{id} | Reference[] |
policyHolder | Person who holds the coverage policy | Patient/{id}, RelatedPerson/{id} | Reference |
subscriberId | Unique identifier for the subscriber | S123456789 | string |
Notifications
The FHIR R4 API does not provide direct resource-change subscriptions for Coverage. Changes to coverage information may surface through broader notification workflows, depending on enabled Health Gorilla products and configuration.
Error Handling
All Coverage operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses. For more information, go to: Error Handling.