Person
Overview
The Person resource identifies demographic information about a person who is outside of a specific healthcare context.
The following fields are returned if they contain values:
Terminology Bindings
None
Search
Search for Persons that meet supplied query parameters:
GET /Person?:parameters
Implementation Notes
Federated Principal Alias |
---|
A unique alphanumeric string used to identify the person. The format of this unique string is known as the Federated Principal Alias (FPA). This format contains the Identity Provider’s unique identifier, a GUID issued by Cerner, and the SMART app user’s unique identifier, called the principal. Example: URN:CERNER:IDENTITY-FEDERATION:REALM:49F17659-891C-42C9-AE26-D6AE7826F62D:PRINCIPAL:38509e38-2d69-4109-ab24-08ca19ea4a65 In the aforementioned example - 49F17659-891C-42C9-AE26-D6AE7826F62D: The unique identifier of the Identity provider. 38509e38-2d69-4109-ab24-08ca19ea4a65: This value maps to the person’s ID. It does not have to be a GUID. It can be an alphanumeric string that identifies the person, such as user123. |
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
This or identifier | token |
The logical resource id associated with the resource. |
identifier |
This or _id
|
token |
The person identifier. Example: urn:oid:URN:CERNER:IDENTITY-FEDERATION:REALM:5D28F56D-E0B4-4C76-A81F-C7A5C1C23908: PRINCIPAL:TEMP_API_USER |
Headers
Accept: application/fhir+json, "application/json", "application/json+fhir"
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Person?_id=APIUser.1
Response
Status: 200 OK
{
"resourceType": "Person",
"id": "APIUser.5",
"name": [
{
"use": "usual",
"text": "proxy, amick",
"family": "proxy",
"given": [
"amick"
]
}
],
"telecom": [
{
"system": "email",
"value": "amick@gmail.com"
}
],
"active": true,
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><b>Person</b><br /><b>Name</b>:proxy,amick;<br />\n <b>Contacts</b>:amick@gmail.com;<br /><b>Id</b>:APIUser.5;<br />\\r\\n</div>"
}
}
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 may be returned.
Retrieve by id
List an individual Person by its id:
GET /Person/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Person/APIUser.1
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "102c30b4-4620-4539-b372-76ca83ad43d3",
"type": "searchset",
"timestamp": "2022-02-20T23:00:27-05:00",
"entry": [
{
"fullUrl": "https://fhir-myrecord-sc.devcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Person/APIUser.5",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Person",
"id": "APIUser.5",
"name": [
{
"use": "usual",
"text": "proxy, amick",
"family": "proxy",
"given": [
"amick"
]
}
],
"telecom": [
{
"system": "email",
"value": "amick@gmail.com"
}
],
"active": true,
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><b>Person</b><br /><b>Name</b>:proxy,amick;\n <br /><b>Contacts</b>:amick@gmail.com;<br /><b>Id</b>:APIUser.5;<br />\\r\\n</div>"
}
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-myrecord-sc.devcerner.com/r4/9015d117-44ed-4061-bec7-dabd439dc474/Person?_id=APIUser.5"
}
]
}
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 may be returned.