The FHIR STU3 Coverage resource describes a patient’s insurance.
FHIR Resource: Coverage <https://www.hl7.org/fhir/coverage.html>
Supported Attributes
| Name | Comment |
|---|---|
identifier |
Policy ID |
type |
|
beneficiary |
Related patient |
relationship |
Self, Spouse, Parent, Other |
subscriber |
|
payor |
Reference to insurance provider |
grouping |
|
grouping.group |
Group Number |
grouping.planDisplay |
Plan Name |
order |
1 - primary insurance |
https://api.healthgorilla.com/fhir/CoverageFHIR Operations
The following operations are currently supported:
1. Read
| HTTP Request | Method | Action |
|---|---|---|
/Coverage/{ID} | GET | Retrieve Coverage resource by ID |
2. Search
| HTTP Request | Method | Action |
|---|---|---|
/Coverage?[parameter={value}] | GET | Retrieve Condition resources by the specified search criteria |
Parameters:
| Key | Type | Description |
|---|---|---|
| beneficiary | Reference | Patient Identifier |
Examples
2.1. Retrieve insurances by patient
https://api.healthgorilla.com/fhir/Coverage?beneficiary=8063965523692105bfc35def3. Create
| HTTP Request | Method | Action |
|---|---|---|
| /Coverage | POST | Adds insurance to patient |
The following attributes are required:
| Name | Details |
|---|---|
| identifier | |
| beneficiary | |
| relationship | |
| payor | |
| grouping |
4. Delete
| HTTP Request | Method | Action |
|---|---|---|
/Coverage/{ID} | DELETE | Deletes insurance from patient |