This repository has been archived by the owner on May 7, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 114
Soarian FHIR R4 Encounter Resource Documentation #745
Open
SachinPai04
wants to merge
4
commits into
main
Choose a base branch
from
Soarian_Fhir_R4_Encounter_Write
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5135f9d
Intial commot for Soarian Encounter resource
SachinPai04 4aeacec
Commit Encounter resource.
SachinPai04 822d35d
Merge branch 'Soarian_Fhir_R4_Encounter_Write' of https://github.com/…
SachinPai04 ae7f4d0
Fix for encounter resources
SachinPai04 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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: Management | R4 API | ||
layout: api | ||
--- | ||
|
||
<%= render '/soarian/r4/base/management.*' %> | ||
|
||
* [Encounter](/soarian/r4/base/management/encounter) |
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,148 @@ | ||
--- | ||
title: Encounter | R4 API | ||
--- | ||
|
||
# Encounter | ||
|
||
* TOC | ||
{:toc} | ||
|
||
## Overview | ||
|
||
The Encounter resource provides admissions or visits during which health care services were provided to a patient. An encounter has a class to distinguish between different health care settings such as inpatient, outpatient, emergency and so on. | ||
|
||
Soarian Clinicals<sup>®</sup> supports a read-only Application Programming Interface (API). This API accepts `GET` and `POST` based [search] and 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: | ||
|
||
* [Encounter id](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.id){:target="_blank"} | ||
* [Encounter identifier](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.identifier){:target="_blank"} | ||
* [Status](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.status){:target="_blank"} | ||
* [Class](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.class){:target="_blank"} | ||
* [Type](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.type){:target="_blank"} | ||
* [Subject(Patient only)](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.subject){:target="_blank"} | ||
* [Participant:](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.participant){:target="_blank"} | ||
* [Type](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.participant.type){:target="_blank"} | ||
* [Start/end time of the participation](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.participant.period){:target="_blank"} | ||
* [Individual](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.participant.individual){:target="_blank"} | ||
* [Start/end time of the encounter](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.period){:target="_blank"} | ||
* [Reason for visit](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.reasonCode){:target="_blank"} | ||
* [Hospitalization:](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.hospitalization){:target="_blank"} | ||
* [Discharge disposition](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.hospitalization.dischargeDisposition){:target="_blank"} | ||
* [Location:](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.location){:target="_blank"} | ||
* [Location name](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.location.location){:target="_blank"} | ||
* [Location status](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.location.status){:target="_blank"} | ||
* [Location telecom](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.location.telecom){:target="_blank"} | ||
* [Location address](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.location.address){:target="_blank"} | ||
* [Location managing organization](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.location.managingOrganization){:target="_blank"} | ||
|
||
|
||
## Terminology Bindings | ||
|
||
<%= terminology_table(:soarian_encounter, :r4) %> | ||
|
||
## Search | ||
|
||
Search for Encounter resources that meet the specified query parameters: | ||
|
||
GET /Encounter?:parameters | ||
|
||
_Implementation Notes_ | ||
|
||
* [Encounter.location.location](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.location.location) is always returned as a reference to a [contained](https://hl7.org/fhir/r4/references.html#contained) Location resource . | ||
|
||
### 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 encounter. | ||
`date` | No | [`date`] | Date range into which the encounter falls. Example: `date=gt2014-09-24 or date=lt2015-09-24T12:00:00.000Z` | ||
`_revinclude` | No | [`_revinclude`] | A request to include any Provenance resource in the bundle that refers to an Encounter resource in the search results. Only supported with Provenance. | ||
|
||
Notes | ||
|
||
* The `date` parameter may be provided up to two times, and must use the `eq`, `ge`, `gt`, `le`, or `lt` prefixes. When a value is provided without a prefix, an implied `eq` prefix is used. When provided twice, the lower value must have a `ge` or `gt` prefix and the higher value must have an `le` or `lt` prefix. | ||
|
||
|
||
### Headers | ||
|
||
<%= headers fhir_json: true %> | ||
|
||
### Example Search by Patient | ||
|
||
#### Request | ||
|
||
GET https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F | ||
|
||
#### Response | ||
|
||
<%= headers status: 200 %> | ||
<%= json(:SOARIAN_R4_ENCOUNTER_SEARCH_BY_PT_ENTRY) %> | ||
|
||
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/Encounter?_id=A879904FD2FE4B2D90C89FDA84E1285F.29019 | ||
|
||
#### Response | ||
|
||
<%= headers status: 200 %> | ||
<%= json(:SOARIAN_R4_ENCOUNTER_SEARCH_BY_ID_ENTRY) %> | ||
|
||
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](https://www.hl7.org/fhir/r4/operationoutcome.html) may be returned. | ||
|
||
## Retrieve by ID | ||
|
||
List an individual Encounter resource by its ID: | ||
|
||
GET /Encounter/:id | ||
|
||
_Implementation Notes_ | ||
|
||
* [Encounter.location.location](https://hl7.org/fhir/r4/encounter-definitions.html#Encounter.location.location) is always returned as a reference to a [contained](https://hl7.org/fhir/r4/references.html#contained) Location resource. | ||
|
||
## 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/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019 | ||
|
||
#### Response | ||
|
||
<%= headers status: 200 %> | ||
<%= json(:SOARIAN_R4_ENCOUNTER_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](https://www.hl7.org/fhir/r4/operationoutcome.html) may be returned. | ||
|
||
[search]: https://www.hl7.org/fhir/http.html#search | ||
[read]: https://www.hl7.org/fhir/http.html#read | ||
[`date`]: https://hl7.org/fhir/R4/search.html#date | ||
[`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 @@ | ||
<p>Management resources are used to manage the lifecycle of patients within the healthcare setting.</p> | ||
|
||
<h3 id="implemented-resources">Implemented Resources</h3> |
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
Oops, something went wrong.
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.
In the second sentence, please add a comma after "emergency".
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 updated.