diff --git a/content/soarian/r4/clinical.md b/content/soarian/r4/clinical.md new file mode 100644 index 000000000..5cb36f850 --- /dev/null +++ b/content/soarian/r4/clinical.md @@ -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) diff --git a/content/soarian/r4/clinical/care-provision.md b/content/soarian/r4/clinical/care-provision.md new file mode 100644 index 000000000..43bf95071 --- /dev/null +++ b/content/soarian/r4/clinical/care-provision.md @@ -0,0 +1,8 @@ +--- +title: Care Provision | R4 API +layout: api +--- + +<%= render '/soarian/r4/clinical/care-provision.*' %> + +* [CarePlan](../care-provision/care-plan) diff --git a/content/soarian/r4/clinical/care-provision/care-plan.md b/content/soarian/r4/clinical/care-provision/care-plan.md new file mode 100644 index 000000000..32b8f4f6d --- /dev/null +++ b/content/soarian/r4/clinical/care-provision/care-plan.md @@ -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® 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® 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, system: 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, system: 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 + + + + + diff --git a/layouts/soarian/r4/clinical.html b/layouts/soarian/r4/clinical.html new file mode 100644 index 000000000..ab0e04a2d --- /dev/null +++ b/layouts/soarian/r4/clinical.html @@ -0,0 +1,3 @@ +

Clinical

+ +

The Clinical category of HL7® FHIR® resources includes Summary, Diagnostics, Medications, Care Provision, Request and Response.

diff --git a/layouts/soarian/r4/clinical/care-provision.html b/layouts/soarian/r4/clinical/care-provision.html new file mode 100644 index 000000000..e2b8420a8 --- /dev/null +++ b/layouts/soarian/r4/clinical/care-provision.html @@ -0,0 +1,5 @@ +

Care Provision resources are used to plan and provision care and treatment.

+ +

See here for the detailed categorization and full set of resources that fall into this category in the HL7® FHIR® Standard.

+ +

Implemented Resources

diff --git a/layouts/soarian/r4/sidebar.html b/layouts/soarian/r4/sidebar.html index fa276e50e..49f3c9857 100644 --- a/layouts/soarian/r4/sidebar.html +++ b/layouts/soarian/r4/sidebar.html @@ -16,7 +16,14 @@

  • Individuals
  • Patient
    • - + +
  • +

    Clinical

    + +
    • diff --git a/lib/resources/example_json/soarian_r4_examples_care_plan.rb b/lib/resources/example_json/soarian_r4_examples_care_plan.rb new file mode 100644 index 000000000..7d034f698 --- /dev/null +++ b/lib/resources/example_json/soarian_r4_examples_care_plan.rb @@ -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": "
    CarePlan
    Patient:Dillow,Raleigh Ada
    Status:active
    Encounter:City General,Initial
    Intent:plan
    Category : System:http://hl7.org/fhir/us/core/CodeSystem/careplan-category Code:assess-plan
    Assessment and Plan:
    • 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.

    " + # 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": "
    CarePlan
    Patient:Dillow,Raleigh Ada
    Status:active
    Encounter:City General,Initial
    Intent:plan
    Category : System:http://hl7.org/fhir/us/core/CodeSystem/careplan-category Code:assess-plan
    Assessment and Plan:
    • 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.

    " + # 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": "
    CarePlan
    Patient:Dillow,Raleigh Ada
    Status:active
    Encounter:City General,Initial
    Intent:plan
    Category : System:http://hl7.org/fhir/us/core/CodeSystem/careplan-category Code:assess-plan
    Assessment and Plan:
    • 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.

    " + # rubocop:enable Layout/LineLength + } + }.freeze + end +end diff --git a/lib/resources/r4/soarian_care_plan.yaml b/lib/resources/r4/soarian_care_plan.yaml new file mode 100644 index 000000000..0a803c316 --- /dev/null +++ b/lib/resources/r4/soarian_care_plan.yaml @@ -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