Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Updated InsurancePlan R4 Resource #1000

Merged
merged 4 commits into from
Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 21 additions & 17 deletions content/millennium/r4/financial/general/insurance-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,25 @@ 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 id](https://hl7.org/fhir/r4/insuranceplan-definitions.html#InsurancePlan.identifier){:target="_blank"}
amcginn marked this conversation as resolved.
Show resolved Hide resolved
* [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) %>
Expand All @@ -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` | This or `owned-by` | [`token`] | The logical resource id associated with the resource. Example: `12345`
`owned-by` | This or `_id` | [`reference`] | The Organization associated with the InsurancePlan. Example: `12345`

_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 reference, or a comma-separated list of references. Example: `_id=12345` or `_id=12345,67890`
amcginn marked this conversation as resolved.
Show resolved Hide resolved
- When searching with the `owned-by` parameter:
- It must be provided only once. Example: `owned-by=12345`

### Headers

Expand All @@ -57,11 +72,6 @@ Name | Required? | Type | Description
<%= headers status: 200 %>
<%= json(:r4_insuranceplan_bundle) %>

<%= disclaimer %>

### Errors

The common [errors] and [OperationOutcomes] may be returned.

## Retrieve by id

Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/resources/example_json/r4_examples_insurance_plan.rb
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ module Resources
'id': '2798233',
'text': {
'status': 'generated',
'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:' \
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:' \
'Medicare Part A</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:' \
'Organization/589783</p><p><b>Period Start Date</b>: Aug 14, 2015 2:32 P.M. UTC</p></div>'
},
Expand Down Expand Up @@ -61,7 +61,7 @@ module Resources
'id': '3132244',
'text': {
'status': 'generated',
'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:' \
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:' \
'Medicare Part A and B</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:' \
'Organization/589783</p><p><b>Period Start Date</b>: Apr 3, 2018 8:37 P.M. UTC</p></div>'
},
Expand Down Expand Up @@ -101,7 +101,7 @@ module Resources
'id': '3132243',
'text': {
'status': 'generated',
'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:' \
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:' \
'Medicare Part B</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:' \
'Organization/589783</p><p><b>Period Start Date</b>: Apr 3, 2018 8:36 P.M. UTC</p></div>'
},
Expand Down Expand Up @@ -141,7 +141,7 @@ module Resources
'id': '3226346',
'text': {
'status': 'generated',
'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:' \
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:' \
'Medicare Provider Liable</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:' \
'Organization/589783</p><p><b>Period Start Date</b>: Apr 16, 2019 5:42 P.M. UTC</p></div>'
},
Expand Down
Loading