From 5135f9d33ec78d93bf44ef5a2bd3597cee988cf7 Mon Sep 17 00:00:00 2001 From: "WHQ_NT_DOMAIN\\SP071896" Date: Tue, 28 Sep 2021 00:50:04 -0400 Subject: [PATCH 1/3] Intial commot for Soarian Encounter resource --- content/soarian/r4/base.md | 7 +- content/soarian/r4/base/management.md | 8 + .../soarian/r4/base/management/encounter.md | 135 +++++ layouts/soarian/r4/base/management.html | 5 + layouts/soarian/r4/management.html | 5 + layouts/soarian/r4/sidebar.html | 4 +- .../soarian_r4_examples_encounter.rb | 553 ++++++++++++++++++ lib/resources/r4/soarian_encounter.yaml | 73 +++ 8 files changed, 788 insertions(+), 2 deletions(-) create mode 100644 content/soarian/r4/base/management.md create mode 100644 content/soarian/r4/base/management/encounter.md create mode 100644 layouts/soarian/r4/base/management.html create mode 100644 layouts/soarian/r4/management.html create mode 100644 lib/resources/example_json/soarian_r4_examples_encounter.rb create mode 100644 lib/resources/r4/soarian_encounter.yaml diff --git a/content/soarian/r4/base.md b/content/soarian/r4/base.md index 3ca4d227a..979f102e1 100644 --- a/content/soarian/r4/base.md +++ b/content/soarian/r4/base.md @@ -8,4 +8,9 @@ layout: api ## Individuals <%= render '/soarian/r4/base/individuals.*' %> -* [Patient](/soarian/r4/base/individuals/patient) \ No newline at end of file +* [Patient](/soarian/r4/base/individuals/patient) + +## Management +<%= render '/soarian/r4/base/management.*' %> + +* [Encounter](/soarian/r4/base/management/encounter) diff --git a/content/soarian/r4/base/management.md b/content/soarian/r4/base/management.md new file mode 100644 index 000000000..4a15e7399 --- /dev/null +++ b/content/soarian/r4/base/management.md @@ -0,0 +1,8 @@ +--- +title: Encounters | R4 API +layout: api +--- + +<%= render '/soarian/r4/base/management.*' %> + +* [Encounter](/soarian/r4/base/management/encounter) \ No newline at end of file diff --git a/content/soarian/r4/base/management/encounter.md b/content/soarian/r4/base/management/encounter.md new file mode 100644 index 000000000..0b45fcd1a --- /dev/null +++ b/content/soarian/r4/base/management/encounter.md @@ -0,0 +1,135 @@ +--- +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® supports a read-only Application Programming Interface (API). This API accepts`GET` and `POST` based [search](https://www.hl7.org/fhir/http.html#search) 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: + +* [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`](http://hl7.org/fhir/R4/search.html#token) | The logical resource ID associated with the resource + `patient` | This, or `_id` | [`reference`](http://hl7.org/fhir/R4/search.html#reference) | The patient who has the encounter. + `date` | No | [`date`](http://hl7.org/fhir/R4/search.html#date) | Date range into which the encounter falls. Example: `date=gt2014-09-24 or date=lt2015-09-24T12:00:00.000Z` + `_revinclude` | No | [`_revinclude`](http://hl7.org/fhir/R4/search.html#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.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/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.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/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.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/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. diff --git a/layouts/soarian/r4/base/management.html b/layouts/soarian/r4/base/management.html new file mode 100644 index 000000000..0b0c51d9c --- /dev/null +++ b/layouts/soarian/r4/base/management.html @@ -0,0 +1,5 @@ +

Encounters

+ +

The Encounters resources are used to manage the lifecycle of patient encounters within the healthcare setting.

+ +

Implemented Resources

\ No newline at end of file diff --git a/layouts/soarian/r4/management.html b/layouts/soarian/r4/management.html new file mode 100644 index 000000000..0b0c51d9c --- /dev/null +++ b/layouts/soarian/r4/management.html @@ -0,0 +1,5 @@ +

Encounters

+ +

The Encounters resources are used to manage the lifecycle of patient encounters within the healthcare setting.

+ +

Implemented Resources

\ No newline at end of file diff --git a/layouts/soarian/r4/sidebar.html b/layouts/soarian/r4/sidebar.html index fa276e50e..6522ca371 100644 --- a/layouts/soarian/r4/sidebar.html +++ b/layouts/soarian/r4/sidebar.html @@ -16,7 +16,9 @@

  • Individuals
  • Patient
    • - +
  • Management
    • +
  • Encounter
    • +
    diff --git a/lib/resources/example_json/soarian_r4_examples_encounter.rb b/lib/resources/example_json/soarian_r4_examples_encounter.rb new file mode 100644 index 000000000..7c6248ce1 --- /dev/null +++ b/lib/resources/example_json/soarian_r4_examples_encounter.rb @@ -0,0 +1,553 @@ +# frozen_string_literal: true + +module Cerner + module Resources + + SOARIAN_R4_ENCOUNTER_READ_BY_ID ||= { + "resourceType": "Encounter", + "id": "A879904FD2FE4B2D90C89FDA84E1285F.29019", + "meta": { + "lastUpdated": "2021-01-21T15:08:01-05:00" + }, + "status": "in-progress", + "class": { + "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "code": "IMP", + "display": "inpatient encounter" + }, + "subject": { + "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F", + "display": "Mcgovern,Astrid Santiago" + }, + "period": { + "start": "2020-04-15T16:42:00-04:00" + }, + "location": [ + { + "location": { + "reference": "#35202" + } + } + ], + "identifier": [ + { + "system": "urn:oid:12.00.021.1.3.7.5", + "value": "29019" + }, + { + "system": "urn:oid:12.00.021.1.3.7.3", + "value": "1001004" + }, + { + "system": "urn:oid:12.00.021.1.3.7.4", + "value": "1001004" + } + ], + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", + "code": "unknown", + "display": "Unknown" + } + ] + } + ], + "reasonCode": [ + { + "text": "Pain left side of the body" + } + ], + "participant": [ + { + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "ATND", + "display": "attender" + } + ], + "text": "Attending Doctor" + } + ], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", + "display": "Godziszewski,Janet Kris" + } + }, + { + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "CON", + "display": "consultant" + } + ], + "text": "Consulting Doctor" + } + ], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/4F69EC72C5AA48988E5E73832887E634", + "display": "Aguilar,Melva Delaine" + } + }, + { + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "CON", + "display": "consultant" + } + ], + "text": "Consulting Doctor" + } + ], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0", + "display": "O'Reilly,Rose" + } + }, + { + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "ADM", + "display": "admitter" + } + ], + "text": "Admitting Doctor" + } + ], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", + "display": "Godziszewski,Janet Kris" + } + } + ], + "contained": [ + { + "resourceType": "Location", + "name": "Inferno", + "id": "35202", + "status": "active", + "telecom": [ + { + "system": "phone", + "value": "6102196300" + }, + { + "system": "fax", + "value": "6102196300" + } + ], + "address": { + "use": "work", + "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States", + "line": [ + "53 Valley Stream Parkway" + ], + "city": "Malvern", + "state": "PA", + "postalCode": "19355", + "country": "United States" + }, + "managingOrganization": { + "reference": "Organization/HCU.1", + "display": "Health Enterprise" + } + } + ], + "text": { + "status": "generated", + "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " + } +}.freeze + + + SOARIAN_R4_ENCOUNTER_SEARCH_BY_ID_ENTRY ||= { + "resourceType": "Bundle", + "id": "250f967f-c78a-49a8-929f-2782c8722020", + "type": "searchset", + "timestamp": "2021-03-04T14:53:32-05:00", + "entry": [{ + "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019", + "resource": { + "resourceType": "Encounter", + "id": "A879904FD2FE4B2D90C89FDA84E1285F.29019", + "meta": { + "lastUpdated": "2021-01-21T15:08:01-05:00" + }, + "status": "in-progress", + "class": { + "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "code": "IMP", + "display": "inpatient encounter" + }, + "subject": { + "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F", + "display": "Mcgovern,Astrid Santiago" + }, + "period": { + "start": "2020-04-15T16:42:00-04:00" + }, + "location": [{ + "location": { + "reference": "#35202" + } + }], + "identifier": [{ + "system": "urn:oid:12.00.021.1.3.7.5", + "value": "29019" + }, + { + "system": "urn:oid:12.00.021.1.3.7.3", + "value": "1001004" + }, + { + "system": "urn:oid:12.00.021.1.3.7.4", + "value": "1001004" + } + ], + "type": [{ + "coding": [{ + "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", + "code": "unknown", + "display": "Unknown" + }] + }], + "reasonCode": [{ + "text": "Pain left side of the body" + }], + "participant": [{ + "type": [{ + "coding": [{ + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "ATND", + "display": "attender" + }], + "text": "Attending Doctor" + }], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", + "display": "Godziszewski,Janet Kris" + } + }, + { + "type": [{ + "coding": [{ + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "CON", + "display": "consultant" + }], + "text": "Consulting Doctor" + }], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/4F69EC72C5AA48988E5E73832887E634", + "display": "Aguilar,Melva Delaine" + } + }, + { + "type": [{ + "coding": [{ + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "CON", + "display": "consultant" + }], + "text": "Consulting Doctor" + }], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0", + "display": "O'Reilly,Rose" + } + }, + { + "type": [{ + "coding": [{ + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "ADM", + "display": "admitter" + }], + "text": "Admitting Doctor" + }], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", + "display": "Godziszewski,Janet Kris" + } + } + ], + "contained": [{ + "resourceType": "Location", + "name": "Inferno", + "id": "35202", + "status": "active", + "telecom": [{ + "system": "phone", + "value": "6102196300" + }, + { + "system": "fax", + "value": "6102196300" + } + ], + "address": { + "use": "work", + "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States", + "line": [ + "53 Valley Stream Parkway" + ], + "city": "Malvern", + "state": "PA", + "postalCode": "19355", + "country": "United States" + }, + "managingOrganization": { + "reference": "Organization/HCU.1", + "display": "Health Enterprise" + } + }], + "text": { + "status": "generated", + "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " + } + } + }], + "link": [{ + "relation": "self", + "url": "https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json" + }] +}.freeze + + + SOARIAN_R4_ENCOUNTER_SEARCH_BY_PT_ENTRY ||= { + "resourceType": "Bundle", + "id": "250f967f-c78a-49a8-929f-2782c8722020", + "type": "searchset", + "timestamp": "2021-03-04T14:53:32-05:00", + "entry": [ + { + "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019", + "resource": { + "resourceType": "Encounter", + "id": "A879904FD2FE4B2D90C89FDA84E1285F.29019", + "meta": { + "lastUpdated": "2021-01-21T15:08:01-05:00" + }, + "status": "in-progress", + "class": { + "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "code": "IMP", + "display": "inpatient encounter" + }, + "subject": { + "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F", + "display": "Mcgovern,Astrid Santiago" + }, + "period": { + "start": "2020-04-15T16:42:00-04:00" + }, + "location": [ + { + "location": { + "reference": "#35202" + } + } + ], + "identifier": [ + { + "system": "urn:oid:12.00.021.1.3.7.5", + "value": "29019" + }, + { + "system": "urn:oid:12.00.021.1.3.7.3", + "value": "1001004" + }, + { + "system": "urn:oid:12.00.021.1.3.7.4", + "value": "1001004" + } + ], + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", + "code": "unknown", + "display": "Unknown" + } + ] + } + ], + "reasonCode": [ + { + "text": "Pain left side of the body" + } + ], + "participant": [ + { + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "ATND", + "display": "attender" + } + ], + "text": "Attending Doctor" + } + ], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", + "display": "Godziszewski,Janet Kris" + } + }, + { + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "CON", + "display": "consultant" + } + ], + "text": "Consulting Doctor" + } + ], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/4F69EC72C5AA48988E5E73832887E634", + "display": "Aguilar,Melva Delaine" + } + }, + { + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "CON", + "display": "consultant" + } + ], + "text": "Consulting Doctor" + } + ], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0", + "display": "O'Reilly,Rose" + } + }, + { + "type": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", + "code": "ADM", + "display": "admitter" + } + ], + "text": "Admitting Doctor" + } + ], + "period": { + "start": "2020-11-11T20:53:00-05:00" + }, + "individual": { + "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", + "display": "Godziszewski,Janet Kris" + } + } + ], + "contained": [ + { + "resourceType": "Location", + "name": "Inferno", + "id": "35202", + "status": "active", + "telecom": [ + { + "system": "phone", + "value": "6102196300" + }, + { + "system": "fax", + "value": "6102196300" + } + ], + "address": { + "use": "work", + "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States", + "line": [ + "53 Valley Stream Parkway" + ], + "city": "Malvern", + "state": "PA", + "postalCode": "19355", + "country": "United States" + }, + "managingOrganization": { + "reference": "Organization/HCU.1", + "display": "Health Enterprise" + } + } + ], + "text": { + "status": "generated", + "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " + } + } + } + ], + "link": [ + { + "relation": "self", + "url": "https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json" + } + ] +}.freeze + end +end + \ No newline at end of file diff --git a/lib/resources/r4/soarian_encounter.yaml b/lib/resources/r4/soarian_encounter.yaml new file mode 100644 index 000000000..f6d7fee3c --- /dev/null +++ b/lib/resources/r4/soarian_encounter.yaml @@ -0,0 +1,73 @@ +--- +name: Encounter +field_name_base_url: https://hl7.org/fhir/r4/encounter-definitions.html#Encounter +fields: +- name: resourceType + required: 'Yes' + type: string + description: The type of the FHIR resource. + action: create + note: resourceType must be Encounter + url: https://hl7.org/fhir/r4/json.html#resources + +- name: type + required: 'Yes' + type: List of CodeableConcept + description: The specific type of encounter. + binding: + description: The type of encounter. + terminology: + - display: CPT + system: http://www.ama-assn.org/go4/cpt + info_link: https://hl7.org/fhir/R4/cpt.html + +- name: participant + required: 'No' + type: List of BackboneElement + description: The list of people responsible for providing the service. + + children: + + - name: type + required: 'Yes' + type: List of CodeableConcept + description: Role of participant in encounter. + binding: + description: Role of participant in encounter. + terminology: + - display: ParticipantType + system: http://terminology.hl7.org/CodeSystem/v3-ParticipationType + info_link: https://hl7.org/fhir/r4/valueset-encounter-participant-type.html + +- name: reasonCode + required: 'No' + type: List of CodeableConcept + description: The reason that the encounter is taking place. + action: create + binding: + description: Reason the encounter takes place. + terminology: + - display: ParticipantType + system: http://hl7.org/fhir/sid/icd-9-cm and http://hl7.org/fhir/sid/icd-10-cm + info_link: https://hl7.org/fhir/r4/icd.html + + +- name: hospitalization + required: 'No' + type: BackboneElement + description: Details about the admission to a healthcare service. + + children: + + - name: dischargeDisposition + required: 'No' + type: CodeableConcept + description: Category or kind of location after discharge. + binding: + description: Discharge Disposition. + terminology: + - display: Category or kind of location after discharge + system: http://www.nubc.org/patient-discharge + info_link: https://www.nubc.org/ + + From 4aeacec7d61fae8025e7de90523ed8efaa610cd7 Mon Sep 17 00:00:00 2001 From: "WHQ_NT_DOMAIN\\SP071896" Date: Fri, 1 Oct 2021 07:57:05 -0400 Subject: [PATCH 2/3] Commit Encounter resource. --- content/soarian/r4/base/management.md | 2 +- .../soarian/r4/base/management/encounter.md | 29 +- layouts/soarian/r4/base/management.html | 6 +- layouts/soarian/r4/management.html | 5 - layouts/soarian/r4/sidebar.html | 3 +- .../soarian_r4_examples_encounter.rb | 1088 ++++++++--------- 6 files changed, 570 insertions(+), 563 deletions(-) delete mode 100644 layouts/soarian/r4/management.html diff --git a/content/soarian/r4/base/management.md b/content/soarian/r4/base/management.md index 4a15e7399..cbcef8b51 100644 --- a/content/soarian/r4/base/management.md +++ b/content/soarian/r4/base/management.md @@ -1,5 +1,5 @@ --- -title: Encounters | R4 API +title: Management | R4 API layout: api --- diff --git a/content/soarian/r4/base/management/encounter.md b/content/soarian/r4/base/management/encounter.md index 0b45fcd1a..538182c1b 100644 --- a/content/soarian/r4/base/management/encounter.md +++ b/content/soarian/r4/base/management/encounter.md @@ -11,7 +11,7 @@ title: Encounter | R4 API 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® supports a read-only Application Programming Interface (API). This API accepts`GET` and `POST` based [search](https://www.hl7.org/fhir/http.html#search) interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals® at the time of the query. +Soarian Clinicals® 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® at the time of the query. The search results include the following fields if they contain values: @@ -59,10 +59,10 @@ _Implementation Notes_ Name | Required? | Type | Description ---------------|----------------------------------------|---------------------------------------------------------------| - `_id` | This, or `patient` | [`token`](http://hl7.org/fhir/R4/search.html#token) | The logical resource ID associated with the resource - `patient` | This, or `_id` | [`reference`](http://hl7.org/fhir/R4/search.html#reference) | The patient who has the encounter. - `date` | No | [`date`](http://hl7.org/fhir/R4/search.html#date) | Date range into which the encounter falls. Example: `date=gt2014-09-24 or date=lt2015-09-24T12:00:00.000Z` - `_revinclude` | No | [`_revinclude`](http://hl7.org/fhir/R4/search.html#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. + `_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 @@ -77,7 +77,7 @@ _Implementation Notes_ #### Request - GET https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F + GET https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F #### Response @@ -90,7 +90,7 @@ Note: The examples provided here are non-normative and replaying them in the pub #### Request - GET https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter?_id=A879904FD2FE4B2D90C89FDA84E1285F.29019 + GET https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Encounter?_id=A879904FD2FE4B2D90C89FDA84E1285F.29019 #### Response @@ -125,7 +125,7 @@ _Implementation Notes_ #### Request - GET https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019 + GET https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019 #### Response @@ -133,3 +133,16 @@ _Implementation Notes_ <%= 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 diff --git a/layouts/soarian/r4/base/management.html b/layouts/soarian/r4/base/management.html index 0b0c51d9c..860001a49 100644 --- a/layouts/soarian/r4/base/management.html +++ b/layouts/soarian/r4/base/management.html @@ -1,5 +1,3 @@ -

    Encounters

    +

    Management resources are used to manage the lifecycle of patients within the healthcare setting.

    -

    The Encounters resources are used to manage the lifecycle of patient encounters within the healthcare setting.

    - -

    Implemented Resources

    \ No newline at end of file +

    Implemented Resources

    diff --git a/layouts/soarian/r4/management.html b/layouts/soarian/r4/management.html deleted file mode 100644 index 0b0c51d9c..000000000 --- a/layouts/soarian/r4/management.html +++ /dev/null @@ -1,5 +0,0 @@ -

    Encounters

    - -

    The Encounters resources are used to manage the lifecycle of patient encounters within the healthcare setting.

    - -

    Implemented Resources

    \ No newline at end of file diff --git a/layouts/soarian/r4/sidebar.html b/layouts/soarian/r4/sidebar.html index 6522ca371..b54bb6bf6 100644 --- a/layouts/soarian/r4/sidebar.html +++ b/layouts/soarian/r4/sidebar.html @@ -16,7 +16,8 @@

  • Individuals
  • Patient
    • -
  • Management
    • + +
  • Management
  • Encounter
    • diff --git a/lib/resources/example_json/soarian_r4_examples_encounter.rb b/lib/resources/example_json/soarian_r4_examples_encounter.rb index 7c6248ce1..6d0ea5acc 100644 --- a/lib/resources/example_json/soarian_r4_examples_encounter.rb +++ b/lib/resources/example_json/soarian_r4_examples_encounter.rb @@ -3,551 +3,551 @@ module Cerner module Resources - SOARIAN_R4_ENCOUNTER_READ_BY_ID ||= { - "resourceType": "Encounter", - "id": "A879904FD2FE4B2D90C89FDA84E1285F.29019", - "meta": { - "lastUpdated": "2021-01-21T15:08:01-05:00" - }, - "status": "in-progress", - "class": { - "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", - "code": "IMP", - "display": "inpatient encounter" - }, - "subject": { - "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F", - "display": "Mcgovern,Astrid Santiago" - }, - "period": { - "start": "2020-04-15T16:42:00-04:00" - }, - "location": [ - { - "location": { - "reference": "#35202" - } - } - ], - "identifier": [ - { - "system": "urn:oid:12.00.021.1.3.7.5", - "value": "29019" - }, - { - "system": "urn:oid:12.00.021.1.3.7.3", - "value": "1001004" - }, - { - "system": "urn:oid:12.00.021.1.3.7.4", - "value": "1001004" - } - ], - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", - "code": "unknown", - "display": "Unknown" - } - ] - } - ], - "reasonCode": [ - { - "text": "Pain left side of the body" - } - ], - "participant": [ - { - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "ATND", - "display": "attender" - } - ], - "text": "Attending Doctor" - } - ], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", - "display": "Godziszewski,Janet Kris" - } - }, - { - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "CON", - "display": "consultant" - } - ], - "text": "Consulting Doctor" - } - ], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/4F69EC72C5AA48988E5E73832887E634", - "display": "Aguilar,Melva Delaine" - } - }, - { - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "CON", - "display": "consultant" - } - ], - "text": "Consulting Doctor" - } - ], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0", - "display": "O'Reilly,Rose" - } - }, - { - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "ADM", - "display": "admitter" - } - ], - "text": "Admitting Doctor" - } - ], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", - "display": "Godziszewski,Janet Kris" - } - } - ], - "contained": [ - { - "resourceType": "Location", - "name": "Inferno", - "id": "35202", - "status": "active", - "telecom": [ - { - "system": "phone", - "value": "6102196300" - }, - { - "system": "fax", - "value": "6102196300" - } - ], - "address": { - "use": "work", - "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States", - "line": [ - "53 Valley Stream Parkway" - ], - "city": "Malvern", - "state": "PA", - "postalCode": "19355", - "country": "United States" - }, - "managingOrganization": { - "reference": "Organization/HCU.1", - "display": "Health Enterprise" - } - } - ], - "text": { - "status": "generated", - "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " - } -}.freeze + SOARIAN_R4_ENCOUNTER_READ_BY_ID ||= { + "resourceType": 'Encounter', + "id": 'A879904FD2FE4B2D90C89FDA84E1285F.29019', + "meta": { + "lastUpdated": '2021-01-21T15:08:01-05:00' + }, + "status": 'in-progress', + "class": { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ActCode', + "code": 'IMP', + "display": 'inpatient encounter' + }, + "subject": { + "reference": 'Patient/A879904FD2FE4B2D90C89FDA84E1285F', + "display": 'Mcgovern,Astrid Santiago' + }, + "period": { + "start": '2020-04-15T16:42:00-04:00' + }, + "location": [ + { + "location": { + "reference": '#35202' + } + } + ], + "identifier": [ + { + "system": 'urn:oid:12.00.021.1.3.7.5', + "value": '29019' + }, + { + "system": 'urn:oid:12.00.021.1.3.7.3', + "value": '1001004' + }, + { + "system": 'urn:oid:12.00.021.1.3.7.4', + "value": '1001004' + } + ], + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/data-absent-reason', + "code": 'unknown', + "display": 'Unknown' + } + ] + } + ], + "reasonCode": [ + { + "text": 'Pain left side of the body' + } + ], + "participant": [ + { + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'ATND', + "display": 'attender' + } + ], + "text": 'Attending Doctor' + } + ], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D', + "display": 'Godziszewski,Janet Kris' + } + }, + { + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'CON', + "display": 'consultant' + } + ], + "text": 'Consulting Doctor' + } + ], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/4F69EC72C5AA48988E5E73832887E634', + "display": 'Aguilar,Melva Delaine' + } + }, + { + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'CON', + "display": 'consultant' + } + ], + "text": 'Consulting Doctor' + } + ], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0', + "display": "O'Reilly,Rose" + } + }, + { + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'ADM', + "display": 'admitter' + } + ], + "text": 'Admitting Doctor' + } + ], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D', + "display": 'Godziszewski,Janet Kris' + } + } + ], + "contained": [ + { + "resourceType": 'Location', + "name": 'Inferno', + "id": '35202', + "status": 'active', + "telecom": [ + { + "system": 'phone', + "value": '6102196300' + }, + { + "system": 'fax', + "value": '6102196300' + } + ], + "address": { + "use": 'work', + "text": '53 Valley Stream Parkway,Malvern,PA,19355,United States', + "line": [ + '53 Valley Stream Parkway' + ], + "city": 'Malvern', + "state": 'PA', + "postalCode": '19355', + "country": 'United States' + }, + "managingOrganization": { + "reference": 'Organization/HCU.1', + "display": 'Health Enterprise' + } + } + ], + "text": { + "status": 'generated', + # rubocop:disable Layout/LineLength + "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " + # rubocop:enable Layout/LineLength + } + }.freeze + SOARIAN_R4_ENCOUNTER_SEARCH_BY_ID_ENTRY ||= { + "resourceType": 'Bundle', + "id": '250f967f-c78a-49a8-929f-2782c8722020', + "type": 'searchset', + "timestamp": '2021-03-04T14:53:32-05:00', + "entry": [{ + "fullUrl": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019', + "resource": { + "resourceType": 'Encounter', + "id": 'A879904FD2FE4B2D90C89FDA84E1285F.29019', + "meta": { + "lastUpdated": '2021-01-21T15:08:01-05:00' + }, + "status": 'in-progress', + "class": { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ActCode', + "code": 'IMP', + "display": 'inpatient encounter' + }, + "subject": { + "reference": 'Patient/A879904FD2FE4B2D90C89FDA84E1285F', + "display": 'Mcgovern,Astrid Santiago' + }, + "period": { + "start": '2020-04-15T16:42:00-04:00' + }, + "location": [{ + "location": { + "reference": '#35202' + } + }], + "identifier": [{ + "system": 'urn:oid:12.00.021.1.3.7.5', + "value": '29019' + }, + { + "system": 'urn:oid:12.00.021.1.3.7.3', + "value": '1001004' + }, + { + "system": 'urn:oid:12.00.021.1.3.7.4', + "value": '1001004' + }], + "type": [{ + "coding": [{ + "system": 'http://terminology.hl7.org/CodeSystem/data-absent-reason', + "code": 'unknown', + "display": 'Unknown' + }] + }], + "reasonCode": [{ + "text": 'Pain left side of the body' + }], + "participant": [{ + "type": [{ + "coding": [{ + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'ATND', + "display": 'attender' + }], + "text": 'Attending Doctor' + }], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D', + "display": 'Godziszewski,Janet Kris' + } + }, + { + "type": [{ + "coding": [{ + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'CON', + "display": 'consultant' + }], + "text": 'Consulting Doctor' + }], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/4F69EC72C5AA48988E5E73832887E634', + "display": 'Aguilar,Melva Delaine' + } + }, + { + "type": [{ + "coding": [{ + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'CON', + "display": 'consultant' + }], + "text": 'Consulting Doctor' + }], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0', + "display": "O'Reilly,Rose" + } + }, + { + "type": [{ + "coding": [{ + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'ADM', + "display": 'admitter' + }], + "text": 'Admitting Doctor' + }], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D', + "display": 'Godziszewski,Janet Kris' + } + }], + "contained": [{ + "resourceType": 'Location', + "name": 'Inferno', + "id": '35202', + "status": 'active', + "telecom": [{ + "system": 'phone', + "value": '6102196300' + }, + { + "system": 'fax', + "value": '6102196300' + }], + "address": { + "use": 'work', + "text": '53 Valley Stream Parkway,Malvern,PA,19355,United States', + "line": [ + '53 Valley Stream Parkway' + ], + "city": 'Malvern', + "state": 'PA', + "postalCode": '19355', + "country": 'United States' + }, + "managingOrganization": { + "reference": 'Organization/HCU.1', + "display": 'Health Enterprise' + } + }], + "text": { + "status": 'generated', + # rubocop:disable Layout/LineLength + "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " + # rubocop:enable Layout/LineLength + } + } + }], + "link": [{ + "relation": 'self', + "url": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json' + }] + }.freeze - SOARIAN_R4_ENCOUNTER_SEARCH_BY_ID_ENTRY ||= { - "resourceType": "Bundle", - "id": "250f967f-c78a-49a8-929f-2782c8722020", - "type": "searchset", - "timestamp": "2021-03-04T14:53:32-05:00", - "entry": [{ - "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019", - "resource": { - "resourceType": "Encounter", - "id": "A879904FD2FE4B2D90C89FDA84E1285F.29019", - "meta": { - "lastUpdated": "2021-01-21T15:08:01-05:00" - }, - "status": "in-progress", - "class": { - "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", - "code": "IMP", - "display": "inpatient encounter" - }, - "subject": { - "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F", - "display": "Mcgovern,Astrid Santiago" - }, - "period": { - "start": "2020-04-15T16:42:00-04:00" - }, - "location": [{ - "location": { - "reference": "#35202" - } - }], - "identifier": [{ - "system": "urn:oid:12.00.021.1.3.7.5", - "value": "29019" - }, - { - "system": "urn:oid:12.00.021.1.3.7.3", - "value": "1001004" - }, - { - "system": "urn:oid:12.00.021.1.3.7.4", - "value": "1001004" - } - ], - "type": [{ - "coding": [{ - "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", - "code": "unknown", - "display": "Unknown" - }] - }], - "reasonCode": [{ - "text": "Pain left side of the body" - }], - "participant": [{ - "type": [{ - "coding": [{ - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "ATND", - "display": "attender" - }], - "text": "Attending Doctor" - }], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", - "display": "Godziszewski,Janet Kris" - } - }, - { - "type": [{ - "coding": [{ - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "CON", - "display": "consultant" - }], - "text": "Consulting Doctor" - }], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/4F69EC72C5AA48988E5E73832887E634", - "display": "Aguilar,Melva Delaine" - } - }, - { - "type": [{ - "coding": [{ - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "CON", - "display": "consultant" - }], - "text": "Consulting Doctor" - }], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0", - "display": "O'Reilly,Rose" - } - }, - { - "type": [{ - "coding": [{ - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "ADM", - "display": "admitter" - }], - "text": "Admitting Doctor" - }], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", - "display": "Godziszewski,Janet Kris" - } - } - ], - "contained": [{ - "resourceType": "Location", - "name": "Inferno", - "id": "35202", - "status": "active", - "telecom": [{ - "system": "phone", - "value": "6102196300" - }, - { - "system": "fax", - "value": "6102196300" - } - ], - "address": { - "use": "work", - "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States", - "line": [ - "53 Valley Stream Parkway" - ], - "city": "Malvern", - "state": "PA", - "postalCode": "19355", - "country": "United States" - }, - "managingOrganization": { - "reference": "Organization/HCU.1", - "display": "Health Enterprise" - } - }], - "text": { - "status": "generated", - "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " - } - } - }], - "link": [{ - "relation": "self", - "url": "https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json" - }] -}.freeze - - - SOARIAN_R4_ENCOUNTER_SEARCH_BY_PT_ENTRY ||= { - "resourceType": "Bundle", - "id": "250f967f-c78a-49a8-929f-2782c8722020", - "type": "searchset", - "timestamp": "2021-03-04T14:53:32-05:00", - "entry": [ - { - "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019", - "resource": { - "resourceType": "Encounter", - "id": "A879904FD2FE4B2D90C89FDA84E1285F.29019", - "meta": { - "lastUpdated": "2021-01-21T15:08:01-05:00" - }, - "status": "in-progress", - "class": { - "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", - "code": "IMP", - "display": "inpatient encounter" - }, - "subject": { - "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F", - "display": "Mcgovern,Astrid Santiago" - }, - "period": { - "start": "2020-04-15T16:42:00-04:00" - }, - "location": [ - { - "location": { - "reference": "#35202" - } - } - ], - "identifier": [ - { - "system": "urn:oid:12.00.021.1.3.7.5", - "value": "29019" - }, - { - "system": "urn:oid:12.00.021.1.3.7.3", - "value": "1001004" - }, - { - "system": "urn:oid:12.00.021.1.3.7.4", - "value": "1001004" - } - ], - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", - "code": "unknown", - "display": "Unknown" - } - ] - } - ], - "reasonCode": [ - { - "text": "Pain left side of the body" - } - ], - "participant": [ - { - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "ATND", - "display": "attender" - } - ], - "text": "Attending Doctor" - } - ], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", - "display": "Godziszewski,Janet Kris" - } - }, - { - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "CON", - "display": "consultant" - } - ], - "text": "Consulting Doctor" - } - ], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/4F69EC72C5AA48988E5E73832887E634", - "display": "Aguilar,Melva Delaine" - } - }, - { - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "CON", - "display": "consultant" - } - ], - "text": "Consulting Doctor" - } - ], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0", - "display": "O'Reilly,Rose" - } - }, - { - "type": [ - { - "coding": [ - { - "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", - "code": "ADM", - "display": "admitter" - } - ], - "text": "Admitting Doctor" - } - ], - "period": { - "start": "2020-11-11T20:53:00-05:00" - }, - "individual": { - "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D", - "display": "Godziszewski,Janet Kris" - } - } - ], - "contained": [ - { - "resourceType": "Location", - "name": "Inferno", - "id": "35202", - "status": "active", - "telecom": [ - { - "system": "phone", - "value": "6102196300" - }, - { - "system": "fax", - "value": "6102196300" - } - ], - "address": { - "use": "work", - "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States", - "line": [ - "53 Valley Stream Parkway" - ], - "city": "Malvern", - "state": "PA", - "postalCode": "19355", - "country": "United States" - }, - "managingOrganization": { - "reference": "Organization/HCU.1", - "display": "Health Enterprise" - } - } - ], - "text": { - "status": "generated", - "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " - } - } - } - ], - "link": [ - { - "relation": "self", - "url": "https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json" - } - ] -}.freeze + SOARIAN_R4_ENCOUNTER_SEARCH_BY_PT_ENTRY ||= { + "resourceType": 'Bundle', + "id": '250f967f-c78a-49a8-929f-2782c8722020', + "type": 'searchset', + "timestamp": '2021-03-04T14:53:32-05:00', + "entry": [ + { + "fullUrl": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019', + "resource": { + "resourceType": 'Encounter', + "id": 'A879904FD2FE4B2D90C89FDA84E1285F.29019', + "meta": { + "lastUpdated": '2021-01-21T15:08:01-05:00' + }, + "status": 'in-progress', + "class": { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ActCode', + "code": 'IMP', + "display": 'inpatient encounter' + }, + "subject": { + "reference": 'Patient/A879904FD2FE4B2D90C89FDA84E1285F', + "display": 'Mcgovern,Astrid Santiago' + }, + "period": { + "start": '2020-04-15T16:42:00-04:00' + }, + "location": [ + { + "location": { + "reference": '#35202' + } + } + ], + "identifier": [ + { + "system": 'urn:oid:12.00.021.1.3.7.5', + "value": '29019' + }, + { + "system": 'urn:oid:12.00.021.1.3.7.3', + "value": '1001004' + }, + { + "system": 'urn:oid:12.00.021.1.3.7.4', + "value": '1001004' + } + ], + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/data-absent-reason', + "code": 'unknown', + "display": 'Unknown' + } + ] + } + ], + "reasonCode": [ + { + "text": 'Pain left side of the body' + } + ], + "participant": [ + { + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'ATND', + "display": 'attender' + } + ], + "text": 'Attending Doctor' + } + ], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D', + "display": 'Godziszewski,Janet Kris' + } + }, + { + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'CON', + "display": 'consultant' + } + ], + "text": 'Consulting Doctor' + } + ], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/4F69EC72C5AA48988E5E73832887E634', + "display": 'Aguilar,Melva Delaine' + } + }, + { + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'CON', + "display": 'consultant' + } + ], + "text": 'Consulting Doctor' + } + ], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0', + "display": "O'Reilly,Rose" + } + }, + { + "type": [ + { + "coding": [ + { + "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', + "code": 'ADM', + "display": 'admitter' + } + ], + "text": 'Admitting Doctor' + } + ], + "period": { + "start": '2020-11-11T20:53:00-05:00' + }, + "individual": { + "reference": 'Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D', + "display": 'Godziszewski,Janet Kris' + } + } + ], + "contained": [ + { + "resourceType": 'Location', + "name": 'Inferno', + "id": '35202', + "status": 'active', + "telecom": [ + { + "system": 'phone', + "value": '6102196300' + }, + { + "system": 'fax', + "value": '6102196300' + } + ], + "address": { + "use": 'work', + "text": '53 Valley Stream Parkway,Malvern,PA,19355,United States', + "line": [ + '53 Valley Stream Parkway' + ], + "city": 'Malvern', + "state": 'PA', + "postalCode": '19355', + "country": 'United States' + }, + "managingOrganization": { + "reference": 'Organization/HCU.1', + "display": 'Health Enterprise' + } + } + ], + "text": { + "status": 'generated', + # rubocop:disable Layout/LineLength + "div": "
    Encounter
    Patient:Mcgovern,Astrid Santiago;
    Status:in-progress;
    Class:inpatient encounter;
    Period Start Date:2020-04-15T16:42:00-04:00;
    Type:
    System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
    Reason for Encounter - Chief Complaint:Pain left side of the body;
    Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
    " + # rubocop:enable Layout/LineLength + } + } + } + ], + "link": [ + { + "relation": 'self', + "url": 'https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json' + } + ] + }.freeze end end - \ No newline at end of file From ae7f4d072eb70b0560dd791b5860426cb7274560 Mon Sep 17 00:00:00 2001 From: "WHQ_NT_DOMAIN\\SP071896" Date: Mon, 18 Oct 2021 09:52:34 -0400 Subject: [PATCH 3/3] Fix for encounter resources --- content/soarian/r4/base/management/encounter.md | 14 ++++++++------ lib/resources/r4/soarian_encounter.yaml | 8 ++++---- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/content/soarian/r4/base/management/encounter.md b/content/soarian/r4/base/management/encounter.md index 538182c1b..104716f9a 100644 --- a/content/soarian/r4/base/management/encounter.md +++ b/content/soarian/r4/base/management/encounter.md @@ -9,9 +9,9 @@ title: Encounter | R4 API ## 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. +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® 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® at the time of the query. +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: @@ -66,7 +66,9 @@ _Implementation Notes_ 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. +* 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. +* 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 @@ -101,7 +103,7 @@ Note: The examples provided here are non-normative and replaying them in the pub ### Errors -The common [errors](#errors) and [OperationOutcomes](https://www.hl7.org/fhir/r4/operationoutcome.html) may be returned. +The common [errors] and [OperationOutcomes] may be returned. ## Retrieve by ID @@ -113,7 +115,7 @@ _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 <%= authorization_types(provider: true, patient: true)%> @@ -136,7 +138,7 @@ Note: The examples provided here are non-normative and replaying them in the pub ### Errors -The common [errors] and [OperationOutcomes](https://www.hl7.org/fhir/r4/operationoutcome.html) may be returned. +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 diff --git a/lib/resources/r4/soarian_encounter.yaml b/lib/resources/r4/soarian_encounter.yaml index f6d7fee3c..036c3a81e 100644 --- a/lib/resources/r4/soarian_encounter.yaml +++ b/lib/resources/r4/soarian_encounter.yaml @@ -18,7 +18,7 @@ fields: description: The type of encounter. terminology: - display: CPT - system: http://www.ama-assn.org/go4/cpt + system: https://www.ama-assn.org/go4/cpt info_link: https://hl7.org/fhir/R4/cpt.html - name: participant @@ -36,7 +36,7 @@ fields: description: Role of participant in encounter. terminology: - display: ParticipantType - system: http://terminology.hl7.org/CodeSystem/v3-ParticipationType + system: https://terminology.hl7.org/CodeSystem/v3-ParticipationType info_link: https://hl7.org/fhir/r4/valueset-encounter-participant-type.html - name: reasonCode @@ -48,7 +48,7 @@ fields: description: Reason the encounter takes place. terminology: - display: ParticipantType - system: http://hl7.org/fhir/sid/icd-9-cm and http://hl7.org/fhir/sid/icd-10-cm + system: https://hl7.org/fhir/sid/icd-9-cm and http://hl7.org/fhir/sid/icd-10-cm info_link: https://hl7.org/fhir/r4/icd.html @@ -67,7 +67,7 @@ fields: description: Discharge Disposition. terminology: - display: Category or kind of location after discharge - system: http://www.nubc.org/patient-discharge + system: https://www.nubc.org/patient-discharge info_link: https://www.nubc.org/