This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
Compartments
|
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
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. Some individuals may serve as both a Patient's Contact and a Related Person.
Example RelatedPersons are:
The primary distinction between a Practitioner and a RelatedPerson is based on whether:
A standard extension
animalSpecies
can
be
used
to
indicate
the
species
of
a
service
animal.
This
resource
is
referenced
by
can be used to indicate the species of a service animal.
This resource is referenced by
AllergyIntolerance
,
,
Appointment
,
,
AppointmentResponse
,
,
AuditEvent
,
,
Basic
,
,
CarePlan
,
,
CareTeam
,
Claim
,
Communication
,
,
CommunicationRequest
,
,
Composition
,
,
Contract
,
,
DocumentManifest
,
,
DocumentReference
,
,
Encounter
,
,
ExplanationOfBenefit
,
Goal
,
,
GuidanceResponse
,
ImagingExcerpt
,
ImagingObjectSelection
,
,
MedicationAdministration
,
,
MedicationStatement
,
,
Observation
,
,
Person
,
,
Procedure
,
,
ProcedureRequest
,
,
Protocol
,
Provenance
,
,
QuestionnaireResponse
and
,
Schedule
and
Task
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
DomainResource |
|
||
|
Σ | 0..* | Identifier |
|
|
Σ | 1..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | CodeableConcept |
PatientRelationshipType |
|
Σ | 0..1 | HumanName |
|
|
Σ | 0..* | ContactPoint |
|
|
Σ | 0..1 | code |
AdministrativeGender |
|
Σ | 0..1 | date |
|
|
Σ | 0..* | Address |
|
|
0..* | Attachment |
|
|
|
0..1 | Period |
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<RelatedPerson xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier A human identifier for this person --></identifier> <patient><!-- 1..1 Reference(Patient) The patient this person is related to --></patient> <relationship><!-- 0..1 CodeableConcept The nature of the relationship --></relationship> <name><!-- 0..1 HumanName A name associated with the person --></name> <telecom><!-- 0..* ContactPoint A contact detail for the person --></telecom> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <birthDate value="[date]"/><!-- 0..1 The date on which the related person was born --> <address><!-- 0..* Address Address where the related person can be contacted or visited --></address> <photo><!-- 0..* Attachment Image of the person --></photo> <period><!-- 0..1 Period Period of time that this relationship is considered valid --></period> </RelatedPerson>
JSON
Template
JSON Template
{
"resourceType" : "RelatedPerson",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // A human identifier for this person
"patient" : { Reference(Patient) }, // R! The patient this person is related to
"relationship" : { CodeableConcept }, // The nature of the relationship
"name" : { HumanName }, // A name associated with the person
"telecom" : [{ ContactPoint }], // A contact detail for the person
"gender" : "<code>", // male | female | other | unknown
"birthDate" : "<date>", // The date on which the related person was born
"address" : [{ Address }], // Address where the related person can be contacted or visited
"photo" : [{ Attachment }], // Image of the person
"period" : { Period } // Period of time that this relationship is considered valid
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
DomainResource |
|
||
|
Σ | 0..* | Identifier |
|
|
Σ | 1..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | CodeableConcept |
PatientRelationshipType |
|
Σ | 0..1 | HumanName |
|
|
Σ | 0..* | ContactPoint |
|
|
Σ | 0..1 | code |
AdministrativeGender |
|
Σ | 0..1 | date |
|
|
Σ | 0..* | Address |
|
|
0..* | Attachment |
|
|
|
0..1 | Period |
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<RelatedPerson xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier A human identifier for this person --></identifier> <patient><!-- 1..1 Reference(Patient) The patient this person is related to --></patient> <relationship><!-- 0..1 CodeableConcept The nature of the relationship --></relationship> <name><!-- 0..1 HumanName A name associated with the person --></name> <telecom><!-- 0..* ContactPoint A contact detail for the person --></telecom> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <birthDate value="[date]"/><!-- 0..1 The date on which the related person was born --> <address><!-- 0..* Address Address where the related person can be contacted or visited --></address> <photo><!-- 0..* Attachment Image of the person --></photo> <period><!-- 0..1 Period Period of time that this relationship is considered valid --></period> </RelatedPerson>
JSON
Template
JSON Template
{
"resourceType" : "RelatedPerson",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // A human identifier for this person
"patient" : { Reference(Patient) }, // R! The patient this person is related to
"relationship" : { CodeableConcept }, // The nature of the relationship
"name" : { HumanName }, // A name associated with the person
"telecom" : [{ ContactPoint }], // A contact detail for the person
"gender" : "<code>", // male | female | other | unknown
"birthDate" : "<date>", // The date on which the related person was born
"address" : [{ Address }], // Address where the related person can be contacted or visited
"photo" : [{ Attachment }], // Image of the person
"period" : { Period } // Period of time that this relationship is considered valid
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
|
PatientRelationshipType |
|
|
|
Required | AdministrativeGender |
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| address | string |
|
RelatedPerson.address |
| address-city | string |
|
RelatedPerson.address.city |
| address-country | string |
|
RelatedPerson.address.country |
| address-postalcode | string |
|
RelatedPerson.address.postalCode |
| address-state | string |
|
RelatedPerson.address.state |
| address-use | token |
|
RelatedPerson.address.use |
| birthdate | date |
|
RelatedPerson.birthDate |
| token |
|
RelatedPerson.telecom(system=email) | |
| gender | token |
|
RelatedPerson.gender |
| identifier | token |
|
RelatedPerson.identifier |
| name | string |
|
RelatedPerson.name |
| patient | reference |
|
RelatedPerson.patient
( Patient ) |
| phone | token |
|
RelatedPerson.telecom(system=phone) |
| phonetic | string |
|
RelatedPerson.name |
| telecom | token |
|
RelatedPerson.telecom |