RelatedPerson REST Endpoints

Sort by

Task Path Method

Description

RelatedPerson

The following topic describes information for the RelatedPerson resource.

Overview

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

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

This resource supports the US Core RelatedPerson Profile from HL7 FHIR US Core Implementation Guide STU 6.1.0.

The following fields are returned if valued:

• RelatedPerson ID

• RelatedPerson Identifier

• Active

• Patient

• Relationship

• Related person's name

• Telecom information (may include phone and email)

• Gender (administrative)

• Date of birth

• Address

• Communication (preferred language)

• Extensions including related person encounter, relationship level, period, and relation (for more information, see the Extensions section of this topic)

Terminology Bindings

• RelatedPerson.identifier.type

  Description: The type that determines which identifier to use for a specific purpose.

  • Details: Identifier Type Codes

    System: http://terminology.hl7.org/CodeSystem/v2-0203

  • Details: For more information, see Code Set 4 Person Identifier (Alias) Types under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR_source_id>/codeSet/4

• 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: For more information, see Code Set 36 Languages under the List of Code Sets section in Proprietary Codes and Systems.

    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: For more information, see Code Set 351 Person Relationship Types under the List of Code Sets section in Proprietary Codes and Systems.

    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: For more information, see Code Set 40 Person Relationships under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR_source_id>/codeSet/40

• RelatedPerson.extension[x].valueCodeableConcept (for more information, see the Extensions section of this topic).

  Description: The resource's relationship to the patient or encounter level. This binding is used in relationship-level extensions.

  Details: Relationship Level

  System: http://hl7.org/fhir/resource-types

Extensions

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

Table - Extensions

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

RelatedPerson

Create a related person record

Method: post

Path: /RelatedPerson

Get a list of related person records

Method: get

Path: /RelatedPerson

Get a related person record by ID

Method: get

Path: /RelatedPerson/{ID}

Patch a related person record

Method: patch

Path: /RelatedPerson/{ID}