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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a InsurancePlan resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.
statusdraft|active|retired|unknownThe current state of the health insurance product.
typearray(CodeableConcept)The kind of health insurance product.
namestringOfficial name of the health insurance product as designated by the owner.
aliasarray(string)A list of alternate names that the product is known as, or was known as in the past.
periodPeriodThe period of time that the health insurance product is available.
ownedByReferenceThe 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'.
administeredByReferenceAn organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.
coverageAreaarray(Reference)The geographic region in which a health insurance product's benefits apply.
contactarray(InsurancePlan_Contact)The contact for the health insurance product for a certain purpose.
endpointarray(Reference)The technical endpoints providing access to services operated for the health insurance product.
networkarray(Reference)Reference to the network included in the health insurance product.
coveragearray(InsurancePlan_Coverage)Details about the coverage offered by the insurance product.
planarray(InsurancePlan_Plan)Details about an insurance plan.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a InsurancePlan resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.
statusdraft|active|retired|unknownThe current state of the health insurance product.
typearray(CodeableConcept)The kind of health insurance product.
namestringOfficial name of the health insurance product as designated by the owner.
aliasarray(string)A list of alternate names that the product is known as, or was known as in the past.
periodPeriodThe period of time that the health insurance product is available.
ownedByReferenceThe 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'.
administeredByReferenceAn organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.
coverageAreaarray(Reference)The geographic region in which a health insurance product's benefits apply.
contactarray(InsurancePlan_Contact)The contact for the health insurance product for a certain purpose.
endpointarray(Reference)The technical endpoints providing access to services operated for the health insurance product.
networkarray(Reference)Reference to the network included in the health insurance product.
coveragearray(InsurancePlan_Coverage)Details about the coverage offered by the insurance product.
planarray(InsurancePlan_Plan)Details about an insurance plan.

Response

Read Insurance Plan

get
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Insurance Plan

get
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Insurance Plan

get
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Insurance Plan

delete
/organizations/{organizationId}/fhir/4/InsurancePlan/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Insurance Plan

get
/organizations/{organizationId}/fhir/4/InsurancePlan

Request

Headers

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

Query params

_idstring
_languagestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
administered-bystring
endpointstring
identifierstring
namestring
owned-bystring
phoneticstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Insurance Plan

get
/organizations/{organizationId}/fhir/4/InsurancePlan/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
administered-bystring
endpointstring
identifierstring
namestring
owned-bystring
phoneticstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a InsurancePlan resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.
statusdraft|active|retired|unknownThe current state of the health insurance product.
typearray(CodeableConcept)The kind of health insurance product.
namestringOfficial name of the health insurance product as designated by the owner.
aliasarray(string)A list of alternate names that the product is known as, or was known as in the past.
periodPeriodThe period of time that the health insurance product is available.
ownedByReferenceThe 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'.
administeredByReferenceAn organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.
coverageAreaarray(Reference)The geographic region in which a health insurance product's benefits apply.
contactarray(InsurancePlan_Contact)The contact for the health insurance product for a certain purpose.
endpointarray(Reference)The technical endpoints providing access to services operated for the health insurance product.
networkarray(Reference)Reference to the network included in the health insurance product.
coveragearray(InsurancePlan_Coverage)Details about the coverage offered by the insurance product.
planarray(InsurancePlan_Plan)Details about an insurance plan.

Response

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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a InsurancePlan resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.
statusdraft|active|retired|unknownThe current state of the health insurance product.
typearray(CodeableConcept)The kind of health insurance product.
namestringOfficial name of the health insurance product as designated by the owner.
aliasarray(string)A list of alternate names that the product is known as, or was known as in the past.
periodPeriodThe period of time that the health insurance product is available.
ownedByReferenceThe 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'.
administeredByReferenceAn organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.
coverageAreaarray(Reference)The geographic region in which a health insurance product's benefits apply.
contactarray(InsurancePlan_Contact)The contact for the health insurance product for a certain purpose.
endpointarray(Reference)The technical endpoints providing access to services operated for the health insurance product.
networkarray(Reference)Reference to the network included in the health insurance product.
coveragearray(InsurancePlan_Coverage)Details about the coverage offered by the insurance product.
planarray(InsurancePlan_Plan)Details about an insurance plan.

Response