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

Commit

Permalink
Merge branch 'main' into patient-r4-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@amcginn
amcginn authored Jan 2, 2024
2 parents b2b105d + d32b15e commit 43101c3
Show file tree
Hide file tree
Showing 33 changed files with 943 additions and 1,402 deletions.
51 changes: 21 additions & 30 deletions content/millennium/dstu2/care-provision/goal.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ title: Goal | DSTU 2 API

## Overview

The Goal resource describes intended objectives for a patient. A Goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A Goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-health care related (e.g. dance at a wedding).
The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-healthcare related (for example, dance at a wedding).

The following fields are returned if valued:

* [id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Goal ID](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Subject (patient)](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.subject){:target="_blank"}
* [Start date](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.start_x_){:target="_blank"}
* [Target date](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.target_x_){:target="_blank"}
Expand All @@ -24,13 +24,19 @@ The following fields are returned if valued:
* [Author](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.author){:target="_blank"}
* [Note](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.note){:target="_blank"}

<%= disclaimer %>

### Errors

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

## Terminology Bindings

<%= terminology_table(:goal, :dstu2) %>

## Search

Search for Goals that meet supplied query parameters:
Search for goals that meet supplied query parameters.

GET /Goal?:parameters

Expand All @@ -40,18 +46,18 @@ Search for Goals that meet supplied query parameters:

### Parameters

Name | Required? | Type | Description
-------------------|------------------------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
`_id` | This, or one of `patient`, or `subject`. | [`token`] | The logical resource id associated with the Goal. Example: `_id=7891`
`patient` | This, or one of `_id`, or `subject`. | [`reference`] | The patient who has the goal. Example: `patient=12345`
`subject:Patient` | This, or one of `_id`, or `patient`. | [`reference`] | The subject who this goal is intended for. Must represent a Patient resource. May use the `:Patient` modifier. Example: `subject=Patient/12345` or `subject:Patient=12345`
`targetdate` | N | [`date`] | A date or date range from which to find Goals. Example: `targetdate=ge2016-10-01&targetdate=le2016-12-01`
Name | Required? | Type | Description
-------------------|------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
`_id` | Conditionally | [`token`] | The logical resource ID associated with the goal. This parameter is required if `patient` or `subject` are not used. Example: `_id=7891`
`patient` | Conditionally | [`reference`] | The patient who has the goal. This parameter is required if `_id` or `subject` are not used. Example: `patient=12345`
`subject:Patient` | Condtionally | [`reference`] | The subject who this goal is intended for. Must represent a Patient resource. This parameter is required if `_id` or `patient` are not used. Examples: `subject=Patient/12345` or `subject:Patient=12345`
`targetdate` | No | [`date`] | A date or date range from which to find goals. Example: `targetdate=ge2016-10-01&targetdate=le2016-12-01`

Notes:

- The `_id` parameter may not be provided at the same time as the `patient`, `subject`, or `targetdate` parameters.

- The `targetdate` parameter may be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date. Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within specific range. The date and prefix pairs must create a closed range.
* The `targetdate` parameter:
* May be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date.
* Alternatively, it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within a specific range. The date and prefix pairs must create a closed range.

### Headers

Expand All @@ -68,10 +74,7 @@ Notes:
<%= headers status: 200 %>
<%= json(:dstu2_goal_bundle) %>

<%= disclaimer %>


### Example Search by Id
### Example Search by ID

#### Request

Expand All @@ -82,15 +85,9 @@ Notes:
<%= headers status: 200 %>
<%= json(:dstu2_goal_bundle_by_id) %>

<%= disclaimer %>

### Errors

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

## Retrieve by id
## Retrieve by ID

List an individual Goal by its id:
List an individual goal by its ID.

GET /Goal/:id

Expand All @@ -113,12 +110,6 @@ List an individual Goal by its id:
<%= headers status: 200 %>
<%= json(:dstu2_goal) %>

<%= disclaimer %>

### Errors

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

[`date`]: http://hl7.org/fhir/dstu2/search.html#date
[`reference`]: http://hl7.org/fhir/DSTU2/search.html#reference
[`token`]: http://hl7.org/fhir/DSTU2/search.html#token
Expand Down
63 changes: 29 additions & 34 deletions content/millennium/dstu2/conformance/structure-definition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,37 @@ title: StructureDefinition | DSTU 2 API

## Overview

The StructureDefinition resource describes a FHIR structure including data elements and their usage. Our current implementation uses this resource to define custom extensions.
The StructureDefinition resource describes a FHIR structure including data elements and their usage. This resource is used to define custom extensions.

The following fields are returned if valued:

* [Id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Publisher](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.publisher){:target="_blank"}
* [Snapshot](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.snapshot){:target="_blank"}
* [Date](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.date){:target="_blank"}
* [Fhir version](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.fhirVersion){:target="_blank"}
* [Constrained type](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.constrainedType){:target="_blank"}
* [Description](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.description){:target="_blank"}
* [Status](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.status){:target="_blank"}
* [Context type](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.contextType){:target="_blank"}
* [Context](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.context){:target="_blank"}
* [URL](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.url){:target="_blank"}
* [Kind](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.kind){:target="_blank"}
* [Differential](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.differential){:target="_blank"}
* [Abstract](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.abstract){:target="_blank"}
* [Base](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.base){:target="_blank"}
* [Name](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.name){:target="_blank"}

## Retrieve by id

List an individual StructureDefinition by its id:
* [ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Publisher](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.publisher){:target="_blank"}
* [Snapshot](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.snapshot){:target="_blank"}
* [Date](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.date){:target="_blank"}
* [FHIR version](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.fhirVersion){:target="_blank"}
* [Constrained type](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.constrainedType){:target="_blank"}
* [Description](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.description){:target="_blank"}
* [Status](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.status){:target="_blank"}
* [Context type](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.contextType){:target="_blank"}
* [Context](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.context){:target="_blank"}
* [URL](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.url){:target="_blank"}
* [Kind](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.kind){:target="_blank"}
* [Differential](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.differential){:target="_blank"}
* [Abstract](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.abstract){:target="_blank"}
* [Base](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.base){:target="_blank"}
* [Name](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.name){:target="_blank"}

## Retrieve by ID

List an individual structure definition by its ID.

GET /StructureDefinition/:id

_Implementation Notes_
_Notes_

* Authentication is not required to access the StructureDefinition resource
* This resource can be retrieved by its defining URL or from the StructureDefinition resource located at the [service root URL](../../#service-root-url). For example, both of these URLs work:
* Authentication is not required to access the StructureDefinition resource.
* You can retrieve this resource by its defining URL or from the StructureDefinition resource located at the [service root URL](../../#service-root-url). For example, both of these URLs work:

`https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display`

Expand All @@ -49,15 +49,12 @@ _Implementation Notes_

Authorization is not required.

<%= authorization_types(provider: true, patient: true, system: true) %>

### Headers

<%= headers head: {Accept: 'application/json+fhir'} %>

### Example


#### Request

GET https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display
Expand All @@ -67,17 +64,15 @@ Authorization is not required.
<%= headers status: 200 %>
<%= json(:dstu2_structure_definition_bundle) %>

<%= disclaimer %>

## List of StructureDefinitions

ID | Description
----------------------------------|----------------------------------------------
[`patient-friendly-display`] | Display string suitable for patient viewing.
[`scheduling-location`] | Reference to the location of an appointment being scheduled.
[`medication-statement-category`] | Category of an order.
[`infuse-over-time`] | The length of time in minutes it took to infuse a medication.
[`encounter-guarantor`] | The guarantors of an encounter. Contains a reference to a Patient, Person, or Organization and a period when the guarantor is effective.
[`patient-friendly-display`] | The display name suitable for patient viewing.
[`scheduling-location`] | The reference to the location of a scheduled appointment.
[`medication-statement-category`] | The category of an order.
[`infuse-over-time`] | The length of time in minutes to infuse a medication.
[`encounter-guarantor`] | The guarantors of an encounter. Contains a reference to a patient, person, or organization and a period when the guarantor is effective.

[`patient-friendly-display`]: https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display?_format=json
[`scheduling-location`]: https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location?_format=json
Expand Down
65 changes: 24 additions & 41 deletions content/millennium/dstu2/entities/person.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,32 @@ title: Person | DSTU 2 API

## Overview

The Person resource identifies an individual outside of a specific health care context providing a mechanism to link person resources across different facilities or organizations.
The Person resource identifies an individual outside of a specific healthcare context and provides a mechanism to associate person resources across different facilities or organizations.

The following fields are returned if valued:

* [Person id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Identifier (Cerner alias Federated Person Principal)](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.identifier){:target="_blank"}
* [Name](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.name){:target="_blank"}
* [Telecom](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.telecom){:target="_blank"}
* [Gender](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.gender){:target="_blank"}
* [Date of birth](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.birthDate){:target="_blank"}
* [Address](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.address){:target="_blank"}
* [Active](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.active){:target="_blank"}
* [Person ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Identifier](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.identifier){:target="_blank"}
* [Name](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.name){:target="_blank"}
* [Telecom](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.telecom){:target="_blank"}
* [Gender](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.gender){:target="_blank"}
* [Date of birth](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.birthDate){:target="_blank"}
* [Address](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.address){:target="_blank"}
* [Active](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.active){:target="_blank"}

<%= disclaimer %>

### Errors

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

## Terminology Bindings

<%= terminology_table(:person, :dstu2) %>

## Search

Search for Persons that meet supplied query parameters:
Search for persons that meet supplied query parameters.

GET /Person?:parameters

Expand All @@ -38,14 +44,14 @@ Search for Persons that meet supplied query parameters:

### Parameters

Name | Required? | Type | Description
--------------|---------------------------------------------------|------------|------------------------------------------------------------------------------------
`_id` | No, if populated all other parameters are ignored | [`token`] | The logical resource id associated with the resource.
`identifier` | Yes, or `_id` | [`token`] | The person identifier. Example: `urn:oid:2.16.840.1.113883.3.13.6|01022228`
Name | Required | Type | Description
--------------|---------------|------------|------------------------------------------------------------------------------------
`_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if the `identifier` parameter is not used. Example: `_id=12345`
`identifier` | Conditionally | [`token`] | The person identifier. This parameter is required if the `_id` parameter is not used. Example: `urn:oid:2.16.840.1.113883.3.13.6|01022228`

Notes:

- `identifier` value must include both a system and a code. Example: `identifier=urn:oid:2.16.840.1.113883.3.13.6|URN:CERNER:...:PI98N2FK5TN`
- The `identifier` value must include both a system and a code. Example: `identifier=urn:oid:2.16.840.1.113883.3.13.6|URN:CERNER:...:PI98N2FK5TN`

### Headers

Expand All @@ -62,15 +68,9 @@ Notes:
<%= headers status: 200 %>
<%= json(:dstu2_person_bundle) %>

<%= disclaimer %>
## Retrieve by ID

### Errors

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

## Retrieve by id

List an individual Person by its id:
List an individual person by their ID.

GET /Person/:id

Expand All @@ -93,20 +93,9 @@ List an individual Person by its id:
<%= headers status: 200 %>
<%= json(:dstu2_person_entry) %>

<%= disclaimer %>

### Errors

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

### Person Combines Example

Cerner Millennium supports the ability to logically merge a person record into another person record when both records are describing the same person. This is known
as a "person combine". If necessary, this merging can later be undone by performing a "person uncombine". When the requested person record has been combined into another
record, an inactive Person entry will be returned which has a link to the current Person 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 person combine or uncombine operations is not available through the Cerner Ignite platform.
Oracle Health Millennium Platform supports the ability to logically merge a person record into another person record when both records are describing the same person. This merge is known as a person combine. If necessary, you can perform a person uncombine to undo the merge. When the requested person record is combined into another record, an inactive person entry is returned with a link to the current person entry. Entries for combined patients are only returned when retrieving the entries directly by ID. They are not returned when searching with other parameters.

#### Request

Expand All @@ -117,12 +106,6 @@ The ability to perform person combine or uncombine operations is not available t
<%= headers status: 200 %>
<%= json(:dstu2_combined_person_entry) %>

<%= disclaimer %>

### Errors

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

[`token`]: http://hl7.org/fhir/DSTU2/search.html#token
[errors]: ../../#client-errors
[OperationOutcomes]: ../../#operation-outcomes
Loading

0 comments on commit 43101c3

Please sign in to comment.