Jump to

• Request
• Response

Get a list of people

get

/Person

Search for a person that meet supplied query parameters.

GET /Person?:parameters

This operation supports the Patient authorization type.
Notes
Federated Principal Alias

A unique alphanumeric string is 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. See the following 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 is the unique identifier of the Identity provider, and 38509e38-2d69-4109-ab24-08ca19ea4a65 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.

Request

Query Parameters

• _id: string
  The logical resource ID associated with the resource.
  Type: token.
• identifier: string
  The person identifier. For example, urn:oid:URN:CERNER:IDENTITY-FEDERATION:REALM:5D28F56D-E0B4-4C76-A81F-C7A5C1C23908:PRINCIPAL:TEMP_API_USER
  Type: token.

Header Parameters

• Accept(required): string
  The media type to be requested. Refer to what the resource's operation produces for what is supported.
• Authorization(required): string
  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

Back to Top

Response

Supported Media Types

• application/fhir+json
• application/json
• application/json+fhir

Default Response

Example Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Person?_id=APIUser.5

Example Response

{
    "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": "[e-mail]"
            }
          ],
          "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>:[e-mail];<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"
      }
    ]
  }

Headers

• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

Back to Top