diff --git a/content/millennium/r4/financial/general/insurance-plan.md b/content/millennium/r4/financial/general/insurance-plan.md index a08d9643d..f48940529 100644 --- a/content/millennium/r4/financial/general/insurance-plan.md +++ b/content/millennium/r4/financial/general/insurance-plan.md @@ -9,24 +9,32 @@ title: InsurancePlan | R4 API ## Overview -InsurancePlan describes a health insurance offering comprised of a list of covered benefits, costs associated with those benefits, and additional information about the offering, such as who it is owned and administered by, a coverage area contact information. +The InsurancePlan resource is used to describe a health insurance offering and supports the return of a list of details, such as who it is owned and administered by, the plan's coverage area, and contact information. The following fields are returned if valued: -* [InsurancePlan id](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} +* [ID](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} +* [InsurancePlan identifier](https://hl7.org/fhir/r4/insuranceplan-definitions.html#InsurancePlan.identifier){:target="_blank"} * [Status](https://hl7.org/fhir/r4/insuranceplan-definitions.html#InsurancePlan.status){:target="_blank"} * [Type](https://hl7.org/fhir/r4/insuranceplan-definitions.html#InsurancePlan.type){:target="_blank"} * [Name](https://hl7.org/fhir/r4/insuranceplan-definitions.html#InsurancePlan.name){:target="_blank"} * [Period](https://hl7.org/fhir/r4/insuranceplan-definitions.html#InsurancePlan.period){:target="_blank"} * [OwnedBy](https://hl7.org/fhir/r4/insuranceplan-definitions.html#InsurancePlan.ownedBy){:target="_blank"} + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. + ## Terminology Bindings <%= terminology_table(:insurance_plan, :r4) %> ## Search -Search for InsurancePlans that meet supplied query parameters: +Search for insurance plans that meet supplied query parameters: GET /InsurancePlan?:parameters @@ -36,11 +44,18 @@ Search for InsurancePlans that meet supplied query parameters: ### Parameters -Name | Required? | Type | Description -----------------------|--------------------|---------------|------------------------------------------------------- -`_id` | This or `owned-by` | [`token`] | The logical resource id associated with the resource. -`owned-by` | Yes | [`reference`] | Organization associated with the InsurancePlan. +Name | Required | Type | Description +-----------|---------------|---------------|------------------------------------------------------- +`_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if the `owned-by` parameter is not used. Example: `1234` +`owned-by` | Conditionally | [`reference`] | The organization associated with the insurance plan. This parameter is required if the `_id` parameter is not used. Example: `Organization/5678` + +_Implementation Notes_ +- The `_id` and `owned-by` search parameters cannot be provided together. +- When searching with the `_id` parameter: + - It can be provided with either a single value, or a comma-separated list of references. Example: `_id=12345` or `_id=12345,67890` +- When searching with the `owned-by` parameter: + - It must be provided only once. ### Headers @@ -50,22 +65,17 @@ Name | Required? | Type | Description #### Request - GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan?owned-by=589783 + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan?owned-by=Organization/589783 #### Response <%= headers status: 200 %> <%= json(:r4_insuranceplan_bundle) %> -<%= disclaimer %> -### Errors +## Retrieve by ID -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id - -List an individual InsurancePlan by its id: +List an individual insurance plan by the associated ID: GET /InsurancePlan/:id @@ -88,12 +98,6 @@ List an individual InsurancePlan by its id: <%= headers status: 200 %> <%= json(:r4_insuranceplan_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - [`reference`]: https://hl7.org/fhir/R4/search.html#reference [`token`]: https://hl7.org/fhir/R4/search.html#token [errors]: ../../../#client-errors diff --git a/lib/resources/example_json/r4_examples_insurance_plan.rb b/lib/resources/example_json/r4_examples_insurance_plan.rb index d3badb961..7932921d2 100644 --- a/lib/resources/example_json/r4_examples_insurance_plan.rb +++ b/lib/resources/example_json/r4_examples_insurance_plan.rb @@ -21,7 +21,7 @@ module Resources 'id': '2798233', 'text': { 'status': 'generated', - 'div': '

Insurance Plan

Name:' \ + 'div': '

Insurance Plan

Name:' \ 'Medicare Part A

Type: Medical Service Plan

Owned By:' \ 'Organization/589783

Period Start Date: Aug 14, 2015 2:32 P.M. UTC

' }, @@ -61,7 +61,7 @@ module Resources 'id': '3132244', 'text': { 'status': 'generated', - 'div': '

Insurance Plan

Name:' \ + 'div': '

Insurance Plan

Name:' \ 'Medicare Part A and B

Type: Medical Service Plan

Owned By:' \ 'Organization/589783

Period Start Date: Apr 3, 2018 8:37 P.M. UTC

' }, @@ -101,7 +101,7 @@ module Resources 'id': '3132243', 'text': { 'status': 'generated', - 'div': '

Insurance Plan

Name:' \ + 'div': '

Insurance Plan

Name:' \ 'Medicare Part B

Type: Medical Service Plan

Owned By:' \ 'Organization/589783

Period Start Date: Apr 3, 2018 8:36 P.M. UTC

' }, @@ -141,7 +141,7 @@ module Resources 'id': '3226346', 'text': { 'status': 'generated', - 'div': '

Insurance Plan

Name:' \ + 'div': '

Insurance Plan

Name:' \ 'Medicare Provider Liable

Type: Medical Service Plan

Owned By:' \ 'Organization/589783

Period Start Date: Apr 16, 2019 5:42 P.M. UTC

' },