insurance plans
Create Insurance Plan
post
/organizations/{organizationId}/fhir/4/InsurancePlan
Details of a Health Insurance product/plan provided by an organization.
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a InsurancePlan resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. | |
status | draft|active|retired|unknown | The current state of the health insurance product. | |
type | array(CodeableConcept) | The kind of health insurance product. | |
name | string | Official name of the health insurance product as designated by the owner. | |
alias | array(string) | A list of alternate names that the product is known as, or was known as in the past. | |
period | Period | The period of time that the health insurance product is available. | |
ownedBy | Reference | The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'. | |
administeredBy | Reference | An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. | |
coverageArea | array(Reference) | The geographic region in which a health insurance product's benefits apply. | |
contact | array(InsurancePlan_Contact) | The contact for the health insurance product for a certain purpose. | |
endpoint | array(Reference) | The technical endpoints providing access to services operated for the health insurance product. | |
network | array(Reference) | Reference to the network included in the health insurance product. | |
coverage | array(InsurancePlan_Coverage) | Details about the coverage offered by the insurance product. | |
plan | array(InsurancePlan_Plan) | Details about an insurance plan. |
Response
keyboard_arrow_down
Patch Insurance Plan
patch
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}
Details of a Health Insurance product/plan provided by an organization.
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* | This is a InsurancePlan resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. | |
status | draft|active|retired|unknown | The current state of the health insurance product. | |
type | array(CodeableConcept) | The kind of health insurance product. | |
name | string | Official name of the health insurance product as designated by the owner. | |
alias | array(string) | A list of alternate names that the product is known as, or was known as in the past. | |
period | Period | The period of time that the health insurance product is available. | |
ownedBy | Reference | The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'. | |
administeredBy | Reference | An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. | |
coverageArea | array(Reference) | The geographic region in which a health insurance product's benefits apply. | |
contact | array(InsurancePlan_Contact) | The contact for the health insurance product for a certain purpose. | |
endpoint | array(Reference) | The technical endpoints providing access to services operated for the health insurance product. | |
network | array(Reference) | Reference to the network included in the health insurance product. | |
coverage | array(InsurancePlan_Coverage) | Details about the coverage offered by the insurance product. | |
plan | array(InsurancePlan_Plan) | Details about an insurance plan. |
Response
keyboard_arrow_down
Read Insurance Plan
get
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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 Insurance Plan
get
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | 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 Insurance Plan
get
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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 Insurance Plan
delete
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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 Insurance Plan
get
/organizations/{organizationId}/fhir/4/InsurancePlan
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
address | string | ||
address-city | string | ||
address-country | string | ||
address-postalcode | string | ||
address-state | string | ||
address-use | string | ||
administered-by | string | ||
endpoint | string | ||
identifier | string | ||
name | string | ||
owned-by | string | ||
phonetic | string | ||
status | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Insurance Plan
get
/organizations/{organizationId}/fhir/4/InsurancePlan/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | 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 Insurance Plan
post
/organizations/{organizationId}/fhir/4/InsurancePlan/_search
Details of a Health Insurance product/plan provided by an organization.
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 | ||
address | string | ||
address-city | string | ||
address-country | string | ||
address-postalcode | string | ||
address-state | string | ||
address-use | string | ||
administered-by | string | ||
endpoint | string | ||
identifier | string | ||
name | string | ||
owned-by | string | ||
phonetic | string | ||
status | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a InsurancePlan resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. | |
status | draft|active|retired|unknown | The current state of the health insurance product. | |
type | array(CodeableConcept) | The kind of health insurance product. | |
name | string | Official name of the health insurance product as designated by the owner. | |
alias | array(string) | A list of alternate names that the product is known as, or was known as in the past. | |
period | Period | The period of time that the health insurance product is available. | |
ownedBy | Reference | The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'. | |
administeredBy | Reference | An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. | |
coverageArea | array(Reference) | The geographic region in which a health insurance product's benefits apply. | |
contact | array(InsurancePlan_Contact) | The contact for the health insurance product for a certain purpose. | |
endpoint | array(Reference) | The technical endpoints providing access to services operated for the health insurance product. | |
network | array(Reference) | Reference to the network included in the health insurance product. | |
coverage | array(InsurancePlan_Coverage) | Details about the coverage offered by the insurance product. | |
plan | array(InsurancePlan_Plan) | Details about an insurance plan. |
Response
keyboard_arrow_down
Update Insurance Plan
put
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}
Details of a Health Insurance product/plan provided by an organization.
Request
Headers
content-type* | string | application/json|application/json+fhir | 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* | This is a InsurancePlan resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. | |
status | draft|active|retired|unknown | The current state of the health insurance product. | |
type | array(CodeableConcept) | The kind of health insurance product. | |
name | string | Official name of the health insurance product as designated by the owner. | |
alias | array(string) | A list of alternate names that the product is known as, or was known as in the past. | |
period | Period | The period of time that the health insurance product is available. | |
ownedBy | Reference | The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'. | |
administeredBy | Reference | An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. | |
coverageArea | array(Reference) | The geographic region in which a health insurance product's benefits apply. | |
contact | array(InsurancePlan_Contact) | The contact for the health insurance product for a certain purpose. | |
endpoint | array(Reference) | The technical endpoints providing access to services operated for the health insurance product. | |
network | array(Reference) | Reference to the network included in the health insurance product. | |
coverage | array(InsurancePlan_Coverage) | Details about the coverage offered by the insurance product. | |
plan | array(InsurancePlan_Plan) | Details about an insurance plan. |
Response
keyboard_arrow_down