RelatedPerson REST Endpoints

Sort by

Task Path Method

Description

RelatedPerson

This topic describes information for the RelatedPerson resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

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.

Profile Support

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

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
RelatedPerson.active	boolean
RelatedPerson.patient	Reference(Patient)
RelatedPerson.relationship	CodeableConcept
RelatedPerson.name	HumanName
RelatedPerson.telecom	ContactPoint
RelatedPerson.address	Address

Terminology Bindings

Element	Description	Details
RelatedPerson.relationship	The nature of the relationship between a patient and the related person.	System

RelatedPerson

The operations from the RelatedPerson category.

Get a list of related persons

Method: get

Path: /RelatedPerson

Get a related person by ID

Method: get

Path: /RelatedPerson/{id}