This repository has been archived by the owner on May 7, 2024. It is now read-only.
Soarian Fhir R4 Goal Resource Documentation #759
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.*' %> | ||
|
|
||
| * [Goal](/soarian/r4/clinical/care-provision/goal) |
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.*' %> | ||
|
|
||
| * [Goal](../care-provision/goal) |
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,119 @@ | ||
| --- | ||
| title: Goal | R4 API | ||
| --- | ||
|
|
||
| # Goal | ||
|
|
||
| * TOC | ||
| {:toc} | ||
|
|
||
| ## Overview | ||
|
|
||
| The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state for a patient to achieve over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be nonhealth care related (for example, to dance at a wedding). | ||
|
|
||
| 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: | ||
|
|
||
| * [Goal id](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} | ||
| * [Lifecycle Status](https://hl7.org/fhir/r4/goal-definitions.html#Goal.lifecycleStatus){:target="_blank"} | ||
| * [Description](https://hl7.org/fhir/r4/goal-definitions.html#Goal.description){:target="_blank"} | ||
| * [Subject (Patient only)](https://hl7.org/fhir/r4/goal-definitions.html#Goal.subject){:target="_blank"} | ||
| * [Target Due Date](https://hl7.org/fhir/r4/goal-definitions.html#Goal.target.due_x_){:target="_blank"} | ||
|
|
||
| ## Search | ||
|
|
||
| Search for Goal resources that meet the specified query parameters: | ||
|
|
||
| GET/Goal?: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 goal. | ||
| `_revinclude` | No | [`_revinclude`] | A request to include any Provenance resource in the bundle that refers to a Goal resource in the search results. Only supported with Provenance. | ||
|
|
||
|
There was a problem hiding this comment. can we reuse the revinclude notes from here https://github.com/cerner/fhir.cerner.com/pull/677/files#diff-7b4907a64ed4a5fda66147bdbf13c90120e8b4a4c8075a925136b9e13a390b11R66 There was a problem hiding this comment. I checked and it is same as Patient resource. can you please point out the exact changes needed! |
||
| Notes: | ||
|
|
||
| * 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 | ||
|
|
||
| #### Request | ||
|
|
||
| GET https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F | ||
|
|
||
|
There was a problem hiding this comment. Urls of the tenant key needs to be of prod domain ,I see different tenant key in most the examples. |
||
| #### Response | ||
|
|
||
| <%= headers status: 200 %> | ||
| <%= json(:SOARIAN_R4_GOAL_SEARCH_BY_PT) %> | ||
|
|
||
| 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/Goal?_id=A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083 | ||
|
|
||
| #### Response | ||
|
|
||
| <%= headers status: 200 %> | ||
| <%= json(:SOARIAN_R4_GOAL_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] and [OperationOutcomes] may be returned. | ||
|
|
||
| ## Retrieve by ID | ||
|
|
||
| List an individual Goal Resource by its ID: | ||
|
|
||
| GET /Goal/: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/Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083 | ||
|
|
||
| #### Response | ||
|
|
||
| <%= headers status: 200 %> | ||
| <%= json(:SOARIAN_R4_GOAL_READ) %> | ||
|
|
||
| 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 | ||
| [`_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, Request and 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>See <a href="https://hl7.org/fhir/r4/resourceguide.html#3.1.2.2">here</a> for the detailed categorization and full set of resources that fall into this category in the HL7<sup>®</sup> FHIR<sup>®</sup> Standard.</p> | ||
|
|
||
| <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,121 @@ | ||
| # frozen_string_literal: true | ||
|
|
||
| module Cerner | ||
| module Resources | ||
|
|
||
| SOARIAN_R4_GOAL_SEARCH_BY_PT ||= { | ||
| "resourceType": 'Bundle', | ||
| "id": '0cebf130-3245-405e-9e83-96c498cbd602', | ||
| "type": 'searchset', | ||
| "timestamp": '2021-02-19T17:24:44-05:00', | ||
| "entry": [ | ||
| { | ||
| "fullUrl": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083', | ||
| "resource": { | ||
| "resourceType": 'Goal', | ||
| "id": 'A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083', | ||
| "meta": { | ||
| "lastUpdated": '2020-11-15T16:21:24-05:00' | ||
| }, | ||
| "lifecycleStatus": 'active', | ||
| "subject": { | ||
| "reference": 'Patient/A879904FD2FE4B2D90C89FDA84E1285F', | ||
| "display": 'Mcgovern,Astrid Santiago' | ||
| }, | ||
| "target": [ | ||
| { | ||
| "dueDate": '2022-11-30' | ||
| } | ||
| ], | ||
| "text": { | ||
| "status": 'generated', | ||
| # rubocop:disable Layout/LineLength | ||
| "div": '<div xmlns="http://www.w3.org/1999/xhtml"><b>Goal</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /><b>Status</b>:active<br /><b>DueDate</b>:2022-11-30<br /><b>Description</b>:<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br /></div>' | ||
| # rubocop:enable Layout/LineLength | ||
| }, | ||
| "description": { | ||
| "text": '<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br/>' | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "link": [ | ||
| { | ||
| "relation": 'self', | ||
| "url": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json' | ||
| } | ||
| ] | ||
| }.freeze | ||
|
|
||
| SOARIAN_R4_GOAL_SEARCH_BY_ID ||= { | ||
| "resourceType": 'Bundle', | ||
| "id": '0cebf130-3245-405e-9e83-96c498cbd602', | ||
| "type": 'searchset', | ||
| "timestamp": '2021-02-19T17:24:44-05:00', | ||
| "entry": [ | ||
| { | ||
| "fullUrl": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083', | ||
| "resource": { | ||
| "resourceType": 'Goal', | ||
| "id": 'A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083', | ||
| "meta": { | ||
| "lastUpdated": '2020-11-15T16:21:24-05:00' | ||
| }, | ||
| "lifecycleStatus": 'active', | ||
| "subject": { | ||
| "reference": 'Patient/A879904FD2FE4B2D90C89FDA84E1285F', | ||
| "display": 'Mcgovern,Astrid Santiago' | ||
| }, | ||
| "target": [ | ||
| { | ||
| "dueDate": '2022-11-30' | ||
| } | ||
| ], | ||
| "text": { | ||
| "status": 'generated', | ||
| # rubocop:disable Layout/LineLength | ||
| "div": '<div xmlns="http://www.w3.org/1999/xhtml"><b>Goal</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /><b>Status</b>:active<br /><b>DueDate</b>:2022-11-30<br /><b>Description</b>:<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br /></div>' | ||
| # rubocop:enable Layout/LineLength | ||
| }, | ||
| "description": { | ||
| "text": '<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br/>' | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "link": [ | ||
| { | ||
| "relation": 'self', | ||
| "url": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json' | ||
| } | ||
| ] | ||
| }.freeze | ||
|
|
||
| SOARIAN_R4_GOAL_READ ||= { | ||
| "resourceType": 'Goal', | ||
| "id": 'A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083', | ||
| "meta": { | ||
| "lastUpdated": '2020-11-15T16:21:24-05:00' | ||
| }, | ||
| "lifecycleStatus": 'active', | ||
| "subject": { | ||
| "reference": 'Patient/A879904FD2FE4B2D90C89FDA84E1285F', | ||
| "display": 'Mcgovern,Astrid Santiago' | ||
| }, | ||
| "target": [ | ||
| { | ||
| "dueDate": '2022-11-30' | ||
| } | ||
| ], | ||
| "text": { | ||
| "status": 'generated', | ||
| # rubocop:disable Layout/LineLength | ||
| "div": '<div xmlns="http://www.w3.org/1999/xhtml"><b>Goal</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /><b>Status</b>:active<br /><b>DueDate</b>:2022-11-30<br /><b>Description</b>:<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br /></div>' | ||
| # rubocop:enable Layout/LineLength | ||
| }, | ||
| "description": { | ||
| "text": '<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br/>' | ||
| } | ||
| }.freeze | ||
| end | ||
| end |
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.
I see that soarian accepts read only application , so the calls should be of get ? Do we use POST calls in any of the specific cases ?