Skip to main content

​
Overview

RelatedPersons typically have a personal or non-healthcare-specific professional relationship to the patient. A RelatedPerson resource is primarily used for attribution of information, since RelatedPersons are often a source of information about the patient. For keeping information about people for contact purposes for a patient, use a Patient’s Contact element. Each Related Person has next elements:
  • a status
  • a patient
Each Related Person supports next elements:
  • the relationship to the patient
  • the name of the related person
  • the telecom of the related person
  • the address of the related person
Profile specific implementation guidance:
  • Supports caretakers as part of CareTeam USCDI requirements
This resource conforms to US Core Related Person Profile. RelatedPerson response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.

​
Must support elements, mandatory and optional search parameters

RelatedPerson must support these elements:
  • active
  • patient
  • relationship
  • name
  • telecom
  • address
The syntax used to describe the interactions is described here. The following search parameters and search parameter combinations SHALL be supported: SHALL support fetching a RelatedPerson using the _id search parameter:
GET [base url]/RelatedPerson[id] The following search parameter combinations SHOULD be supported (optional): SHOULD support searching using the patient search parameter:
GET [base url]/RelatedPerson?patient={Type/}[id] SHOULD support searching using the combination of the patient and name search parameters:
GET [base url]/RelatedPerson?patient={Type/}[id]&name=[string] The response to any search operation is always a list of resources in a Bundle or an Operation Outcome. Get RelatedPerson by ID. METHOD GET
or
PARAMS
[base url] - FHIR base url
{id} - Id for RelatedPerson resource HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details. RESPONSES EXAMPLE:
Get RelatedPerson by a specific patient METHOD GET
PARAMS
[base url] - FHIR base url
{Type/} - optional reference type. Example: Patient/
[id] - patient id HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details. RESPONSES EXAMPLE:
Get RelatedPerson by a specific patient and name METHOD GET
PARAMS
[base url] - FHIR base url
{Type/} - optional reference type. Example: Patient/
[id] - patient id
[string] - name search string HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details. RESPONSES EXAMPLE: