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* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | Coverage | This is a Coverage resource |
identifier | array(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. | |
status | string | The status of the resource instance. | |
type | CodeableConcept | The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. | |
policyHolder | Reference | The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer. | |
subscriber | Reference | 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. | |
subscriberId | string | The insurer assigned ID for the Subscriber. | |
beneficiary | Reference | The party who benefits from the insurance coverage., the patient when services are provided. | |
relationship | CodeableConcept | The relationship of beneficiary (patient) to the subscriber. | |
period | Period | Time 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. | |
payor | array(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). | |
grouping | Coverage_Grouping | A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan. | |
dependent | string | A unique identifier for a dependent under the coverage. | |
sequence | string | An optional counter for a particular instance of the identified coverage which increments upon each renewal. | |
order | number | The 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. | |
network | string | The 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. | |
contract | array(Reference) | The policy(s) which constitute this insurance coverage. |
Response
keyboard_arrow_down
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* | string | application/json-patch+json | application/json-patch+json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | string | Coverage | This is a Coverage resource |
identifier | array(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. | |
status | string | The status of the resource instance. | |
type | CodeableConcept | The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. | |
policyHolder | Reference | The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer. | |
subscriber | Reference | 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. | |
subscriberId | string | The insurer assigned ID for the Subscriber. | |
beneficiary | Reference | The party who benefits from the insurance coverage., the patient when services are provided. | |
relationship | CodeableConcept | The relationship of beneficiary (patient) to the subscriber. | |
period | Period | Time 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. | |
payor | array(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). | |
grouping | Coverage_Grouping | A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan. | |
dependent | string | A unique identifier for a dependent under the coverage. | |
sequence | string | An optional counter for a particular instance of the identified coverage which increments upon each renewal. | |
order | number | The 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. | |
network | string | The 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. | |
contract | array(Reference) | The policy(s) which constitute this insurance coverage. |
Response
keyboard_arrow_down
Read Coverage
get
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read History Coverage
get
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}/_history
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read Version Coverage
get
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* | |||
versionId* |
Response
keyboard_arrow_down
Remove Coverage
delete
/organizations/{organizationId}/fhir/3/Coverage/{resourceId}
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Search Get Coverage
get
/organizations/{organizationId}/fhir/3/Coverage
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
beneficiary | string | ||
class | string | ||
dependent | string | ||
group | string | ||
identifier | string | ||
payor | string | ||
plan | string | ||
policy-holder | string | ||
sequence | string | ||
subclass | string | ||
subgroup | string | ||
subplan | string | ||
subscriber | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Coverage
get
/organizations/{organizationId}/fhir/3/Coverage/_history
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
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* | string | application/json|application/x-www-form-urlencoded | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
beneficiary | string | ||
class | string | ||
dependent | string | ||
group | string | ||
identifier | string | ||
payor | string | ||
plan | string | ||
policy-holder | string | ||
sequence | string | ||
subclass | string | ||
subgroup | string | ||
subplan | string | ||
subscriber | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | Coverage | This is a Coverage resource |
identifier | array(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. | |
status | string | The status of the resource instance. | |
type | CodeableConcept | The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. | |
policyHolder | Reference | The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer. | |
subscriber | Reference | 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. | |
subscriberId | string | The insurer assigned ID for the Subscriber. | |
beneficiary | Reference | The party who benefits from the insurance coverage., the patient when services are provided. | |
relationship | CodeableConcept | The relationship of beneficiary (patient) to the subscriber. | |
period | Period | Time 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. | |
payor | array(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). | |
grouping | Coverage_Grouping | A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan. | |
dependent | string | A unique identifier for a dependent under the coverage. | |
sequence | string | An optional counter for a particular instance of the identified coverage which increments upon each renewal. | |
order | number | The 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. | |
network | string | The 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. | |
contract | array(Reference) | The policy(s) which constitute this insurance coverage. |
Response
keyboard_arrow_down
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* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | string | Coverage | This is a Coverage resource |
identifier | array(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. | |
status | string | The status of the resource instance. | |
type | CodeableConcept | The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. | |
policyHolder | Reference | The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer. | |
subscriber | Reference | 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. | |
subscriberId | string | The insurer assigned ID for the Subscriber. | |
beneficiary | Reference | The party who benefits from the insurance coverage., the patient when services are provided. | |
relationship | CodeableConcept | The relationship of beneficiary (patient) to the subscriber. | |
period | Period | Time 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. | |
payor | array(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). | |
grouping | Coverage_Grouping | A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan. | |
dependent | string | A unique identifier for a dependent under the coverage. | |
sequence | string | An optional counter for a particular instance of the identified coverage which increments upon each renewal. | |
order | number | The 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. | |
network | string | The 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. | |
contract | array(Reference) | The policy(s) which constitute this insurance coverage. |
Response
keyboard_arrow_down