RelatedPerson

• Overview
• Terminology Bindings
• Search
  • Authorization Types
  • Parameters
  • Headers
  • Example
  • Errors
• Retrieve by id
  • Authorization Types
  • Headers
  • Example
  • Errors

Overview

The RelatedPerson resource provides information about a person who is involved in the care of a patient but has no formal responsibility. RelatedPersons typically have a personal relationship with the patient such as a spouse, relative, friend, guardian, or attorney. RelatedPersons are commonly a source of information about a patient.

The distinction between Practitioner and RelatedPerson is a practitioner cares for multiple patients on behalf of a healthcare facility where a RelatedPerson performs care tasks for a specific patient and is not associated with any healthcare facility.

The following fields are returned if valued:

• RelatedPerson id
• Identifier (Cerner alias Federated Person Principal)
• Patient
• Relationship
• Related person’s name
• Telecom (phone and email)
• Gender
• Date of birth
• Address
• Beginning and end date (time period the relationship is valid)

Terminology Bindings

RelatedPerson.identifier.type

Description The type used to determine which identifier to use for a specific purpose. Details: Identifier Type Codes System: http://hl7.org/fhir/identifier-type Details: v2 Identifier Type System: http://hl7.org/fhir/v2/0203

Search

Search for RelatedPersons that meet supplied query parameters:

GET /RelatedPerson?:parameters

Authorization Types

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, if neither _id nor patient are set	token	A RelatedPerson identifier.
patient	Yes, if neither _id nor identifier are set	reference	A reference to a patient related which the RelatedPerson is associated. Example: 12345

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

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson?urn%3Aoid%3A2.16.840.1.113883.3.13.6%7CURN%3ACERNER%3AIDENTITY-FEDERATION%3AREALM%3AEC2458F2-1E24-41C8-B71B-0E701AF7583D-CH%3APRINCIPAL%3A332TE8FP7VD3RT4C

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "c9e2d518-3ae5-44f2-a61f-ccc68e938ad0",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson?identifier=urn%3Aoid%3A2.16.840.1.113883.3.13.6%7CURN%3ACERNER%3AIDENTITY-FEDERATION%3AREALM%3AE8A84236-C258-4952-98B7-A6FF8A9C587A-CH%3APRINCIPAL%3A332TE8FP7VD3RT4C"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/490017058",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "490017058",
        "meta": {
          "versionId": "6"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>RelatedPerson</b></p><p><b>Name</b>: SMART, HAILEY</p><p><b>DOB</b>: Dec  2, 2003</p><p><b>Sex</b>: Female</p></div>"
        },
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/v2/0203",
                  "code": "AN",
                  "display": "Account number",
                  "userSelected": false
                }
              ],
              "text": "Federated Person Principal"
            },
            "system": "urn:oid:2.16.840.1.113883.3.13.6",
            "value": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:332TE8FP7VD3RT4C",
            "_value": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/rendered-value",
                  "valueString": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:332TE8FP7VD3RT4C"
                }
              ]
            },
            "period": {
              "start": "2020-06-30T20:26:38.000Z"
            }
          }
        ],
        "patient": {
          "reference": "Patient/12724066",
          "display": "SMART, NANCY"
        },
        "name": {
          "use": "official",
          "text": "SMART, HAILEY",
          "family": [
            "SMART"
          ],
          "given": [
            "HAILEY"
          ],
          "period": {
            "start": "2019-12-26T15:15:35.000Z"
          }
        },
        "telecom": [
          {
            "system": "phone",
            "value": "8168888886",
            "use": "home",
            "period": {
              "start": "2019-12-26T15:15:35.000Z"
            }
          },
          {
            "system": "email",
            "value": "haileysmart@yopmail.com",
            "use": "home",
            "period": {
              "start": "2020-06-30T19:56:19.000Z"
            }
          }
        ],
        "gender": "female",
        "birthDate": "2003-12-02",
        "address": [
          {
            "use": "home",
            "text": "12345 Main St\\nKansas City, MO 64116\\nUS",
            "line": [
              "12345 Main St"
            ],
            "city": "Kansas City",
            "district": "Jackson",
            "state": "MO",
            "postalCode": "64116",
            "country": "US",
            "period": {
              "start": "2019-12-26T15:15:03.000Z"
            }
          }
        ],
        "period": {
          "start": "2019-12-26T16:06:26.000Z"
        }
      }
    }
  ]
}

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 RelatedPerson by its id:

GET /RelatedPerson/:id

Authorization Types

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/490017058

Response

Status: 200 OK

{
  "resourceType": "RelatedPerson",
  "id": "490017058",
  "meta": {
    "versionId": "6"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>RelatedPerson</b></p><p><b>Name</b>: SMART, HAILEY</p><p><b>DOB</b>: Dec  2, 2003</p><p><b>Sex</b>: Female</p></div>"
  },
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/v2/0203",
            "code": "AN",
            "display": "Account number",
            "userSelected": false
          }
        ],
        "text": "Federated Person Principal"
      },
      "system": "urn:oid:2.16.840.1.113883.3.13.6",
      "value": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:332TE8FP7VD3RT4C",
      "_value": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/rendered-value",
            "valueString": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:332TE8FP7VD3RT4C"
          }
        ]
      },
      "period": {
        "start": "2020-06-30T20:26:38.000Z"
      }
    }
  ],
  "patient": {
    "reference": "Patient/12724066",
    "display": "SMART, NANCY"
  },
  "name": {
    "use": "official",
    "text": "SMART, HAILEY",
    "family": [
      "SMART"
    ],
    "given": [
      "HAILEY"
    ],
    "period": {
      "start": "2019-12-26T15:15:35.000Z"
    }
  },
  "telecom": [
    {
      "system": "phone",
      "value": "8168888886",
      "use": "home",
      "period": {
        "start": "2019-12-26T15:15:35.000Z"
      }
    },
    {
      "system": "email",
      "value": "haileysmart@yopmail.com",
      "use": "home",
      "period": {
        "start": "2020-06-30T19:56:19.000Z"
      }
    }
  ],
  "gender": "female",
  "birthDate": "2003-12-02",
  "address": [
    {
      "use": "home",
      "text": "12345 Main St\\nKansas City, MO 64116\\nUS",
      "line": [
        "12345 Main St"
      ],
      "city": "Kansas City",
      "district": "Jackson",
      "state": "MO",
      "postalCode": "64116",
      "country": "US",
      "period": {
        "start": "2019-12-26T15:15:03.000Z"
      }
    }
  ],
  "period": {
    "start": "2019-12-26T16:06:26.000Z"
  }
}

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.