coverages

Create Coverage

post
/organizations/{organizationId}/fhir/3/Coverage

Financial instrument which may be used to reimburse or pay for health care products and services.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringCoverageThis is a Coverage resource
identifierarray(Identifier)The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.
statusstringThe status of the resource instance.
typeCodeableConceptThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
policyHolderReferenceThe party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.
subscriberReferenceThe 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.
subscriberIdstringThe insurer assigned ID for the Subscriber.
beneficiaryReferenceThe party who benefits from the insurance coverage., the patient when services are provided.
relationshipCodeableConceptThe relationship of beneficiary (patient) to the subscriber.
periodPeriodTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
payorarray(Reference)The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).
groupingCoverage_GroupingA suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.
dependentstringA unique identifier for a dependent under the coverage.
sequencestringAn optional counter for a particular instance of the identified coverage which increments upon each renewal.
ordernumberThe order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
networkstringThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
contractarray(Reference)The policy(s) which constitute this insurance coverage.

Response

Patch Coverage

patch
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}

Financial instrument which may be used to reimburse or pay for health care products and services.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCoverageThis is a Coverage resource
identifierarray(Identifier)The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.
statusstringThe status of the resource instance.
typeCodeableConceptThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
policyHolderReferenceThe party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.
subscriberReferenceThe 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.
subscriberIdstringThe insurer assigned ID for the Subscriber.
beneficiaryReferenceThe party who benefits from the insurance coverage., the patient when services are provided.
relationshipCodeableConceptThe relationship of beneficiary (patient) to the subscriber.
periodPeriodTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
payorarray(Reference)The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).
groupingCoverage_GroupingA suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.
dependentstringA unique identifier for a dependent under the coverage.
sequencestringAn optional counter for a particular instance of the identified coverage which increments upon each renewal.
ordernumberThe order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
networkstringThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
contractarray(Reference)The policy(s) which constitute this insurance coverage.

Response

Read Coverage

get
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Coverage

get
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Coverage

get
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Coverage

delete
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Coverage

get
/organizations/{organizationId}/fhir/3/Coverage

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
beneficiarystring
classstring
dependentstring
groupstring
identifierstring
payorstring
planstring
policy-holderstring
sequencestring
subclassstring
subgroupstring
subplanstring
subscriberstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Coverage

get
/organizations/{organizationId}/fhir/3/Coverage/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Coverage

post
/organizations/{organizationId}/fhir/3/Coverage/_search

Financial instrument which may be used to reimburse or pay for health care products and services.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
beneficiarystring
classstring
dependentstring
groupstring
identifierstring
payorstring
planstring
policy-holderstring
sequencestring
subclassstring
subgroupstring
subplanstring
subscriberstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringCoverageThis is a Coverage resource
identifierarray(Identifier)The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.
statusstringThe status of the resource instance.
typeCodeableConceptThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
policyHolderReferenceThe party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.
subscriberReferenceThe 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.
subscriberIdstringThe insurer assigned ID for the Subscriber.
beneficiaryReferenceThe party who benefits from the insurance coverage., the patient when services are provided.
relationshipCodeableConceptThe relationship of beneficiary (patient) to the subscriber.
periodPeriodTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
payorarray(Reference)The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).
groupingCoverage_GroupingA suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.
dependentstringA unique identifier for a dependent under the coverage.
sequencestringAn optional counter for a particular instance of the identified coverage which increments upon each renewal.
ordernumberThe order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
networkstringThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
contractarray(Reference)The policy(s) which constitute this insurance coverage.

Response

Update Coverage

put
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}

Financial instrument which may be used to reimburse or pay for health care products and services.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCoverageThis is a Coverage resource
identifierarray(Identifier)The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.
statusstringThe status of the resource instance.
typeCodeableConceptThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
policyHolderReferenceThe party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.
subscriberReferenceThe 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.
subscriberIdstringThe insurer assigned ID for the Subscriber.
beneficiaryReferenceThe party who benefits from the insurance coverage., the patient when services are provided.
relationshipCodeableConceptThe relationship of beneficiary (patient) to the subscriber.
periodPeriodTime period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
payorarray(Reference)The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).
groupingCoverage_GroupingA suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.
dependentstringA unique identifier for a dependent under the coverage.
sequencestringAn optional counter for a particular instance of the identified coverage which increments upon each renewal.
ordernumberThe order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
networkstringThe insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
contractarray(Reference)The policy(s) which constitute this insurance coverage.

Response