Coverage REST Endpoints

Sort by

Task Path Method

Description

Coverage

This topic describes information for the Coverage resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

The Coverage resource provides high-level information about an insurance plan for a specific person, patient, or encounter. Identifying coverage information is displayed on an insurance card and used to pay for healthcare services. The resource can also be used for self-pay where an individual takes responsibility for the cost of healthcare services, rather than a company or organization.

Profile Support

This resource supports the US Core Coverage Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
Coverage	DomainResource
Coverage.id	id
Coverage.status	code
Coverage.type	CodeableConcept
Coverage.subscriber	Reference Patient RelatedPerson
Coverage.subscriberId	string
Coverage.relationship	CodeableConcept
Coverage.beneficiary	Reference (Patient)
Coverage.dependent	string
Coverage.period	Period
Coverage.payor	Reference Organization RelatedPerson Patient
Coverage.class	BackboneElement
Coverage.class.type	CodeableConcept
Coverage.class.value	string
Coverage.class.name	string

Terminology Bindings

Element	Description	Details
Coverage.relationship	The relationship of the beneficiary (patient) to the subscriber.	System

Coverage

The operations from the Coverage category.

Get a coverage by ID

Method: get

Path: /Coverage/{id}

Get a list of coverages

Method: get

Path: /Coverage