Person updates for DSTU2 and R4

content/millennium/dstu2/entities/person.md

@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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

content/millennium/r4/base/individuals/person.md

@@ -9,26 +9,32 @@ title: Person | R4 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](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"}
-* [Identifier (Cerner alias Federated Person Principal)](https://hl7.org/fhir/R4/person-definitions.html#Person.identifier){:target="_blank"}
+* [Person ID](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"}
+* [Identifier](https://hl7.org/fhir/R4/person-definitions.html#Person.identifier){:target="_blank"}
 * [Name](https://hl7.org/fhir/R4/person-definitions.html#Person.name){:target="_blank"}
 * [Telecom](https://hl7.org/fhir/R4/person-definitions.html#Person.telecom){:target="_blank"}
 * [Gender](https://hl7.org/fhir/R4/person-definitions.html#Person.gender){:target="_blank"}
 * [Date of birth](https://hl7.org/fhir/R4/person-definitions.html#Person.birthDate){:target="_blank"}
 * [Address](https://hl7.org/fhir/R4/person-definitions.html#Person.address){:target="_blank"}
 * [Active](https://hl7.org/fhir/R4/person-definitions.html#Person.active){:target="_blank"}
 
+<%= disclaimer %>
+
+### Errors
+
+The common [errors] and [OperationOutcomes] may be returned.
+
 ## Terminology Bindings
 
 <%= terminology_table(:person, :r4) %>
 
 ## Search
 
-Search for Persons that meet supplied query parameters:
+Search for persons that meet supplied query parameters.
 
     GET /Person?:parameters
 
@@ -38,10 +44,10 @@ Search for Persons that meet supplied query parameters:
 
 ### Parameters
 
- Name         | Required?                                    | Type      | Description
---------------|----------------------------------------------|-----------|------------------------------------------------------------------------------
- `_id`        | This, or any other required search parameter | [`token`] | The logical resource id associated with the resource.
- `identifier` | This 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.
+ `identifier` | Conditionally | [`token`] | The person identifier. This parameter is required if the `_id` parameter is not used.
 
 Notes:
 
@@ -55,22 +61,16 @@ Notes:
 
 #### Request
 
-    GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Person?_id=12724067
+    GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Person?identifier=urn:oid:2.16.840.1.113883.6.1000|31577
 
 #### Response
 
 <%= headers status: 200 %>
 <%= json(:r4_person_bundle) %>
 
-<%= disclaimer %>
-
-### Errors
-
-The common [errors] and [OperationOutcomes] may be returned.
-
-## Retrieve by id
+## Retrieve by ID
 
-List an individual Person by its id:
+List an individual person by their ID.
 
     GET /Person/:id
 
@@ -95,13 +95,9 @@ List an individual Person by its id:
 
 <%= 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
 
@@ -112,12 +108,6 @@ Cerner Millennium supports the ability to logically merge a person record into a
 <%= headers status: 200 %>
 <%= json(:r4_combined_person_entry) %>
 
-<%= disclaimer %>
-
-### Errors
-
-The common [errors] and [OperationOutcomes] may be returned.
-
 [`token`]: http://hl7.org/fhir/R4/search.html#token
 [errors]: ../../../#client-errors
 [OperationOutcomes]: ../../../#operation-outcomes

lib/resources/dstu2/person.yaml

@@ -1,6 +1,6 @@
 ---
 name: Person
-field_name_base_url: http://hl7.org/fhir/DSTU2/person-definitions.html#Person
+field_name_base_url: https://hl7.org/fhir/DSTU2/person-definitions.html#Person
 fields:
 - name: identifier
   required: 'No'
@@ -12,13 +12,13 @@ fields:
     required: 'No'
     type: CodeableConcept
     description: The type for the identifier that can be used to determine which identifier to use for a specific purpose.
-    url: http://hl7.org/fhir/dstu2/datatypes-definitions.html#Identifier.type
+    url: https://hl7.org/fhir/dstu2/datatypes-definitions.html#Identifier.type
     binding:
       description: The type used to determine which identifier to use for a specific purpose.
       terminology:
       - display: Identifier Type Codes
         system: http://hl7.org/fhir/identifier-type
-        info_link: http://hl7.org/fhir/DSTU2/valueset-identifier-type.html
+        info_link: https://hl7.org/fhir/DSTU2/valueset-identifier-type.html
       - display: v2 Identifier Type
         system: http://hl7.org/fhir/v2/0203
-        info_link: http://hl7.org/fhir/DSTU2/valueset-identifier-type.html
+        info_link: https://hl7.org/fhir/DSTU2/v2/0203/index.html