Coverage
Coverage represents insurance plans to cover claims or other health care services.
Sample Query
Find coverage for members of a family:
https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir-stu3/Coverage?subscriber.family=Demoski
Overview
See the FHIR documentation for more information about Coverage resources.
Mapped Concepts in HIEBus
Supported Interactions
Coverage resources support the following interactions.
Search Parameters
When searching for Coverage resources, the following search parameters are supported.
| Name |
Type
|
Prefixes
Modifiers
|
Can be Chained? |
Description |
| _count |
Special |
|
|
The maximum number of resources to return in a result page.
|
| _elements |
Special |
|
|
Used to request a specific set of elements be returned as part of a resource.
|
| _id |
Token |
|
|
Resource id.
|
| _lastUpdated |
Date |
ne
lt
le
gt
ge
sa
eb
ap
|
|
When the resource last changed.
|
| _source |
Uri |
:missing
|
|
Where the resource comes from.
|
| _summary |
Special |
|
|
Used to return only a portion of the resouces. Defaults to 'false', which returns the whole resource.
|
| _total |
Special |
|
|
Use the value 'estimate' to populate the result bundle's 'total' element with an estimate of the matching number of resources.
|
| beneficiary |
Reference |
:missing
|
yes |
The patient the Coverage is about. Functionally identical to the "patient" search parameter.
|
| dependent |
String |
:contains
:exact
|
|
Dependent number.
|
| group |
String |
:contains
:exact
:missing
|
|
Group identifier.
|
| identifier |
Token |
:missing
|
|
The primary identifier of the insured and the coverage.
|
| patient |
Reference |
:missing
|
yes |
The patient the Coverage is about.
|
| plan |
String |
:contains
:exact
:missing
|
|
A plan or policy identifier.
|
| provenance-agent |
Reference |
:missing
|
yes |
Search by provenance, specified by its author (aka originator) Organization.
|
| sequence |
String |
:contains
:exact
|
|
Sequence number.
|
| subplan |
String |
:contains
:exact
:missing
|
|
Sub-plan identifier.
|
| type |
Token |
:not
:in
:notin
:missing
|
|
The kind of coverage (health plan, auto, Workers Compensation).
|
Sortable Parameters
When searching Coverage resources, it is possible to sort the returned values by the following search parameters.
Only one sort parameter may be specified.
Supported Includes
When searching Coverage resources, it is possible to include the resources referenced by the following field names.
- Beneficiary
- Patient
- Provenance Agent
Back to Resources
