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

DSTU 2 Patient updates #1023

Merged
merged 5 commits into from
Jan 2, 2024
Merged

DSTU 2 Patient updates #1023

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c2488da
DSTU 2 Patient updates
amcginn Nov 17, 2023
5cdd625
rearrange fields
amcginn Dec 14, 2023
6eeb0e2
OHAIUAD-205303: Style edits.
cldeitrich Dec 19, 2023
d561841
Update lib/resources/dstu2/patient.yaml
amcginn Jan 2, 2024
b960aa0
address PR comments
amcginn Jan 2, 2024
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
102 changes: 44 additions & 58 deletions content/millennium/dstu2/individuals/patient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,30 @@ title: Patient | DSTU 2 API

## Overview

The Patient resource provides general demographic information about a person receiving health care services from a specific organization. Common demographic fields include patient id, patient name, gender, date of birth, address, phone, primary language and marital status. Cerner Millennium is a patient centric application: thus, many of the other resources will include the patient id in their queries. A person receiving care from multiple organizations may have data available in multiple patient resources in multiple FHIR servers.
The Patient resource provides general demographic information about a person receiving health care services from a specific organization. Common demographic fields include patient ID, patient name, gender, date of birth, address, phone, primary language, and marital status. Cerner Millennium is a patient-centric application; thus, many of the other resources will include the patient ID in their queries. A person receiving care from multiple organizations may have data available in multiple patient resources in multiple FHIR servers.

The following fields are returned if valued:

* [Patient name](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.name){:target="_blank"}
* [Patient id](http://hl7.org/fhir/DSTU2/resource-definitions.html#Resource.id){:target="_blank"}
* [Extensions including birth time, birth sex, ethnicity, and race](#extensions)
* [Medical Record number (MRN)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.identifier){:target="_blank"}
* [Contact information (may include phone and email)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.telecom){:target="_blank"}
* [Contact person (guardian, parent or emergency)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.contact){:target="_blank"}
* [Gender (administrative)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.gender){:target="_blank"}
* [Patient ID](https://hl7.org/fhir/DSTU2/resource-definitions.html#Resource.id){:target="_blank"}
* [name](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.name){:target="_blank"}
* [Extension](#extensions)
* [Identifier](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.identifier){:target="_blank"}
* [Telecom](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.telecom){:target="_blank"}
* [Contact](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.contact){:target="_blank"}
* [Gender](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.gender){:target="_blank"}
* [Date of Birth](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.birthDate){:target="_blank"}
* [Deceased](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.deceased_x_){:target="_blank"}
* [Address](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.address){:target="_blank"}
* [Communication (preferred language)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.communication.language){:target="_blank"}
* [Communication language](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.communication.language){:target="_blank"}
* [Marital status](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.maritalStatus){:target="_blank"}
* [Primary Care Providers](http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.careProvider){:target="_blank"}
* [Multiple Birth Information](http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.multipleBirth_x_){:target="_blank"}
* [Care Provider](http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.careProvider){:target="_blank"}
* [Multiple Birth](http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.multipleBirth_x_){:target="_blank"}
amcginn marked this conversation as resolved.
Show resolved Hide resolved

<%= disclaimer %>

### Errors

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

## Terminology Bindings

Expand Down Expand Up @@ -58,30 +64,30 @@ _Implementation Notes_

### Parameters

Name | Required? | Type | Description
----------------------|----------------------------------------------|------------|--------------------------------------------------------------------------
`_id` | This, or any other required search parameter | [`token`] | The logical resource id associated with the resource.
`identifier` | This and/or any other search param, or `_id` | [`token`] | A patient identifier. Example: `urn:oid:1.1.1.1.1.1|1022228`
`name` | This and/or any other search param, or `_id` | [`string`] | The start of either family or given name of the patient. Example: `Pete`
`family` | This and/or any other search param, or `_id` | [`string`] | The start of the family name of the patient. Example: `Adam`
`given` | This and/or any other search param, or `_id` | [`string`] | The start of the given name of the patient. Example: `Tim`
`birthdate` | This and/or any other search param, or `_id` | [`date`] | The patient's date of birth. Example: `1961-01-16`
`phone` | This and/or any other search param, or `_id` | [`token`] | The patient's phone number. Example: `1111111111`
`email` | This and/or any other search param, or `_id` | [`token`] | The patient's email address. Example: `[email protected]`
`address-postalcode` | This and/or any other search param, or `_id` | [`string`] | The postal code in the address details of the patient. Example: `11111`
`gender` | No | [`token`] | The gender of the patient. Example: `male`
[`_count`] | No | [`number`] | The maximum number of results to return. Defaults to `20`.
| Name | Required? | Type | Description |
|----------------------|---------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if at least one of `identifier`, `name`, `family`, `given`, `birthdate`, `phone`, `email`, or `address-postalcode` is not used. Example: `11111111` |
| `identifier` | Conditionally | [`token`] | A patient identifier. This parameter is required if `_id`, `name`, `family`, `given`, `birthdate`, `phone`, `email`, and `address-postalcode` are not used. Example: `urn:oid:1.1.1.1.1.1\|1022228` |
| `name` | Conditionally | [`string`] | The start of either family or given name of the patient.This parameter is required if `_id`, `identifier`, `family`, `given`, `birthdate`, `phone`, `email`, and `address-postalcode` are not used. Example: `Pete` |
| `family` | Conditionally | [`string`] | The start of the family name of the patient. This parameter is required if `_id`, `identifier`, `name`, `given`, `birthdate`, `phone`, `email`, and `address-postalcode` are not used. Example: `Adam` |
| `given` | Conditionally | [`string`] | The start of the given name of the patient. This parameter is required if `_id`, `identifier`, `name`, `family`, `birthdate`, `phone`, `email`, and `address-postalcode` are not used. Example: `Tim` |
| `birthdate` | Conditionally | [`date`] | The patient's date of birth. This parameter is required if `_id`, `identifier`, `name`, `family`, `given`, `phone`, `email`, and `address-postalcode` are not used. Example: `1961-01-16` |
| `phone` | Conditionally | [`token`] | The patient's phone number. This parameter is required if `_id`, `identifier`, `name`, `family`, `given`, `birthdate`, `email`, and `address-postalcode` are not used. Example: `1111111111` |
| `email` | Conditionally | [`token`] | The patient's email address. This parameter is required if `_id`, `identifier`, `name`, `family`, `given`, `birthdate`, `phone`, and `address-postalcode` are not used. Example: `[email protected]` |
| `address-postalcode` | Conditionally | [`string`] | The postal code in the address details of the patient. This parameter is required if `_id`, `identifier`, `name`, `family`, `given`, `birthdate`, `phone`, and `email` are not used. Example: `11111` |
| `gender` | No | [`token`] | The administrative gender of the patient. Example: `male` |
| [`_count`] | No | [`number`] | The maximum number of results to return. Defaults to `20`. |

Notes:

* Either the `_id`, or a combination of `identifier` , `birthdate`, `name`, `given`, `family`, `address-postalcode`, `phone`, or `email` parameters must be provided.
* The `gender` parameter may only be provided if at least one of `identifier` , `birthdate`, `name`, `given`, `family`, `address-postalcode`, `phone`, or `email` parameters is provided.
* The `name`, `family`, and `given` parameters support the ':exact' modifier and will search for current names only.
* It is not recommended to combine `family` or `given` parameters with `name` parameter when searching for a patient. Whenever possible use the ':exact' modifier.
* The `address-postalcode` parameter supports the `:exact` modifer.
* The `name`, `family`, and `given` parameters support the [`:exact`] modifier and will search for current names only, based on the name's `period`.
* It is not recommended to combine `family` or `given` parameters with the `name` parameter when searching for a patient. Whenever possible, use the ':exact' modifier.
* The `address-postalcode` parameter supports the [`:exact`] modifier.
* The `identifier`, `name`, `family`, `given`, `phone`, `email`, `address-postalcode`, or `gender` parameters may be provided exactly once and may have only a single value.
* The `birthdate` parameter may be provided twice to indicate a date range, but must contain the inclusive prefixes 'le' and 'ge'
* The `birthdate` parameter may be provided once with the following prefixes: 'ge', 'le', 'gt', 'lt', 'eq'
* The `birthdate` parameter may be provided in the following formats:
* Once with a prefix of `ge`, `le`, `gt`, `lt`, or `eq`. Example: `birthdate=ge2001-03-13`
* Twice to indicate a date range and must contain one prefix each of `le` and `ge`. Example: `birthdate=ge2001-03-13&birthdate=le2001-05-01`
* A `422 - Unprocessable Entity` will be returned when over 1,000 patients qualify for the search criteria.

### Headers

Expand All @@ -98,15 +104,9 @@ Notes:
<%= headers status: 200 %>
<%= json(:dstu2_patient_bundle) %>

<%= disclaimer %>
## Retrieve by ID

### Errors

The common [errors] and [OperationOutcomes] may be returned. In addition, a `422 Unprocessable Entity` will be returned when too many (>1000) patients qualify for the search criteria.

## Retrieve by id

List an individual Patient by its id:
List an individual Patient by its ID:

GET /Patient/:id

Expand Down Expand Up @@ -134,16 +134,12 @@ _Implementation Notes_
<%= headers status: 200 %>
<%= json(:dstu2_patient_entry) %>

<%= disclaimer %>

### Patient Combines Example

Cerner Millennium supports the ability to logically merge a patient record into another patient record when both records are describing the same patient. This is known
as a "patient combine". If necessary, this merging can later be undone by performing a "patient uncombine". When the requested patient record has been combined into another
as a patient combine. If necessary, this merging can later be undone by performing a patient uncombine. When the requested patient record has been combined into another
record, an inactive Patient entry will be returned which has a link to the current Patient entry. Entries for combined patients will only be returned when retrieving
the entries directly by id. They will not be returned when searching with other parameters.

The ability to perform patient combine or uncombine operations is not available through the Cerner Ignite platform.
the entries directly by ID. They will not be returned when searching with other parameters.

#### Request

Expand All @@ -154,12 +150,6 @@ The ability to perform patient combine or uncombine operations is not available
<%= headers status: 200 %>
<%= json(:dstu2_combined_patient_entry) %>

<%= disclaimer %>

### Errors

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

## Create

Create an individual Patient:
Expand Down Expand Up @@ -213,7 +203,8 @@ Vary: Origin,User-Agent,Accept-Encoding
Strict-Transport-Security: max-age=631152000
X-Xss-Protection: 1; mode=block
Pragma: no-cache
X-Request-Id: 78a19072002b8651623351cfedaffe70
X-Request-Id: f17bbd99-f89b-4cfe-8425-43b14e5735cf
opc-request-id: /5E94C5FFC27CDD51DB70C0F464E44A96/AECA8B137DC613A323E70B1ED7C53808
Etag: W/"0"
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
Expand All @@ -226,12 +217,6 @@ Content-Type: application/json

The `ETag` response header indicates the current `If-Match` version to use on subsequent updates.

<%= disclaimer %>

### Errors

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

[Time of day of birth]: http://hl7.org/fhir/DSTU2/extension-patient-birthtime.html
amcginn marked this conversation as resolved.
Show resolved Hide resolved
[Argonaut Race]: http://build.fhir.org/ig/Healthedata1/Argo-DSTU2/StructureDefinition-argo-race.html
[Argonaut Ethnicity]: http://build.fhir.org/ig/Healthedata1/Argo-DSTU2/StructureDefinition-argo-ethnicity.html
Expand All @@ -242,6 +227,7 @@ The common [errors] and [OperationOutcomes] may be returned.
[`string`]: http://hl7.org/fhir/DSTU2/search.html#string
[`_count`]: http://hl7.org/fhir/DSTU2/search.html#count
[`number`]: http://hl7.org/fhir/DSTU2/search.html#number
[`:exact`]: https://hl7.org/fhir/R4/search.html#string
[Patient.deceased]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.deceased_x_
[Patient.multipleBirth]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.multipleBirth_x_
[Patient.photo]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.photo
Expand Down
Loading
Loading