Create

Beta
POST
/coverages/v1/

Creates a new Coverage. A Coverage provides the high-level identifiers and descriptors of a specific insurance plan for a specific individual - typically the information you can find on an insurance card. Additionally a coverage will include detailed benefits information covered by the specific plan for the individual.

Request

This endpoint expects an object.
statusenumRequired
Allowed values: ACTIVECANCELLEDDRAFTENTERED_IN_ERROR

The status indiciating if the coverage is active or not.

subscriberobjectRequired

The party who has signed-up for or ‘owns’ the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

relationshipenumRequired
Allowed values: SELFSPOUSECHILDCOMMON_LAW_SPOUSEOTHER

The relationship of beneficiary (patient) to the subscriber. https://hl7.org/fhir/valueset-relationship.html

patientstringRequired

The patient who benefits from the insurance coverage

insurance_planobjectRequired
verifiedbooleanRequired

A boolean indicating if the coverage has been verified by a user.

eligibility_checkslist of objectsOptional

A list of eligibility check metadata that have been initiated on this coverage.

latest_eligibility_checkobjectOptional

The latest eligibility check metadata that has been initiated on this coverage.

benefitsobjectOptional

The eligibility of the patient for the coverage, manually verified by users.

Response

This endpoint returns an object.
deactivatedboolean

True if the coverage is deactivated. Deactivated coverages are not returned in search results but are returned in all other endpoints including scan.

idUUID

The unique identifier for a Coverage in the database

insurance_planobject
organization_idstring

The organization that owns this coverage.

patientstring

The patient who benefits from the insurance coverage

relationshipenum
Allowed values: SELFSPOUSECHILDCOMMON_LAW_SPOUSEOTHER

The relationship of beneficiary (patient) to the subscriber. https://hl7.org/fhir/valueset-relationship.html

statusenum
Allowed values: ACTIVECANCELLEDDRAFTENTERED_IN_ERROR

The status indiciating if the coverage is active or not.

subscriberobject

The party who has signed-up for or ‘owns’ the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

updated_atdatetime
updating_user_idstring

The user ID of the user who last updated the coverage.

verifiedboolean

A boolean indicating if the coverage has been verified by a user.

versioninteger

The version of the coverage. Any update to any property of a coverage object will create a new version.

benefitsobjectOptional

The eligibility of the patient for the coverage, manually verified by users.

eligibility_checkslist of objectsOptional

A list of eligibility check metadata that have been initiated on this coverage.

latest_eligibility_checkobjectOptional

The latest eligibility check metadata that has been initiated on this coverage.