Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Review and Updates for Encounter #1007

Merged
merged 8 commits into from
Nov 3, 2023
Merged

Review and Updates for Encounter #1007

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6cd41da
corrections for encounter
RicardoCrespo-ora Oct 23, 2023
f565b4e
PRODOC-202540
summerlcollins Oct 23, 2023
d5848cd
PRODOC-202540
summerlcollins Oct 23, 2023
2927c29
wording to DSTU2 version
RicardoCrespo-ora Oct 26, 2023
81d875c
applied wording changes in R4 to DSTU2 version
RicardoCrespo-ora Oct 26, 2023
85b1eef
formatting for parameters in encounter
RicardoCrespo-ora Oct 26, 2023
7149ebf
replaced mock x-request-id with uuid
RicardoCrespo-ora Oct 26, 2023
a2d6ba2
corrections to Encounter
RicardoCrespo-ora Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions content/millennium/dstu2/encounters/encounter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ title: Encounter | DSTU 2 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, etc. A patient may have one medical record number with multiple encounter numbers per facility or organization. There is substantial variance between organizations in the definition of an encounter and what events are aggregated together to constitute an encounter.
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. A patient may have one medical record number with multiple encounter numbers per facility or organization. There is substantial variance between organizations in the definition of an encounter and what events are aggregated together to constitute an encounter.

The following fields are returned if valued:

* [Encounter id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Encounter ID](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Encounter identifier (eg: FIN)](http://hl7.org/fhir/DSTU2/encounter-definitions.html#Encounter.identifier){:target="_blank"}
* [Status](http://hl7.org/fhir/DSTU2/encounter-definitions.html#Encounter.status){:target="_blank"}
* [Class](http://hl7.org/fhir/DSTU2/encounter-definitions.html#Encounter.class){:target="_blank"}
Expand Down Expand Up @@ -75,10 +75,10 @@ _Implementation Notes_

### Parameters

Name | Required? | Type | Description
Name | Required | Type | Description
-----------|-----------------|---------------|---------------------------------------------------------------------------
`_id` | This or patient | [`token`] | The logical resource id associated with the Encounter. Example: `7891`
`patient` | This or _id | [`reference`] | The patient present at the encounter. Example: `12345`
`_id` | Conditional | [`token`] | The logical resource ID associated with the Encounter. This parameter is required if `patient` is not used. Example: `7891`
`patient` | Conditional | [`reference`] | The Patient present at the Encounter. This parameter is required if `_id` is not used. Example: `12345`

### Headers

Expand All @@ -101,9 +101,9 @@ _Implementation Notes_

The common [errors] and [OperationOutcomes] may be returned.

## Retrieve by id
## Retrieve by ID

List an individual Encounter by its id:
List an individual Encounter by the associated ID:

GET /Encounter/:id

Expand Down Expand Up @@ -135,10 +135,10 @@ _Implementation Notes_

### Encounter Combines Example

Cerner Millennium supports the ability to logically merge an encounter record into another encounter record when both records are describing the same ecounter. This is known
as an "encounter combine". If necessary, this merging can later be undone by performing an "encounter uncombine". When the requested encounter record has been combined into another
record, an inactive Encounter entry will be returned which has a reference to the current Encounter entry in the partOf field. Entries for combined encounters will only be returned when retrieving
the entries directly by id. They will not be returned when searching with other parameters.
Cerner Millennium supports the ability to logically merge an encounter record into another encounter record when both records are describing the same encounter. This is known
as an encounter combine. If necessary, this merging can later be undone by performing an encounter uncombine. When the requested encounter record has been combined into another
record, an inactive encounter entry is returned which has a reference to the current encounter entry in the partOf field. Entries for combined encounters will only be returned when retrieving
RicardoCrespo-ora marked this conversation as resolved.
Show resolved Hide resolved
the entries directly by ID. They will not be returned when searching with other parameters.

The ability to perform encounter combine or uncombine operations is not available through the Cerner Ignite platform.
RicardoCrespo-ora marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
52 changes: 27 additions & 25 deletions content/millennium/r4/base/management/encounter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ 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, etc. A patient may have one medical record number with multiple encounter numbers per facility or organization. There is substantial variance between organizations in the definition of an encounter and what events are aggregated together to constitute an encounter.
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. A patient may have one medical record number with multiple encounter numbers per facility or organization. There is substantial variance between organizations in the definition of an encounter and what events are aggregated together to constitute an encounter.

The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/){:target="_blank"} Profiles are supported by this resource:

Expand Down Expand Up @@ -82,7 +82,7 @@ All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/St

## Search

Search for Encounters that meet supplied query parameters:
Search for encounters that meet supplied query parameters:

GET /Encounter?:parameters

Expand All @@ -98,23 +98,24 @@ _Implementation Notes_

### Parameters

Name | Required? | Type | Description
--------------|--------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------------------------------
`_id` | This or `patient` or `subject` or `account` or `identifier` or `pageContext` | [`token`] | The logical resource id associated with the Encounter. Example: `7891`
`patient` | This or `subject` or `account` or `_id` or `identifier` or `pageContext` | [`reference`] | The patient present at the encounter. Example: `12345`
`subject` | This or `patient` or `account` or `_id` or `identifier` or `pageContext` | [`reference`] | The patient present at the encounter. Example: `subject=Patient/12345` or `subject:Patient=12345`
`account` | This or `patient` or `subject` or `_id` or `identifier` or `pageContext` | [`reference`] | The account associated with the encounters. Example: `F703726`
`identifier` | This or `patient` or `subject` or `account` or `_id` or `pageContext` | [`token`] | An encounter's identifier. Example: `urn:oid:1.2.243.58|110219457`
`date` | No | [`dateTime`] | Datetime range into which the encounter's period datetime falls. Must be prefixed by 'ge', 'gt', 'le' or 'lt'.
[`_count`] | No | [`number`] | The maximum number of results to return.
`status` | No | [`token`] | The status of the encounter. Example: `planned`
`_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target
Name | Required | Type | Description
--------------|------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------
`_id` | Conditional | [`token`] | The logical resource ID associated with the Encounter. This parameter is required if `patient` or `subject` or `account` or `identifier` or `pageContext` is not used. Example: `7891`
`patient` | Conditional | [`reference`] | The patient present at the Encounter. This parameter is required if `subject` or `account` or `_id` or `identifier` or `pageContext` is not used. Example: `12345`
`subject` | Conditional | [`reference`] | The patient present at the Encounter. This parameter is required if `patient` or `account` or `_id` or `identifier` or `pageContext` is not used. Example: `subject=Patient/12345` or `subject:Patient=12345`
`account` | Conditional | [`reference`] | The account associated with the Encounters. This parameter is required if `patient` or `subject` or `_id` or `identifier` or `pageContext` is not used. Example: `F703726`
`identifier` | Conditional | [`token`] | An Encounter's identifier. This parameter is required if `patient` or `subject` or `account` or `_id` or `pageContext` is not used. Example: `urn:oid:1.2.243.58|110219457`
`date` | No | [`dateTime`] | Datetime range into which the Encounter's period datetime falls. Must be prefixed by 'ge', 'gt', 'le' or 'lt'.
[`_count`] | No | [`number`] | The maximum number of results to return.
`status` | No | [`token`] | The status of the Encounter. Example: `planned`
`_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. Example: `_revinclude=Provenance:target`
RicardoCrespo-ora marked this conversation as resolved.
Show resolved Hide resolved

Notes:

* `_revinclude` parameter may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target`
* `_revinclude` parameter may be provided with the `_id/patient/subject/account` parameter. Example: `_id=74771957,4732066&_revinclude=Provenance:target`
* `_revinclude` is provided in a request to the closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. Currently, `patient/Provenance.read` is not supported and hence `_revinclude` cannot be utilized for patient persona.
* When using the `_revinclude` parameter:
* It may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target`
* It may be provided with the `_id/patient/subject/account` parameter. Example: `_id=74771957,4732066&_revinclude=Provenance:target`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's split these fields to be more clear that they are separate parameters

Copy link
Contributor Author

@RicardoCrespo-ora RicardoCrespo-ora Oct 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean split like this?

  • When using the _revinclude parameter:
    • It may be provided once with the value Provenance:target. Example: _revinclude=Provenance:target
    • It may be provided with the _id parameter. Example: _id=74771957,4732066&_revinclude=Provenance:target`
    • It may be provided with the patient parameter. Example: example here
    • It may be provided with the subject parameter. Example: example here
    • It may be provided with the account parameter. Example: example here

* If `_revinclude` is provided in a request to the closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. Currently, `patient/Provenance.read` is not supported and hence `_revinclude` cannot be utilized for patient persona.
* `_count` and `status` must be provided with patient
* `status` valid parameters are `planned`, `in-progress`, `finished`, `cancelled`
* The `date` parameter may be provided:
Expand Down Expand Up @@ -160,6 +161,7 @@ Notes:
#### Request

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Encounter?_id=1361920&_revinclude=Provenance:target

#### Response

<%= headers status: 200 %>
Expand All @@ -180,9 +182,9 @@ Notes:

The common [errors] and [OperationOutcomes] may be returned.

## Retrieve by id
## Retrieve by ID

List an individual Encounter by its id:
List an individual encounter by the associated ID:

GET /Encounter/:id

Expand Down Expand Up @@ -214,10 +216,10 @@ _Implementation Notes_

### Encounter Combines Example

Cerner Millennium supports the ability to logically merge an encounter record into another encounter record when both records are describing the same ecounter. This is known
as an "encounter combine". If necessary, this merging can later be undone by performing an "encounter uncombine". When the requested encounter record has been combined into another
record, an inactive Encounter entry will be returned which has a reference to the current Encounter entry in the partOf field. Entries for combined encounters will only be returned when retrieving
the entries directly by id. They will not be returned when searching with other parameters.
Cerner Millennium supports the ability to logically merge an encounter record into another encounter record when both records are describing the same encounter. This is known
as an encounter combine. If necessary, this merging can later be undone by performing an encounter uncombine. When the requested encounter record has been combined into another
record, an inactive encounter entry is returned which has a reference to the current encounter entry in the partOf field. Entries for combined encounters will only be returned when retrieving
RicardoCrespo-ora marked this conversation as resolved.
Show resolved Hide resolved
the entries directly by ID. They will not be returned when searching with other parameters.

The ability to perform encounter combine or uncombine operations is not available through the Cerner Ignite platform.

Expand Down Expand Up @@ -246,7 +248,7 @@ The common [errors] and [OperationOutcomes] may be returned.

## Create

Create an individual Encounter.
Create an individual encounter.

POST /Encounter

Expand Down Expand Up @@ -284,7 +286,7 @@ Etag: W/"0"
Last-Modified: Wed, 27 Mar 2019 15:59:30 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Encounter/1621910
Vary: Origin
X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea68
X-Request-Id: 11111111111111111111111111111111
RicardoCrespo-ora marked this conversation as resolved.
Show resolved Hide resolved
</pre>

The `ETag` response header indicates the current `If-Match` version to use on subsequent updates.
Expand Down Expand Up @@ -338,7 +340,7 @@ Date: Tue, 26 Mar 2019 15:42:29 GMT
Etag: W/"10"
Last-Modified: Tue, 26 Mar 2019 15:42:27 GMT
Vary: Origin
X-Request-Id: 47306a14c8a2c3afd4ab85aa9594101d
X-Request-Id: 11111111111111111111111111111111
</pre>

The `ETag` response header indicates the current `If-Match` version to use on subsequent updates.
Expand Down
2 changes: 1 addition & 1 deletion lib/resources/r4/encounter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ fields:
terminology:
- display: Encounter Priority
system: http://hl7.org/fhir/encounter-priority
info_link: http://hl7.org/fhir/v3/ActPriority/vs.html
info_link: https://hl7.org/fhir/R4/v3/ActPriority/vs.html
- display: Millennium Encounter Admit Type
system: https://fhir.cerner.com/&lt;EHR source id&gt;/codeSet/3
info_link: https://fhir.cerner.com/millennium/r4/proprietary-codes-and-systems/#code-set-3-encounter-admission-type
Expand Down
Loading