This repository has been archived by the owner on May 7, 2024. It is now read-only.
Soarian FHIR R4 Care Plan Resource Documentation #756
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: Clinical | R4 API | ||
| layout: api | ||
| --- | ||
|
|
||
| <%= render '/soarian/r4/clinical.*' %> | ||
|
|
||
| ## Care Provision | ||
| <%= render '/soarian/r4/clinical/care-provision.*' %> | ||
|
|
||
| * [CarePlan](/soarian/r4/clinical/care-provision/care-plan) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| title: Care Provision | R4 API | ||
| layout: api | ||
| --- | ||
|
|
||
| <%= render '/soarian/r4/clinical/care-provision.*' %> | ||
|
|
||
| * [CarePlan](../care-provision/care-plan) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| --- | ||
| title: CarePlan | R4 API | ||
| --- | ||
|
|
||
| # CarePlan | ||
|
|
||
| * TOC | ||
| {:toc} | ||
|
|
||
| ## Overview | ||
|
|
||
| The CarePlan resource describes the intention of how one or more practitioners plan to deliver care for a patient specific to an encounter. | ||
|
|
||
| Soarian Clinicals<sup>®</sup> supports a read-only Application Programming Interface (API). This API accepts `GET` and `POST` based [search] and `GET` based [read] interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals<sup>®</sup> at the time of the query. | ||
|
|
||
| The search results include the following fields if they contain values: | ||
|
|
||
| * [CarePlan Id](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} | ||
| * [Status](https://hl7.org/fhir/r4/careplan-definitions.html#CarePlan.status){:target="_blank"} | ||
| * [Intent (plan)](https://hl7.org/fhir/r4/careplan-definitions.html#CarePlan.intent){:target="_blank"} | ||
| * [Category (assess-plan)](https://hl7.org/fhir/r4/careplan-definitions.html#CarePlan.category){:target="_blank"} | ||
| * [Subject (Patient Only)](https://hl7.org/fhir/r4/careplan-definitions.html#CarePlan.subject){:target="_blank"} | ||
| * [Encounter](https://hl7.org/fhir/r4/careplan-definitions.html#CarePlan.encounter){:target="_blank"} | ||
|
|
||
|
|
||
| ## Terminology Bindings | ||
|
|
||
| <%= terminology_table(:soarian_care_plan, :r4) %> | ||
|
|
||
| ## Search | ||
|
|
||
| Search for CarePlan resources that meet the specified query parameters: | ||
|
|
||
| GET /CarePlan?:parameters | ||
|
|
||
| ### Authorization Types | ||
|
|
||
| <%= authorization_types(provider: true, patient: true)%> | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Required? | Type | Description | ||
| --------------|---------------------|---------------|-------------- | ||
| `_id` | This, or `patient` | [`token`] | The logical resource ID associated with the resource. | ||
| `patient` | This, or `_id` | [`reference`] | The patient who has the care plan. | ||
| `category` | See notes | [`token`] | The scope of the care plan. Example: `category=assess-plan` | ||
| `encounter` | No | [`reference`] | The encounter associated with the care plan record. | ||
| `_count` | No | [`count`] | The maximum number of resources returned in a page. | ||
| `_revincude` | No | [`_revinclude`]| A request to include any Provenance resource in the bundle that refers to a CarePlan resource in the search results. Only supported with Provenance. | ||
|
|
||
| Notes: | ||
|
|
||
| * Either `_id` or `patient` and `category` is required. | ||
| * The `category` parameter: | ||
| * May be combined with the `_id` parameter. | ||
| * Is required with the `patient` parameter. | ||
| * Only supports the code `assess-plan`. | ||
| * The `_revinclude` parameter may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target` | ||
| * When `_revinclude` is provided in a request, the OAuth2 token must include the `patient/Provenance.read system/Provenance.read` or `user/Provenance.read` scope as applicable. | ||
|
|
||
| ### Headers | ||
|
|
||
| <%= headers fhir_json: true %> | ||
|
|
||
| ### Example Search by Patient and Category | ||
|
|
||
| #### Request | ||
|
|
||
| GET https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/CarePlan?patient=494454CC0E254A409CD98DA791EB2E16&category=assess-plan | ||
|
|
||
| #### Response | ||
|
|
||
| <%= headers status: 200 %> | ||
| <%= json(:SOARIAN_R4_CAREPLAN_SEARCH_BY_PT_CATEGORY) %> | ||
|
|
||
| Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. | ||
|
|
||
| ### Example Search by ID | ||
|
|
||
| #### Request | ||
|
|
||
| GET https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/CarePlan?_id=494454CC0E254A409CD98DA791EB2E16.DDC.80014 | ||
|
|
||
| #### Response | ||
|
|
||
| <%= headers status: 200 %> | ||
| <%= json(:SOARIAN_R4_CAREPLAN_SEARCH_BY_ID) %> | ||
|
|
||
| Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. | ||
|
|
||
| ### Errors | ||
|
|
||
| * The common [errors](#errors) and [OperationOutcomes] may be returned. | ||
|
|
||
| ## Retrieve by ID | ||
|
|
||
| List an individual CarePlan resource by its ID: | ||
|
|
||
| GET /CarePlan/:id | ||
|
|
||
| ### Authorization Types | ||
|
|
||
| <%= authorization_types(provider: true, patient: true)%> | ||
|
|
||
|
|
||
| ### Headers | ||
|
|
||
| <%= headers fhir_json: true %> | ||
|
|
||
| ### Example | ||
|
|
||
| #### Request | ||
|
|
||
| GET https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/CarePlan/494454CC0E254A409CD98DA791EB2E16.DDC.80014 | ||
|
|
||
| #### Response | ||
|
|
||
| <%= headers status: 200 %> | ||
| <%= json(:SOARIAN_R4_CAREPLAN_READ_BY_ID) %> | ||
|
|
||
| Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. | ||
|
|
||
| ### Errors | ||
|
|
||
| * The common [errors] and [OperationOutcomes] may be returned. | ||
|
|
||
| [search]: https://www.hl7.org/fhir/http.html#search | ||
| [read]: https://www.hl7.org/fhir/http.html#read | ||
| [`token`]: https://hl7.org/fhir/R4/search.html#token | ||
| [`reference`]: https://hl7.org/fhir/r4/search.html#reference | ||
| [`count`]: https://hl7.org/fhir/r4/search.html#count | ||
| [`_revinclude`]: https://www.hl7.org/fhir/search.html#revinclude | ||
| [errors]: ../../#client-errors | ||
| [OperationOutcomes]: https://hl7.org/fhir/R4/operationoutcome.html | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <h1 id="clinical">Clinical</h1> | ||
|
|
||
| <p>The Clinical category of HL7<sup>®</sup> FHIR<sup>®</sup> resources includes Summary, Diagnostics, Medications, Care Provision and Request & Response.</p> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| <p>Care Provision resources are used to plan and provision care and treatment.</p> | ||
|
|
||
| <p>Click <a href="https://hl7.org/fhir/r4/resourceguide.html#3.1.2.2">here</a> to see the detailed categorization and full set of resources that fall into this category in the HL7<sup>®</sup> FHIR<sup>®</sup> Standard.</p> | ||
|
There was a problem hiding this comment.
|
||
|
|
||
| <h2 id="implemented-resources">Implemented Resources</h2> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| # frozen_string_literal: true | ||
|
|
||
| module Cerner | ||
| module Resources | ||
|
|
||
| SOARIAN_R4_CAREPLAN_SEARCH_BY_PT_CATEGORY ||= { | ||
| "resourceType": 'Bundle', | ||
| "id": '3454991c-8073-4dad-810f-e21af8da1404', | ||
| "type": 'searchset', | ||
| "timestamp": '2021-03-15T14:15:18-04:00', | ||
| "entry": [ | ||
| { | ||
| "fullUrl": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/CarePlan/494454CC0E254A409CD98DA791EB2E16.DDC.80014', | ||
| "resource": { | ||
| "resourceType": 'CarePlan', | ||
| "id": '494454CC0E254A409CD98DA791EB2E16.DDC.80014', | ||
| "meta": { | ||
| "lastUpdated": '2021-03-15T14:15:02-04:00' | ||
| }, | ||
| "status": 'active', | ||
| "intent": 'plan', | ||
| "category": [ | ||
| { | ||
| "coding": [ | ||
| { | ||
| "system": 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category', | ||
| "code": 'assess-plan' | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "subject": { | ||
| "reference": 'Patient/494454CC0E254A409CD98DA791EB2E16', | ||
| "display": 'Dillow,Raleigh Ada' | ||
| }, | ||
| "encounter": { | ||
| "reference": 'Encounter/494454CC0E254A409CD98DA791EB2E16.1', | ||
| "display": 'City General,Initial' | ||
| }, | ||
| "text": { | ||
| "status": 'additional', | ||
| # rubocop:disable Layout/LineLength | ||
| "div": "<div xmlns='http://www.w3.org/1999/xhtml'><b>CarePlan</b><br /><b>Patient</b>:Dillow,Raleigh Ada<br /><b>Status</b>:active<br /><b>Encounter</b>:City General,Initial<br /><b>Intent</b>:plan<br /><b>Category : </b><b>System</b>:http://hl7.org/fhir/us/core/CodeSystem/careplan-category <b>Code</b>:assess-plan<br /><b>Assessment and Plan</b>:<ul><li>Treatment Plan: Ms. Dillow is a diabetic and her glucose on admission was 91. Her glucose will be strictly monitored during her stay and her AIC will be checked. She has been on a combination of Sitalgliptin and metformin to treat her insulin esistance diabetes. We do not have this combination medicationand will start Ms.Dillow on sliding scale insulin to control her glucose levels.</li></ul><br /></div>" | ||
| # rubocop:enable Layout/LineLength | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "link": [ | ||
| { | ||
| "relation": 'self', | ||
| "url": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/CarePlan?patient=494454CC0E254A409CD98DA791EB2E16&category=assess-plan&_format=json' | ||
| } | ||
| ] | ||
| }.freeze | ||
|
|
||
| SOARIAN_R4_CAREPLAN_SEARCH_BY_ID ||= { | ||
| "resourceType": 'Bundle', | ||
| "id": '3454991c-8073-4dad-810f-e21af8da1404', | ||
| "type": 'searchset', | ||
| "timestamp": '2021-03-15T14:15:18-04:00', | ||
| "entry": [ | ||
| { | ||
| "fullUrl": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/CarePlan/494454CC0E254A409CD98DA791EB2E16.DDC.80014', | ||
| "resource": { | ||
| "resourceType": 'CarePlan', | ||
| "id": '494454CC0E254A409CD98DA791EB2E16.DDC.80014', | ||
| "meta": { | ||
| "lastUpdated": '2021-03-15T14:15:02-04:00' | ||
| }, | ||
| "status": 'active', | ||
| "intent": 'plan', | ||
| "category": [ | ||
| { | ||
| "coding": [ | ||
| { | ||
| "system": 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category', | ||
| "code": 'assess-plan' | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "subject": { | ||
| "reference": 'Patient/494454CC0E254A409CD98DA791EB2E16', | ||
| "display": 'Dillow,Raleigh Ada' | ||
| }, | ||
| "encounter": { | ||
| "reference": 'Encounter/494454CC0E254A409CD98DA791EB2E16.1', | ||
| "display": 'City General,Initial' | ||
| }, | ||
| "text": { | ||
| "status": 'additional', | ||
| # rubocop:disable Layout/LineLength | ||
| "div": "<div xmlns='http://www.w3.org/1999/xhtml'><b>CarePlan</b><br /><b>Patient</b>:Dillow,Raleigh Ada<br /><b>Status</b>:active<br /><b>Encounter</b>:City General,Initial<br /><b>Intent</b>:plan<br /><b>Category : </b><b>System</b>:http://hl7.org/fhir/us/core/CodeSystem/careplan-category <b>Code</b>:assess-plan<br /><b>Assessment and Plan</b>:<ul><li>Treatment Plan: Ms. Dillow is a diabetic and her glucose on admission was 91. Her glucose will be strictly monitored during her stay and her AIC will be checked. She has been on a combination of Sitalgliptin and metformin to treat her insulin esistance diabetes. We do not have this combination medicationand will start Ms.Dillow on sliding scale insulin to control her glucose levels.</li></ul><br /></div>" | ||
| # rubocop:enable Layout/LineLength | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "link": [ | ||
| { | ||
| "relation": 'self', | ||
| "url": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/CarePlan?patient=494454CC0E254A409CD98DA791EB2E16&category=assess-plan&_format=json' | ||
| } | ||
| ] | ||
| }.freeze | ||
|
|
||
| SOARIAN_R4_CAREPLAN_READ_BY_ID ||= { | ||
| "resourceType": 'CarePlan', | ||
| "id": '494454CC0E254A409CD98DA791EB2E16.DDC.80014', | ||
| "meta": { | ||
| "lastUpdated": '2021-03-15T14:15:02-04:00' | ||
| }, | ||
| "status": 'active', | ||
| "intent": 'plan', | ||
| "category": [ | ||
| { | ||
| "coding": [ | ||
| { | ||
| "system": 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category', | ||
| "code": 'assess-plan' | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "subject": { | ||
| "reference": 'Patient/494454CC0E254A409CD98DA791EB2E16', | ||
| "display": 'Dillow,Raleigh Ada' | ||
| }, | ||
| "encounter": { | ||
| "reference": 'Encounter/494454CC0E254A409CD98DA791EB2E16.1', | ||
| "display": 'City General,Initial' | ||
| }, | ||
| "text": { | ||
| "status": 'additional', | ||
| # rubocop:disable Layout/LineLength | ||
| "div": "<div xmlns='http://www.w3.org/1999/xhtml'><b>CarePlan</b><br /><b>Patient</b>:Dillow,Raleigh Ada<br /><b>Status</b>:active<br /><b>Encounter</b>:City General,Initial<br /><b>Intent</b>:plan<br /><b>Category : </b><b>System</b>:http://hl7.org/fhir/us/core/CodeSystem/careplan-category <b>Code</b>:assess-plan<br /><b>Assessment and Plan</b>:<ul><li>Treatment Plan: Ms. Dillow is a diabetic and her glucose on admission was 91. Her glucose will be strictly monitored during her stay and her AIC will be checked. She has been on a combination of Sitalgliptin and metformin to treat her insulin esistance diabetes. We do not have this combination medicationand will start Ms.Dillow on sliding scale insulin to control her glucose levels.</li></ul><br /></div>" | ||
| # rubocop:enable Layout/LineLength | ||
| } | ||
| }.freeze | ||
| end | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| name: CarePlan | ||
| field_name_base_url: https://hl7.org/fhir/R4/careplan-definitions.html#CarePlan | ||
| fields: | ||
| - name: category | ||
| required: 'No' | ||
| type: List of CodeableConcept | ||
| binding: | ||
| description: Type of plan | ||
| terminology: | ||
| - display: Request Category | ||
| system: https://hl7.org/fhir/us/core/CodeSystem/careplan-category | ||
| info_link: https://hl7.org/fhir/R4/valueset-care-plan-category.html |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change the phrase "Care Provision and Request & Response" as follows:
PRODOC-160857.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changes done.