RelatedPerson

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:

Terminology Bindings

RelatedPerson.identifier.type
RelatedPerson.communication.language
  • Description
    • The language used to communicate with a related person about a patient's health.
  • Details: CommonLanguages
    System: urn:ietf:bcp:47

  • Details: Millennium Languages
    System: https://fhir.cerner.com/<EHR source id>/codeSet/36

RelatedPerson.relationship
  • Description
    • The nature of the relationship between a patient and the related person.
  • Details: PatientRelationshipType
    System: http://terminology.hl7.org/CodeSystem/v2-0131
    System: http://terminology.hl7.org/CodeSystem/v3-RoleCode

  • Details: Millennium Person Relationship Types
    System: https://fhir.cerner.com/<EHR source id>/codeSet/351

RelatedPerson.relationship.extension[x].valueCodeableConcept
  • Description
    • The related person's familial relationship to the patient. This binding is used in relation extensions.
  • Details: PatientRelationshipType
    System: http://terminology.hl7.org/CodeSystem/v2-0131
    System: http://terminology.hl7.org/CodeSystem/v3-RoleCode

  • Details: Millennium Person Relationships
    System: https://fhir.cerner.com/<EHR source id>/codeSet/40

RelatedPerson.extension[x].valueCodeableConcept
  • Description
    • The resource's relationship to either the patient or encounter level. This binding is used in relationship-level extensions.
  • Details: Relationship Level
    System: http://hl7.org/fhir/resource-types

Extensions

Custom Extensions

All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}

ID Value[x] Type Description
related-person-encounter reference Reference to the Encounter associated to the encounter level RelatedPerson.
relationship-level CodeableConcept The resource’s relationship to either patient or encounter.
period Period A time period defined by a start and end date/time.
relation CodeableConcept The related person’s familial relationship to the patient.

Search for RelatedPersons that meet supplied query parameters:

GET /RelatedPerson?:parameters

Implementation Notes

Authorization Types

Parameters

Name Required? Type Description
_id This or patient or identifier or -encounter token The logical resource id associated with the resource.
identifier This or _id or patient or -encounter token A RelatedPerson identifier.
patient This or _id or identifier or -encounter reference A reference to a patient associated with the RelatedPerson. Example: 14067892
-encounter This or _id or patient or identifier reference A reference to an encounter associated with the RelatedPerson. Example: 97697434
-relationship-level no token The level of relationship for the RelatedPerson. Example: -relationship-level= http://hl7.org/fhir/resource-types|Patient

Notes:

Headers

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

Example - Search by Patient

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson?patient=12724066&-relationship-level=Patient

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "106abf01-6358-44d4-8f66-37526caa6ab4",
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson?patient=12724066"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/12724066-12724068",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "12724066-12724068",
        "meta": {
          "versionId": 145,
          "lastUpdated": "2021-03-22T14:12:37.000Z"
        },
        "text": {
          "status": "extensions",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Related Person</b></p><p><b>Name</b>: SMART, NANCY</p><p><b>DOB</b>: Aug 11, 1980</p><p><b>Gender</b>: female</p><p><b>Patient</b>: SMART, HAILEY</p><p><b>Status</b>: Active</p><p><b>Relationship</b>: Default Guarantor</p><p><b>Relationship</b>: Child</p><p><b>Relationship</b>: Family Member</p><p><b>Relationship Level</b>: Patient</p></div>"
        },
        "extension": [
          {
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/resource-types",
                  "code": "Patient",
                  "display": "Patient"
                }
              ],
              "text": "Patient"
            },
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level"
          }
        ],
        "identifier": [
          {
            "id": "CI-490060520-1",
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
                  "code": "22",
                  "display": "Military Id",
                  "userSelected": true
                }
              ],
              "text": "Military Id"
            },
            "system": "urn:oid:2.16.840.1.113883.3.42.10001.100001.12",
            "value": "1000000105"
          },
          {
            "id": "CI-490068325-2",
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
                  "code": "2553236771",
                  "display": "Federated Person Principal",
                  "userSelected": true
                },
                {
                  "system": "http://terminology.hl7.org/CodeSystem/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:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:RS7MH9WX3XB8VY63",
            "period": {
              "start": "2020-08-10T14:29:20.000Z"
            }
          },
          {
            "id": "CI-490059563-3",
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
                  "code": "2553236771",
                  "display": "Federated Person Principal",
                  "userSelected": true
                },
                {
                  "system": "http://terminology.hl7.org/CodeSystem/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:RS7MH9WX3XB8VY63",
            "period": {
              "start": "2020-06-30T20:06:42.000Z"
            }
          },
          {
            "id": "CI-490153231-4",
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
                  "code": "2553236785",
                  "display": "MIllennium Person Identifier",
                  "userSelected": true
                }
              ],
              "text": "MIllennium Person Identifier"
            },
            "value": "12868",
            "period": {
              "start": "2020-12-18T19:15:06.000Z"
            }
          }
        ],
        "active": true,
        "patient": {
          "reference": "Patient/12724068",
          "display": "SMART, HAILEY"
        },
        "relationship": [
          {
            "id": "CI-490017041-0",
            "extension": [
              {
                "valuePeriod": {
                  "start": "2019-12-26T16:06:26.000Z"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                      "code": "156",
                      "display": "Mother",
                      "userSelected": true
                    },
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                      "code": "MTH",
                      "display": "mother",
                      "userSelected": false
                    }
                  ],
                  "text": "Mother"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
              }
            ],
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
                "code": "1150",
                "display": "Default Guarantor",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "GT",
                "display": "Guarantor",
                "userSelected": false
              }
            ],
            "text": "Default Guarantor"
          },
          {
            "id": "CI-490017055-1",
            "extension": [
              {
                "valuePeriod": {
                  "start": "2019-12-26T16:06:26.000Z"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                      "code": "156",
                      "display": "Mother",
                      "userSelected": true
                    },
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                      "code": "MTH",
                      "display": "mother",
                      "userSelected": false
                    },
                    {
                      "text": "Mother"
                    }
                  ]
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
              }
            ],
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
                "code": "1153",
                "display": "Family Member",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "FAMMEMB",
                "display": "family member",
                "userSelected": false
              }
            ],
            "text": "Family Member"
          }
        ],
        "name": [
          {
            "id": "CI-12724066-0",
            "use": "official",
            "text": "SMART, NANCY",
            "family": "SMART",
            "given": [
              "NANCY"
            ],
            "period": {
              "start": "2019-12-26T15:12:34.000Z"
            }
          }
        ],
        "telecom": [
          {
            "id": "CI-PH-29852801-0",
            "extension": [
              {
                "valueUrl": "13215555555",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "13215555555",
            "use": "work",
            "period": {
              "start": "2021-03-22T14:12:37.000Z"
            }
          },
          {
            "id": "CI-PH-29811918-1",
            "extension": [
              {
                "valueUrl": "(987)654-3210",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "9876543210",
            "use": "home",
            "period": {
              "start": "2019-12-26T15:12:34.000Z"
            }
          },
          {
            "id": "CI-PH-29844706-2",
            "extension": [
              {
                "valueUrl": "(503)400-8675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T05:00:00.000Z"
            }
          },
          {
            "id": "CI-PH-29844710-3",
            "extension": [
              {
                "valueUrl": "5034008675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T05:00:00.000Z"
            }
          },
          {
            "id": "CI-PH-29844690-4",
            "extension": [
              {
                "valueUrl": "5034008675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T05:00:00.000Z"
            }
          },
          {
            "id": "CI-PH-29844708-5",
            "extension": [
              {
                "valueUrl": "5034008675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T05:00:00.000Z"
            }
          },
          {
            "id": "CI-PH-29844688-6",
            "extension": [
              {
                "valueUrl": "5034008675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T00:33:18.000Z"
            }
          },
          {
            "id": "CI-EM-29822894-0",
            "system": "email",
            "value": "workemail@gmail.com",
            "use": "home",
            "period": {
              "start": "2020-06-30T19:47:10.000Z"
            }
          }
        ],
        "gender": "female",
        "birthDate": "1980-08-11",
        "address": [
          {
            "id": "CI-24313551-0",
            "use": "home",
            "text": "3P\\nKANSAS CITY, MO 641510001\\nUS",
            "line": [
              "3P"
            ],
            "city": "KANSAS CITY",
            "district": "Jackson",
            "state": "MO",
            "postalCode": "641510001",
            "country": "US",
            "period": {
              "start": "2020-12-08T15:05:44.000Z"
            }
          }
        ],
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
                  "code": "151",
                  "display": "English",
                  "userSelected": true
                },
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "en",
                  "display": "English",
                  "userSelected": false
                }
              ],
              "text": "English"
            },
            "preferred": "true"
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/12724066-12724069",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "12724066-12724069",
        "meta": {
          "versionId": 145,
          "lastUpdated": "2021-03-22T14:12:37.000Z"
        },
        "text": {
          "status": "extensions",
          "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Related Person</b></p><p><b>Name</b>: SMART, NANCY</p><p><b>DOB</b>: Aug 11, 1980</p><p><b>Gender</b>: female</p><p><b>Patient</b>: SMART, TIMMY</p><p><b>Status</b>: Active</p><p><b>Relationship</b>: Authorized Representative</p><p><b>Relationship</b>: Default Guarantor</p><p><b>Relationship</b>: Child</p><p><b>Relationship</b>: Family Member</p><p><b>Relationship Level</b>: Patient</p></div>"
        },
        "extension": [
          {
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/resource-types",
                  "code": "Patient",
                  "display": "Patient"
                }
              ],
              "text": "Patient"
            },
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level"
          }
        ],
        "identifier": [
          {
            "id": "CI-490060520-1",
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
                  "code": "22",
                  "display": "Military Id",
                  "userSelected": true
                }
              ],
              "text": "Military Id"
            },
            "system": "urn:oid:2.16.840.1.113883.3.42.10001.100001.12",
            "value": "1000000105"
          },
          {
            "id": "CI-490068325-2",
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
                  "code": "2553236771",
                  "display": "Federated Person Principal",
                  "userSelected": true
                },
                {
                  "system": "http://terminology.hl7.org/CodeSystem/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:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:RS7MH9WX3XB8VY63",
            "period": {
              "start": "2020-08-10T14:29:20.000Z"
            }
          },
          {
            "id": "CI-490059563-3",
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
                  "code": "2553236771",
                  "display": "Federated Person Principal",
                  "userSelected": true
                },
                {
                  "system": "http://terminology.hl7.org/CodeSystem/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:RS7MH9WX3XB8VY63",
            "period": {
              "start": "2020-06-30T20:06:42.000Z"
            }
          },
          {
            "id": "CI-490153231-4",
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
                  "code": "2553236785",
                  "display": "MIllennium Person Identifier",
                  "userSelected": true
                }
              ],
              "text": "MIllennium Person Identifier"
            },
            "value": "12868",
            "period": {
              "start": "2020-12-18T19:15:06.000Z"
            }
          }
        ],
        "active": true,
        "patient": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "relationship": [
          {
            "id": "CI-490068369-0",
            "extension": [
              {
                "valuePeriod": {
                  "start": "2020-08-10T16:37:51.000Z"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                      "code": "156",
                      "display": "Mother",
                      "userSelected": true
                    },
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                      "code": "MTH",
                      "display": "mother",
                      "userSelected": false
                    }
                  ],
                  "text": "Mother"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
              }
            ],
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
                "code": "2553243305",
                "display": "Authorized Representative",
                "userSelected": true
              }
            ],
            "text": "Authorized Representative"
          },
          {
            "id": "CI-490017075-1",
            "extension": [
              {
                "valuePeriod": {
                  "start": "2019-12-26T16:09:36.000Z"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                      "code": "156",
                      "display": "Mother",
                      "userSelected": true
                    },
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                      "code": "MTH",
                      "display": "mother",
                      "userSelected": false
                    }
                  ],
                  "text": "Mother"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
              }
            ],
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
                "code": "1150",
                "display": "Default Guarantor",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "GT",
                "display": "Guarantor",
                "userSelected": false
              }
            ],
            "text": "Default Guarantor"
          },
          {
            "id": "CI-490068372-2",
            "extension": [
              {
                "valuePeriod": {
                  "start": "2020-08-10T16:37:51.000Z"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                      "code": "152"
                    }
                  ]
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
              }
            ],
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
                "code": "1153",
                "display": "Family Member",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "FAMMEMB",
                "display": "family member",
                "userSelected": false
              }
            ],
            "text": "Family Member"
          }
        ],
        "name": [
          {
            "id": "CI-12724066-0",
            "use": "official",
            "text": "SMART, NANCY",
            "family": "SMART",
            "given": [
              "NANCY"
            ],
            "period": {
              "start": "2019-12-26T15:12:34.000Z"
            }
          }
        ],
        "telecom": [
          {
            "id": "CI-PH-29852801-0",
            "extension": [
              {
                "valueUrl": "13215555555",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "13215555555",
            "use": "work",
            "period": {
              "start": "2021-03-22T14:12:37.000Z"
            }
          },
          {
            "id": "CI-PH-29811918-1",
            "extension": [
              {
                "valueUrl": "(987)654-3210",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "9876543210",
            "use": "home",
            "period": {
              "start": "2019-12-26T15:12:34.000Z"
            }
          },
          {
            "id": "CI-PH-29844706-2",
            "extension": [
              {
                "valueUrl": "(503)400-8675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T05:00:00.000Z"
            }
          },
          {
            "id": "CI-PH-29844710-3",
            "extension": [
              {
                "valueUrl": "5034008675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T05:00:00.000Z"
            }
          },
          {
            "id": "CI-PH-29844690-4",
            "extension": [
              {
                "valueUrl": "5034008675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T05:00:00.000Z"
            }
          },
          {
            "id": "CI-PH-29844708-5",
            "extension": [
              {
                "valueUrl": "5034008675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T05:00:00.000Z"
            }
          },
          {
            "id": "CI-PH-29844688-6",
            "extension": [
              {
                "valueUrl": "5034008675",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "5034008675",
            "use": "mobile",
            "period": {
              "start": "2021-01-25T00:33:18.000Z"
            }
          },
          {
            "id": "CI-EM-29822894-0",
            "system": "email",
            "value": "workemail@gmail.com",
            "use": "home",
            "period": {
              "start": "2020-06-30T19:47:10.000Z"
            }
          }
        ],
        "gender": "female",
        "birthDate": "1980-08-11",
        "address": [
          {
            "id": "CI-24313551-0",
            "use": "home",
            "text": "3P\\nKANSAS CITY, MO 641510001\\nUS",
            "line": [
              "3P"
            ],
            "city": "KANSAS CITY",
            "district": "Jackson",
            "state": "MO",
            "postalCode": "641510001",
            "country": "US",
            "period": {
              "start": "2020-12-08T15:05:44.000Z"
            }
          }
        ],
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
                  "code": "151",
                  "display": "English",
                  "userSelected": true
                },
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "en",
                  "display": "English",
                  "userSelected": false
                }
              ],
              "text": "English"
            },
            "preferred": "true"
          }
        ]
      }
    }
  ]
}

Example - Search by Encounter

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson?-encounter=97697434

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "8de80541-8f9c-4168-a308-bce0c576e945",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson?-encounter=97697434"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/E-12457994-97697434",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "E-12457994-97697434",
        "meta": {
          "versionId": "21",
          "lastUpdated": "2018-10-30T14:17:47.000Z"
        },
        "text": {
          "status": "extensions",
          "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Related Person</b></p><p><b>Name</b>:MATERNITY, TESTTHREE</p><p><b>DOB</b>: Jun 20, 1987</p><p><b>Gender</b>:female</p><p><b>Patient</b>: NEWBORN, TESTTHREE</p><p><b>Status</b>:Active</p><p><b>Relationship</b>: Default Guarantor</p><p><b>Relationship</b>:Child</p><p><b>Relationship Level</b>: Encounter</p><p><b>Encounter</b>: 97697434</p></div>"
        },
        "extension": [
          {
            "valueReference": {
              "reference": "Encounter/97697434"
            },
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter"
          },
          {
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/resource-types",
                  "code": "Encounter",
                  "display": "Encounter"
                }
              ],
              "text": "Encounter"
            },
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level"
          }
        ],
        "active": true,
        "patient": {
          "reference": "Patient/12457995",
          "display": "NEWBORN, TESTTHREE"
        },
        "relationship": [
          {
            "id": "CI-97982588-0",
            "extension": [
              {
                "valuePeriod": {
                  "start": "2016-12-08T21:53:53.000Z"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                      "code": "156",
                      "display": "Mother",
                      "userSelected": true
                    },
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                      "code": "MTH",
                      "display": "mother",
                      "userSelected": false
                    }
                  ],
                  "text": "Mother"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
              }
            ],
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
                "code": "1150",
                "display": "Default Guarantor",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "GT",
                "display": "Guarantor",
                "userSelected": false
              }
            ],
            "text": "Default Guarantor"
          }
        ],
        "name": [
          {
            "id": "CI-12457994-0",
            "use": "official",
            "text": "MATERNITY, TESTTHREE",
            "family": "MATERNITY",
            "given": [
              "TESTTHREE"
            ],
            "period": {
              "start": "2016-12-08T21:28:22.000Z"
            }
          }
        ],
        "telecom": [
          {
            "id": "CI-PH-29583893-0",
            "extension": [
              {
                "valueUrl": "816-888-8886",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "system": "phone",
            "value": "4264758753",
            "use": "home",
            "period": {
              "start": "2016-12-08T21:28:22.000Z"
            }
          }
        ],
        "gender": "female",
        "birthDate": "1987-06-20",
        "address": [
          {
            "id": "CI-24079465-0",
            "use": "home",
            "text": "3343 Genessee St\\nKansas City, MO 64111\\nUS",
            "line": [
              "3343 Genessee St"
            ],
            "city": "Kansas City",
            "state": "MO",
            "postalCode": "64111",
            "country": "US",
            "period": {
              "start": "2016-12-08T21:05:59.000Z"
            }
          }
        ],
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
                  "code": "151",
                  "display": "English",
                  "userSelected": true
                },
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "en",
                  "display": "English",
                  "userSelected": false
                }
              ],
              "text": "English"
            },
            "preferred": "true"
          }
        ]
      }
    }
  ]
}

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

Implementation Notes

Authorization Types

Headers

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

Example - Patient-level RelatedPerson

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/12724068-12724066

Response

Status: 200 OK
{
  "resourceType": "RelatedPerson",
  "id": "12724066-12724068",
  "meta": {
    "versionId": 145,
    "lastUpdated": "2021-03-22T14:12:37.000Z"
  },
  "text": {
    "status": "extensions",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Related Person</b></p><p><b>Name</b>: SMART, NANCY</p><p><b>DOB</b>: Aug 11, 1980</p><p><b>Gender</b>: female</p><p><b>Patient</b>: SMART, HAILEY</p><p><b>Status</b>: Active</p><p><b>Relationship</b>: Default Guarantor</p><p><b>Relationship</b>: Child</p><p><b>Relationship</b>: Family Member</p><p><b>Relationship Level</b>: Patient</p></div>"
  },
  "extension": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Patient",
            "display": "Patient"
          }
        ],
        "text": "Patient"
      },
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level"
    }
  ],
  "identifier": [
    {
      "id": "CI-490060520-1",
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
            "code": "22",
            "display": "Military Id",
            "userSelected": true
          }
        ],
        "text": "Military Id"
      },
      "system": "urn:oid:2.16.840.1.113883.3.42.10001.100001.12",
      "value": "1000000105"
    },
    {
      "id": "CI-490068325-2",
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
            "code": "2553236771",
            "display": "Federated Person Principal",
            "userSelected": true
          },
          {
            "system": "http://terminology.hl7.org/CodeSystem/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:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:RS7MH9WX3XB8VY63",
      "period": {
        "start": "2020-08-10T14:29:20.000Z"
      }
    },
    {
      "id": "CI-490059563-3",
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
            "code": "2553236771",
            "display": "Federated Person Principal",
            "userSelected": true
          },
          {
            "system": "http://terminology.hl7.org/CodeSystem/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:RS7MH9WX3XB8VY63",
      "period": {
        "start": "2020-06-30T20:06:42.000Z"
      }
    },
    {
      "id": "CI-490153231-4",
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
            "code": "2553236785",
            "display": "MIllennium Person Identifier",
            "userSelected": true
          }
        ],
        "text": "MIllennium Person Identifier"
      },
      "value": "12868",
      "period": {
        "start": "2020-12-18T19:15:06.000Z"
      }
    }
  ],
  "active": true,
  "patient": {
    "reference": "Patient/12724068",
    "display": "SMART, HAILEY"
  },
  "relationship": [
    {
      "id": "CI-490017041-0",
      "extension": [
        {
          "valuePeriod": {
            "start": "2019-12-26T16:06:26.000Z"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                "code": "156",
                "display": "Mother",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "MTH",
                "display": "mother",
                "userSelected": false
              }
            ],
            "text": "Mother"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
        }
      ],
      "coding": [
        {
          "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
          "code": "1150",
          "display": "Default Guarantor",
          "userSelected": true
        },
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "GT",
          "display": "Guarantor",
          "userSelected": false
        }
      ],
      "text": "Default Guarantor"
    },
    {
      "id": "CI-490017055-1",
      "extension": [
        {
          "valuePeriod": {
            "start": "2019-12-26T16:06:26.000Z"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                "code": "156",
                "display": "Mother",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "MTH",
                "display": "mother",
                "userSelected": false
              },
              {
                "text": "Mother"
              }
            ]
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
        }
      ],
      "coding": [
        {
          "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
          "code": "1153",
          "display": "Family Member",
          "userSelected": true
        },
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "FAMMEMB",
          "display": "family member",
          "userSelected": false
        }
      ],
      "text": "Family Member"
    }
  ],
  "name": [
    {
      "id": "CI-12724066-0",
      "use": "official",
      "text": "SMART, NANCY",
      "family": "SMART",
      "given": [
        "NANCY"
      ],
      "period": {
        "start": "2019-12-26T15:12:34.000Z"
      }
    }
  ],
  "telecom": [
    {
      "id": "CI-PH-29852801-0",
      "extension": [
        {
          "valueUrl": "13215555555",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "13215555555",
      "use": "work",
      "period": {
        "start": "2021-03-22T14:12:37.000Z"
      }
    },
    {
      "id": "CI-PH-29811918-1",
      "extension": [
        {
          "valueUrl": "(987)654-3210",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "9876543210",
      "use": "home",
      "period": {
        "start": "2019-12-26T15:12:34.000Z"
      }
    },
    {
      "id": "CI-PH-29844706-2",
      "extension": [
        {
          "valueUrl": "(503)400-8675",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "5034008675",
      "use": "mobile",
      "period": {
        "start": "2021-01-25T05:00:00.000Z"
      }
    },
    {
      "id": "CI-PH-29844710-3",
      "extension": [
        {
          "valueUrl": "5034008675",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "5034008675",
      "use": "mobile",
      "period": {
        "start": "2021-01-25T05:00:00.000Z"
      }
    },
    {
      "id": "CI-PH-29844690-4",
      "extension": [
        {
          "valueUrl": "5034008675",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "5034008675",
      "use": "mobile",
      "period": {
        "start": "2021-01-25T05:00:00.000Z"
      }
    },
    {
      "id": "CI-PH-29844708-5",
      "extension": [
        {
          "valueUrl": "5034008675",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "5034008675",
      "use": "mobile",
      "period": {
        "start": "2021-01-25T05:00:00.000Z"
      }
    },
    {
      "id": "CI-PH-29844688-6",
      "extension": [
        {
          "valueUrl": "5034008675",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "5034008675",
      "use": "mobile",
      "period": {
        "start": "2021-01-25T00:33:18.000Z"
      }
    },
    {
      "id": "CI-EM-29822894-0",
      "system": "email",
      "value": "workemail@gmail.com",
      "use": "home",
      "period": {
        "start": "2020-06-30T19:47:10.000Z"
      }
    }
  ],
  "gender": "female",
  "birthDate": "1980-08-11",
  "address": [
    {
      "id": "CI-24313551-0",
      "use": "home",
      "text": "3P\\nKANSAS CITY, MO 641510001\\nUS",
      "line": [
        "3P"
      ],
      "city": "KANSAS CITY",
      "district": "Jackson",
      "state": "MO",
      "postalCode": "641510001",
      "country": "US",
      "period": {
        "start": "2020-12-08T15:05:44.000Z"
      }
    }
  ],
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
            "code": "151",
            "display": "English",
            "userSelected": true
          },
          {
            "system": "urn:ietf:bcp:47",
            "code": "en",
            "display": "English",
            "userSelected": false
          }
        ],
        "text": "English"
      },
      "preferred": "true"
    }
  ]
}

Example - Encounter-level RelatedPerson

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/E-12457994-97697434

Response

Status: 200 OK
{
  "resourceType": "RelatedPerson",
  "id": "E-12457994-97697434",
  "meta": {
    "versionId": "21",
    "lastUpdated": "2018-10-30T14:17:47.000Z"
  },
  "text": {
    "status": "extensions",
    "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Related Person</b></p><p><b>Name</b>: MATERNITY, TESTTHREE</p><p><b>DOB</b>: Jun 20, 1987</p><p><b>Gender</b>: female</p><p><b>Patient</b>: NEWBORN, TESTTHREE</p><p><b>Status</b>: Active</p><p><b>Relationship</b>: Default Guarantor</p><p><b>Relationship</b>: Child</p><p><b>Relationship Level</b>: Encounter</p><p><b>Encounter</b>: 97697434</p></div>"
  },
  "extension": [
    {
      "valueReference": {
        "reference": "Encounter/97697434"
      },
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter"
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Encounter",
            "display": "Encounter"
          }
        ],
        "text": "Encounter"
      },
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level"
    }
  ],
  "active": true,
  "patient": {
    "reference": "Patient/12457995",
    "display": "NEWBORN, TESTTHREE"
  },
  "relationship": [
    {
      "id": "CI-97982588-0",
      "extension": [
        {
          "valuePeriod": {
            "start": "2016-12-08T21:53:53.000Z"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40",
                "code": "156",
                "display": "Mother",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "MTH",
                "display": "mother",
                "userSelected": false
              }
            ],
            "text": "Mother"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
        }
      ],
      "coding": [
        {
          "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
          "code": "1150",
          "display": "Default Guarantor",
          "userSelected": true
        },
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "GT",
          "display": "Guarantor",
          "userSelected": false
        }
      ],
      "text": "Default Guarantor"
    }
  ],
  "name": [
    {
      "id": "CI-12457994-0",
      "use": "official",
      "text": "MATERNITY, TESTTHREE",
      "family": "MATERNITY",
      "given": [
        "TESTTHREE"
      ],
      "period": {
        "start": "2016-12-08T21:28:22.000Z"
      }
    }
  ],
  "telecom": [
    {
      "id": "CI-PH-29583893-0",
      "extension": [
        {
          "valueUrl": "426-475-8753",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "4264758753",
      "use": "home",
      "period": {
        "start": "2016-12-08T21:28:22.000Z"
      }
    }
  ],
  "gender": "female",
  "birthDate": "1987-06-20",
  "address": [
    {
      "id": "CI-24079465-0",
      "use": "home",
      "text": "3343 Genessee St\nKansas City, MO 64111\nUS",
      "line": [
        "3343 Genessee St"
      ],
      "city": "Kansas City",
      "state": "MO",
      "postalCode": "64111",
      "country": "US",
      "period": {
        "start": "2016-12-08T21:05:59.000Z"
      }
    }
  ],
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
            "code": "151",
            "display": "English",
            "userSelected": true
          },
          {
            "system": "urn:ietf:bcp:47",
            "code": "en",
            "display": "English",
            "userSelected": false
          }
        ],
        "text": "English"
      },
      "preferred": "true"
    }
  ]
}

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.

Create

Create a new Encounter-level or Patient-level RelatedPerson.

POST /RelatedPerson

Implementation Notes

Authorization Types

Headers

Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json

Body Field

Name Required Type
resourceType Yes string
  • Description
    • The type of the FHIR resource.
  • Example
    • {
        "resourceType": "RelatedPerson"
      }
      
  • Notes
    • resourceType must be RelatedPerson.
relationship Yes CodeableConcept
  • Description
    • The nature of the relationship between a patient and the related person.
  • Example
    • {
        "relationship": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "FAMMEMB"
              }
            ]
          }
          {
            "extension": [
              {
                "valuePeriod": {
                  "start": "2016-12-19T16:44:25.000Z",
                  "end": "2022-05-01T16:56:56.000Z"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                      "code": "SIS"
                    }
                  ]
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
              }
            ]
          }
        ]
      }
      
  • Notes
      • When specifying a period, the fields must include a time component with a timezone.
      • The coding field can contain codings from the standard or proprietary system, but not both.
      • Only one coding may be provided.
patient Yes Reference (Patient)
  • Description
    • Patient that the individual is related to for the Encounter-level RelatedPerson.
  • Example
    • {
        "patient": {
          "reference": "Patient/12724066"
        }
      }
      
name Yes List of HumanName
  • Description
    • The name associated with the individual.
  • Example
    • {
        "name": [
          {
            "use": "official",
            "family": "Doe",
            "given": [
              "John",
              "Smith"
            ],
            "period": {
              "start": "2010-05-17T14:54:31.000Z"
            }
          }
        ]
      }
      
  • Notes
      • Exactly one name must be provided. The provided name must meet the following conditions:
        • Must have a use of 'official'.
        • Cannot contain the text field.
        • Must contain either the given or family fields.
        • Up to two given names may be provided. If additional given names are required they must be provided in the second value as a single string separated by blank spaces.
        •  Only one prefix and one suffix may be provided.
        • period.end is not supported.
        • When specifying a period, the fields must include a time component with a timezone.
Related Person Encounter No Extension
  • Description
    • A reference to an Encounter.
  • Example
    • {
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter",
            "valueReference": {
              "reference": "Encounter/97939518"
            }
          }
        ]
      }
      
  • Notes
      • The valueReference.reference must be an Encounter reference.
Relationship Level No Extension
  • Description
    • The resource's relationship to either the patient or encounter level.
  • Example
    • {
        "extension": [
          {
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/resource-types",
                  "code": "Encounter",
                }
              ]
            }
          }
        ]
      }
      
  • Notes
identifier No List of Identifier
  • Description
    • The identifiers for the related person.
  • Example
    • {
        "identifier": [
          {
            "type": {
              "coding": [
                {
                  "code": "MR",
                  "system": "http://hl7.org/fhir/v2/0203"
                }
              ]
            },
            "system": "urn:oid:5.5.5.5.5.5",
            "value": "<UNIQUE IDENTIFIER>",
            "period": {
              "start": "2016-01-02T00:00:00-05:00",
              "end": "2020-01-02T00:00:00-05:00"
            }
          }
        ]
      }
      
  • Notes
      • Each identifier must not contain the use fields.
      • Each identifier must contain the type, system, and value fields.
      • When specifying a period, the fields must include a time component with a timezone.
address No List of Address
  • Description
    • Addresses for the individual.
  • Example
    • {
        "address": [
          {
            "use": "home",
            "line": [
               "1212 Faircastle Drive",
               "Apartment 406"
            ],
            "city": "KC",
            "district": "Jackson",
            "state": "KS",
            "postalCode": "64199",
            "country": "United States of America",
            "period": {
              "start": "2012-05-17T15:33:18.000Z"
            }
          }
        ]
      }
      
  • Notes
      • Each address must contain the use field.
      • Each address must not contain the text field.
      • When specifying a period, the fields must include a time component with a timezone.
      • If line is provided, only the first four values are used. Additional values will be ignored.
telecom No List of ContactPoint
  • Description
    • A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
  • Example
    • {
        "telecom": [
          {
            "system": "phone",
            "value": "8168229121",
            "use": "home",
            "period": {
              "start": "2012-05-17T15:33:18.000Z"
            }
          },
          {
            "system": "email",
            "value": "testemail@example.com",
            "use": "home",
            "period": {
              "start": "2008-01-10T15:33:18.000Z"
            }
          }
        ]
      }
      
  • Notes
      • Each telecom must contain the system, use, and value fields.
      • System must be a phone or an email.
      • When specifying a period, the fields must include a time component with a timezone.
active No boolean
  • Description
    • Whether this related person record is in active use.
  • Example
    • {
        "active": true
      }
      
  • Notes
    • If set, value must be true.
gender No code
  • Description
    • Administrative Gender - the gender that the related person is considered to have for administration and record keeping purposes.
  • Example
    • {
        "gender": "male"
      }
      
birthDate No date
  • Description
    • The date of birth for the individual.
  • Example
    • {
        "birthDate": "1990-09-15"
      }
      
communication No List of BackboneElement
  • Description
    • Language which may be used to communicate with the related person.
  • Example
    • {
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "urn:ietf:bcp:47",
          	    "code": "en",
                  "display": "English"
                }
              ]
            },
            "preferred": true
          }
        ]
      }
      
  • Notes
      • Only one communication may be provided.
      • communication.prefered if provided should be true

Example - Patient-Level RelatedPerson

Request

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson

Body

{
  "resourceType": "RelatedPerson",
  "extension": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Patient"
          }
        ]
      },
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level"
    }
  ],
  "identifier": [
    {
      "type": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
            "code": "22"
          }
        ]
      },
      "system": "urn:oid:2.16.840.1.113883.3.42.10001.100001.12",
      "value": "1000000105"
    }
  ],
  "active": true,
  "patient": {
    "reference": "Patient/12724068"
  },
  "relationship": [
    {
      "extension": [
        {
          "valuePeriod": {
            "start": "2019-12-26T16:06:26.000Z"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "MTH"
              }
            ]
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
        }
      ],
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "GT"
        }
      ]
    }
  ],
  "name": [
    {
      "use": "official",
      "family": "SMART",
      "given": [
        "NANCY"
      ],
      "period": {
        "start": "2019-12-26T15:12:34.000Z"
      }
    }
  ],
  "telecom": [
    {
      "extension": [
        {
          "valueUrl": "13215555555",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "system": "phone",
      "value": "13215555555",
      "use": "work",
      "period": {
        "start": "2021-03-22T14:12:37.000Z"
      }
    }
  ],
  "gender": "female",
  "birthDate": "1980-08-11",
  "address": [
    {
      "use": "home",
      "line": [
        "3P"
      ],
      "city": "KANSAS CITY",
      "district": "Jackson",
      "state": "MO",
      "postalCode": "641510001",
      "country": "US",
      "period": {
        "start": "2020-12-08T15:05:44.000Z"
      }
    }
  ],
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
            "code": "151"
          },
          {
            "system": "urn:ietf:bcp:47",
            "code": "en"
          }
        ]
      },
      "preferred": "true"
    }
  ]
}

Response

Status: 201 Created
Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Fri, 16 Jul 2021 17:23:14 GMT
Etag: W/"0"
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/12724066-12724068
Last-Modified: Fri, 16 Jul 2021 17:23:13 GMT
Vary: Origin
X-Request-Id: 11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on subsequent updates.

Example - Encounter-Level RelatedPerson

Request

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson

Body

{
  "resourceType": "RelatedPerson",
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter",
      "valueReference": {
        "reference": "Encounter/97939518"
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Encounter"
          }
        ]
      }
    }
  ],
  "patient": {
    "reference": "Patient/12724066"
  },
  "relationship": [
    {
      "coding": [
        {
          "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
          "code": "1152",
          "display": "Emergency Contact"
        }
      ],
      "extension": [
        {
          "valuePeriod": {
            "start": "2016-12-19T16:44:25.000Z",
            "end": "2022-05-01T16:56:56.000Z"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "SIS"
              }
            ]
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
        }
      ]
    }
  ],
  "name": [
    {
      "use": "official",
      "family": "Doe",
      "given": [
        "John",
        "Smith"
      ],
      "period": {
        "start": "2010-05-17T14:54:31.000Z"
      }
    }
  ],
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
            "code": "en",
            "display": "English"
          }
        ]
      },
      "preferred": true
    }
  ],
  "identifier": [
    {
      "type": {
        "coding": [
          {
            "code": "AN",
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
          }
        ]
      },
      "system": "urn:oid:5.5.5.5.5.5",
      "value": "<UNIQUE IDENTIFIER>",
      "period": {
        "start": "2016-01-02T00:00:00-05:00",
        "end": "2020-01-02T00:00:00-05:00"
      }
    }
  ],
  "address": [
    {
      "use": "home",
      "line": [
        "1212 Faircastle Drive",
        "Apartment 406"
      ],
      "city": "KC",
      "district": "Jackson",
      "state": "KS",
      "postalCode": "64199",
      "country": "United States of America",
      "period": {
        "start": "2012-05-17T15:33:18.000Z"
      }
    }
  ],
  "gender": "male",
  "birthDate": "1990-09-15",
  "telecom": [
    {
      "system": "phone",
      "value": "8168229121",
      "use": "home",
      "period": {
        "start": "2012-05-17T15:33:18.000Z"
      }
    },
    {
      "system": "email",
      "value": "testemail@example.com",
      "use": "home",
      "period": {
        "start": "2008-01-10T15:33:18.000Z"
      }
    }
  ]
}

Response

Status: 201 Created
Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Wed, 27 Mar 2019 17:23:14 GMT
Etag: W/"0"
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/E-12747484-97939518
Last-Modified: Thu, 17 Dec 2020 16:37:42 GMT
Vary: Origin
X-Request-Id: 11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on subsequent updates.

Errors

The common errors and OperationOutcomes may be returned.

Patch

Patch an existing Encounter-level or Patient-level RelatedPerson.

PATCH /RelatedPerson/:id

Implementation Notes

Authorization Types

Headers

Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/json-patch+json
If-Match: W/"<Current version of the Related Person resource>"

Patch Operations

Path Operation Value Type
/identifier/- add Identifier
  • Description
    • Add a new identifier for the related person.
  • Example
    • {
        "path": "/identifier/-",
        "op": "add",
        "value": {
          "type": {
            "coding": [
              {
                "code": "MR",
                "system": "http://hl7.org/fhir/v2/0203"
              }
            ]
          },
          "system": "2.16.840.1.113883.6.1000",
          "value": "<unique identifier>",
          "period": {
            "start": "2016-01-02T00:00:00-05:00",
            "end": "2020-01-02T00:00:00-05:00"
          }
        }
      }
      
  • Notes
      • Must not contain the use field.
      • Must contain the type, system, and value fields.
      • When specifying a period, the fields must include a time component with a timezone.
/identifier/{index}/id test string
  • Description
    • Test the value of the Identifier.id of the identifier at the given {index} in the list of related person identifiers.
  • Example
    • {
        "path": "/identifier/1/id",
        "op": "test",
        "value": "CI-490151266-1"
      }
      
/identifier/{index} remove N/A
  • Description
    • Remove the identifier at the given {index} in the list of related person identifiers.
  • Example
    • {
        "path": "/identifier/1",
        "op": "remove"
      }
      
  • Notes
      • Requires a test operation to be provided for the Identifier.id of the identifier intended to be removed.
/relationship/- add CodeableConcept
  • Description
    • The nature of the relationship between a patient and the related person.
  • Example
    • [
        {
          "op": "add",
          "path": "/relationship/-",
          "value":{
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "FAMMEMB"
              }
            ],
            "extension": [
              {
                "valuePeriod": {
                  "start": "2016-12-19T16:44:25.000Z",
                  "end": "2022-05-01T16:56:56.000Z"
                },
                "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
              },
              {
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                      "code": "SIS"
                    }
                  ]
                },
                "url": 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relation'
              }
            ]
          }
        }
      ]
      
  • Notes
      • When specifying a period, the fields must include a time component with a timezone.
      • Duplicate relationships may be added, but will only be represented once on the Resource.
      • The coding field can contain codings from the standard or proprietary system, but not both.
      • Only one coding may be provided.
/relationship/{index}/id test string
  • Description
    • Test the Relationship.id value of the relationship at the given {index} in the list of related person relationships.
  • Example
    • {
        "op": "test",
        "path": "/relationship/0/id",
        "value": "CI-98278577-0"
      }
      
/relationship/{index} remove N/A
  • Description
    • Remove the relationship at the given {index} in the list of related person relationships.
  • Example
    • {
        "op": "remove",
        "path": "/relationship/0"
      }
      
  • Notes
      • Requires a test operation to be provided for the Relationship.id field of the relationship to be removed.
/relationship/{index}/extension replace Extension
  • Description
    • Replace the relationship extension field at the given {index}.
  • Example
    • {
        "op": "replace",
        "path": "/relationship/0/extension",
        "value": [
          {
            "valuePeriod": {
              "start": "2016-12-30T22:26:08.000Z",
              "end": "2036-12-30T22:26:08.000Z"
            },
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
          },
          {
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                  "code": "SIS"
                }
              ]
            },
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
          }
        ]
      }
      
  • Notes
      • Requires a test operation to be provided for the Relationship.id of the relationship whose extension value is intended to be replaced.
      • When specifying a period, the fields must include a time component with a timezone.
      • When either start or end are not provided its value will be unset.
      • The coding field can contain codings from the standard or proprietary system, but not both.
      • Only one coding may be provided.
      • If either the valuePeriod and valueCodeableConcept are not provided, any existing values for the absent period and relation extensions will be removed.
/address/- add Address
  • Description
    • Add a new address for the related person.
  • Example
    • {
        "op": "add",
        "path": "/address/-",
        "value": {
          "use": "home",
          "line": [
            "1212 Faircastle Drive",
            "Apartment 406"
          ],
          "city": "KC",
          "district": "Jackson",
          "state": "KS",
          "postalCode": "64199",
          "country": "United States of America",
          "period": {
            "start": "2012-05-17T15:33:18.000Z"
          }
        }
      }
      
  • Notes
      • Must not contain the text field.
      • Must contain the use field.
      • When specifying a period, the fields must include a time component with a timezone.
      • If line is provided, only the first four values are used. Additional values will be ignored.
/address/{index}/id test string
  • Description
    • Test the Address.id value of the address at the given {index} in the list of related person addresses.
  • Example
    • {
        "op": "test",
        "path": "/address/0/id",
        "value": "CI-24079465-0"
      }
      
/address/{index} remove N/A
  • Description
    • Remove the address at the given {index} in the list of related person addresses.
  • Example
    • {
        "op": "remove",
        "path": "/address/0"
      }
      
  • Notes
      • Requires a test operation to be provided for the Address.id field of the address to be removed.
/telecom/- add ContactPoint
  • Description
    • Add a new contact detail for the related person.
  • Example
    • {
        "op": "add",
        "path": "/telecom/-",
        "value": {
          "use": "home",
          "system": "email",
          "value": "test@test.com",
          "period": {
            "start": "2018-01-05T22:24:32.000Z"
          }
        }
      },
      {
        "op": "add",
        "path": "/telecom/-",
        "value": {
          "use": "home",
          "system": "phone",
          "value": "913-444-8881",
          "period": {
            "start": "2018-01-05T22:24:32.000Z"
          }
        }
      }
      
  • Notes
      • Must contain the system, use, and value fields.
      • When specifying a period, the fields must include a time component with a timezone.
/telecom/{index}/id test string
  • Description
    • Test the value of the ContactPoint.id of the telecom at the given {index} in the list of related person telecoms.
  • Example
    • {
        "op": "test",
        "path": "/telecom/0/id",
        "value": "CI-PH-2807950-0"
      }
      
/telecom/{index} remove N/A
  • Description
    • Remove the telecom at the given {index} in the list of related person telecoms.
  • Example
    • {
        "op": "remove"
        "path": "/telecom/0"
      }
      
  • Notes
      • Requires a test operation to be provided for the ContactPoint.id of the telecom intended to be removed.
/name/{index}/id test string
  • Description
    • Test the value of the HumanName.id of the name at the given {index} in the list of related person names.
  • Example
    • {
        "op": "test",
        "path": "/name/0/id",
        "value": "CI-12467982-0"
      }
      
  • Notes
      • This operation is only supported for the first name in the list of related person names ({index} == 0).
/name/{index}/family replace string
  • Description
    • Replace the HumanName.family of the name at the given {index} in the list of related person names.
  • Example
    • {
        "path": "/name/0/family",
        "op": "replace",
        "value": "Potter"
      }
      
  • Notes
      • Requires a test operation to be provided for the HumanName.id of the name whose family is intended to be replaced.
      • This operation is only supported for the first name in the list of related person names ({index} == 0).
/name/{index}/prefix replace String
  • Description
    • Replace the HumanName.prefix of the name at the given {index} in the list of related person names.
  • Example
    • {
        "op": "replace",
        "path": "/name/0/prefix",
        "value": ["Mr."]
      }
      
  • Notes
      • Requires a test operation to be provided for the HumanName.id of the name whose prefix is intended to be replaced.
      • This operation is only supported for the first name in the list of related person names ({index} == 0).
      • If no prefix value is provided, the prefix on the name will be unset.
      • Only one prefix value may be provided.
/name/{index}/given replace String
  • Description
    • Replace the HumanName.given of the name at the given {index} in the list of related person names.
  • Example
    • {
        "path": "/name/0/given",
        "op": "replace",
        "value": [
          "Harry",
          "James"
        ]
      }
      
  • Notes
      • Requires a test operation to be provided for the HumanName.id of the name whose given is intended to be replaced.
      • This operation is only supported for the first name in the list of related person names ({index} == 0).
      • If there are fewer values provided than the HumanName.given list currently has, the additional existing values will be removed.
      • Up to two given names may be provided. If additional given names are required they must be provided in the second value as a single string separated by blank spaces.
/name/{index}/suffix replace String
  • Description
    • Replace the HumanName.suffix of the name at the given {index} in the list of related person names.
  • Example
    • {
        "op": "replace",
        "path": "/name/0/suffix",
        "value": ["Jr."]
      }
      
  • Notes
      • Requires a test operation to be provided for the HumanName.id of the name whose suffix is intended to be replaced.
      • This operation is only supported for the first name in the list of related person names ({index} == 0).
      • If no suffix value is provided, the suffix on the name will be unset.
      • Only one suffix value may be provided.

Example

Request

PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/E-12467982-97731398

Body

[
  {
    "op": "add",
    "path": "/relationship/-",
    "value": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "FAMMEMB"
        }
      ],
      "extension": [
        {
          "valuePeriod": {
            "start": "2016-12-19T16:44:25.000Z",
            "end": "2022-05-01T16:56:56.000Z"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "SIS"
              }
            ]
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
        }
      ]
    }
  },
  {
    "op": "add",
    "path": "/identifier/-",
    "value": {
      "type": {
        "coding": [
          {
            "code": "MR",
            "system": "http://hl7.org/fhir/v2/0203"
          }
        ]
      },
      "system": "2.16.840.1.113883.6.1000",
      "value": "THIS:IS:A:UNIQUE:IDENTIFIER",
      "period": {
        "start": "2016-01-02T00:00:00-05:00",
        "end": "2020-01-02T00:00:00-05:00"
      }
    }
  },
  {
    "op": "add",
    "path": "/address/-",
    "value": {
      "use": "home",
      "line": [
        "1212 Faircastle Drive",
        "Apartment 406"
      ],
      "city": "KC",
      "district": "Jackson",
      "state": "KS",
      "postalCode": "64199",
      "country": "United States of America",
      "period": {
        "start": "2012-05-17T15:33:18.000Z"
      }
    }
  },
  {
    "op": "add",
    "path": "/telecom/-",
    "value": {
      "use": "home",
      "system": "email",
      "value": "test@test.com",
      "period": {
        "start": "2018-01-05T22:24:32.000Z"
      }
    }
  },
  {
    "op": "add",
    "path": "/telecom/-",
    "value": {
      "use": "home",
      "system": "phone",
      "value": "913-444-8881",
      "period": {
        "start": "2018-01-05T22:24:32.000Z"
      }
    }
  },
  {
    "op": "test",
    "path": "/telecom/0/id",
    "value": "CI-PH-29811920-0"
  },
  {
    "op": "remove",
    "path": "/telecom/0"
  },
  {
    "op": "test",
    "path": "/address/0/id",
    "value": "CI-24079465-0"
  },
  {
    "op": "remove",
    "path": "/address/0"
  },
  {
    "op": "test",
    "path": "/relationship/0/id",
    "value": "CI-98278577-0"
  },
  {
    "op": "replace",
    "path": "/relationship/0/extension",
    "value": [
      {
        "valuePeriod": {
          "start": "2016-12-30T22:26:08.000Z",
          "end": "2036-12-30T22:26:08.000Z"
        },
        "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
      },
      {
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
              "code": "SIS"
            }
          ]
        },
        "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
      }
    ]
  },
  {
    "op": "test",
    "path": "/relationship/1/id",
    "value": "CI-98909708-1"
  },
  {
    "op": "remove",
    "path": "/relationship/1"
  },
  {
    "op": "test",
    "path": "/name/0/id",
    "value": "CI-12467982-0"
  },
  {
    "op": "replace",
    "path": "/name/0/family",
    "value": "Potter"
  },
  {
    "op": "replace",
    "path": "/name/0/prefix",
    "value": [
      "Mr."
    ]
  },
  {
    "op": "replace",
    "path": "/name/0/given",
    "value": [
      "Harry",
      "James"
    ]
  },
  {
    "op": "replace",
    "path": "/name/0/suffix",
    "value": [
      "Jr."
    ]
  }
]

Response

Status: 200 OK
Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Tue, 26 Mar 2019 15:42:29 GMT
Etag: W/"7"
Last-Modified: Tue, 21 Jan 2020 15:57:25 GMT
Vary: Origin
X-Request-Id: 47306a14c8a2c3afd4ab85aa9594101d

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.

The ETag response header indicates the current If-Match version to use on subsequent updates.

Errors

The common errors and OperationOutcomes may be returned.