API Reference
Start typing to search…

Coverage

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
2 - secondary insurance
3 - tertiary insurance

 
https://api.healthgorilla.com/fhir/Coverage

FHIR Operations

The following operations are currently supported:

1. Read

HTTP RequestMethodAction
/Coverage/{ID}GETRetrieve Coverage resource by ID

2. Search

HTTP RequestMethodAction
/Coverage?[parameter={value}]GETRetrieve Condition resources by the specified search criteria

Parameters:

KeyTypeDescription
beneficiaryReferencePatient Identifier

Examples

2.1. Retrieve insurances by patient

https://api.healthgorilla.com/fhir/Coverage?beneficiary=8063965523692105bfc35def

3. Create

HTTP RequestMethodAction
/CoveragePOSTAdds insurance to patient

The following attributes are required:

NameDetails
identifier
beneficiary
relationship
payor
grouping

4. Delete

HTTP RequestMethodAction
/Coverage/{ID}DELETEDeletes insurance from patient