This
page
is
part
of
the
FHIR
Specification
v6.0.0-ballot3:
Release
6
Ballot
(3rd
Draft)
(see
Ballot
Notes
).
The
current
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
Responsible
Owner:
Patient
Administration
Work
Group
|
|
Security Category : Patient | Compartments : Patient , RelatedPerson |
Information about a person that is involved in a patient's health or the care for a patient, but who is not the primary target of healthcare.
RelatedPersons typically have a personal relationship 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.
When
individual
represented
by
a
RelatedPerson
is
also
a
patient,
that
same
individual
may
be
represented
by
both
a
RelatedPerson
and
Patient
resource,
Patient.link
provides
the
indication
that
they
are
the
same
individual.
The
RelatedPerson
resource
is
used
when
that
person
is
involved
in
the
care
of
some
other
patient,
while
the
Patient
resource
is
used
when
the
person
is
themselves
the
target
of
care.
For
example,
a
mother
could
be
a
Patient
when
receiving
care
for
herself,
but
the
mother
could
also
be
a
RelatedPerson
when
involved
in
the
care
of
her
child.
See
the
Mother
and
newborn
relationships
section
for
more
details
on
that
example.
Boundaries
between
this
and
PersonalRelationship
The
RelatedPerson
resource
contains
the
details
of
both
the
individual
and
their
relationship
to
the
patient.
RelatedPerson
would
be
used
when
the
individual
is
documented
within
the
context
of
a
patient's
chart.
RelatedPerson can be an actor and do things. PersonalRelationship cannot do things. PersonalRelationship is one way you can discover someone who can do things. A PersonalRelationship does not automatically indicate that the target individual may NOT be assumed to take actions on behalf of a source individual.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
||||
|---|---|---|---|---|---|---|---|---|
|
|
DomainResource |
A
person
that
is
related
to
a
patient,
but
who
is
not
a
direct
target
of
care
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|||||
|
Σ | 0..* | Identifier |
A
human
identifier
for
this
person
|
||||
|
?! Σ | 0..1 | boolean |
Whether
this
related
person's
record
is
in
active
use
|
||||
|
Σ | 1..1 | Reference ( Patient ) |
The
patient
this
person
is
related
to
|
||||
|
Σ | 0..* | CodeableConcept |
The
personal
relationship
of
the
related
person
to
the
patient
Binding: PersonalRelationshipRoleType
(
Preferred
)
|
||||
|
Σ | 0..* | CodeableConcept |
The
functional
role
of
the
related
person
to
the
patient
Binding: Patient Relationship Type ( Preferred ) |
||||
|
Σ | 0..* | HumanName |
A
name
associated
with
the
person
|
||||
|
Σ | 0..* | ContactPoint |
A
contact
detail
for
the
person
|
||||
|
Σ | 0..1 | code |
male
|
female
|
other
|
unknown
Binding: AdministrativeGender ( Required ) |
||||
|
Σ | 0..1 | date |
The
date
on
which
the
related
person
was
born
|
||||
|
Σ | 0..* | Address |
Address
where
the
related
person
can
be
contacted
or
visited
|
||||
|
0..* | Attachment |
Image
of
the
person
|
|||||
|
0..1 | Period |
Period
of
time
that
this
relationship
is
considered
valid
|
|||||
|
0..* | BackboneElement |
A
language
which
may
be
used
to
communicate
with
the
related
person
about
the
patient's
health
|
|||||
|
1..1 | CodeableConcept |
The
language
which
can
be
used
to
communicate
with
the
related
person
about
the
patient's
health
Binding: All Languages ( Required )
|
|||||
|
0..1 | boolean |
Language
preference
indicator
|
|||||
Documentation
for
this
format
|
||||||||
See the Extensions for this resource
UML Diagram ( Legend )
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> <active value="[boolean]"/><!-- 0..1 Whether this related person's record is in active use --> <patient><!-- 1..1 Reference(Patient) The patient this person is related to --></patient>
<</relationship><relationship><!-- 0..* CodeableConcept The personal relationship of the related person to the patient--></relationship> <role><!-- 0..* CodeableConcept The functional role of the related person to the patient --></role> <name><!-- 0..* 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> <communication> <!-- 0..* A language which may be used to communicate with the related person about the patient's health --> <language><!-- 1..1 CodeableConcept The language which can be used to communicate with the related person about the patient's health --></language> <preferred value="[boolean]"/><!-- 0..1 Language preference indicator --> </communication> </RelatedPerson>
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
"active" : <boolean>, // Whether this related person's record is in active use
"patient" : { Reference(Patient) }, // R! The patient this person is related to
"
"relationship" : [{ CodeableConcept }], // The personal relationship of the related person to the patient
"role" : [{ CodeableConcept }], // The functional role of the related person to the patient
"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
"communication" : [{ // A language which may be used to communicate with the related person about the patient's health
"language" : { CodeableConcept }, // R! The language which can be used to communicate with the related person about the patient's health
"preferred" : <boolean> // Language preference indicator
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:RelatedPerson; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* A human identifier for this person fhir:active [ boolean ] ; # 0..1 Whether this related person's record is in active use fhir:patient [ Reference(Patient) ] ; # 1..1 The patient this person is related to fhir:relationship ( [ CodeableConcept ] ... ) ; # 0..* The personal relationship of the related person to the patient fhir:role ( [ CodeableConcept ] ... ) ; # 0..* The functional role of the related person to the patient fhir:name ( [ HumanName ] ... ) ; # 0..* A name associated with the person fhir:telecom ( [ ContactPoint ] ... ) ; # 0..* A contact detail for the person fhir:gender [ code ] ; # 0..1 male | female | other | unknown fhir:birthDate [ date ] ; # 0..1 The date on which the related person was born fhir:address ( [ Address ] ... ) ; # 0..* Address where the related person can be contacted or visited fhir:photo ( [ Attachment ] ... ) ; # 0..* Image of the person fhir:period [ Period ] ; # 0..1 Period of time that this relationship is considered valid fhir:communication ( [ # 0..* A language which may be used to communicate with the related person about the patient's health fhir:language [ CodeableConcept ] ; # 1..1 The language which can be used to communicate with the related person about the patient's health fhir:preferred [ boolean ] ; # 0..1 Language preference indicator ] ... ) ; ]
Changes from both R4 and R4B
| RelatedPerson | |
| RelatedPerson.role |
|
| RelatedPerson.communication.language |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
||||
|---|---|---|---|---|---|---|---|---|
|
|
DomainResource |
A
person
that
is
related
to
a
patient,
but
who
is
not
a
direct
target
of
care
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|||||
|
Σ | 0..* | Identifier |
A
human
identifier
for
this
person
|
||||
|
?! Σ | 0..1 | boolean |
Whether
this
related
person's
record
is
in
active
use
|
||||
|
Σ | 1..1 | Reference ( Patient ) |
The
patient
this
person
is
related
to
|
||||
|
Σ | 0..* | CodeableConcept |
The
personal
relationship
of
the
related
person
to
the
patient
Binding: PersonalRelationshipRoleType
(
Preferred
)
|
||||
|
Σ | 0..* | CodeableConcept |
The
functional
role
of
the
related
person
to
the
patient
Binding: Patient Relationship Type ( Preferred ) |
||||
|
Σ | 0..* | HumanName |
A
name
associated
with
the
person
|
||||
|
Σ | 0..* | ContactPoint |
A
contact
detail
for
the
person
|
||||
|
Σ | 0..1 | code |
male
|
female
|
other
|
unknown
Binding: AdministrativeGender ( Required ) |
||||
|
Σ | 0..1 | date |
The
date
on
which
the
related
person
was
born
|
||||
|
Σ | 0..* | Address |
Address
where
the
related
person
can
be
contacted
or
visited
|
||||
|
0..* | Attachment |
Image
of
the
person
|
|||||
|
0..1 | Period |
Period
of
time
that
this
relationship
is
considered
valid
|
|||||
|
0..* | BackboneElement |
A
language
which
may
be
used
to
communicate
with
the
related
person
about
the
patient's
health
|
|||||
|
1..1 | CodeableConcept |
The
language
which
can
be
used
to
communicate
with
the
related
person
about
the
patient's
health
Binding: All Languages ( Required )
|
|||||
|
0..1 | boolean |
Language
preference
indicator
|
|||||
Documentation
for
this
format
|
||||||||
See the Extensions for this resource
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> <active value="[boolean]"/><!-- 0..1 Whether this related person's record is in active use --> <patient><!-- 1..1 Reference(Patient) The patient this person is related to --></patient>
<</relationship><relationship><!-- 0..* CodeableConcept The personal relationship of the related person to the patient--></relationship> <role><!-- 0..* CodeableConcept The functional role of the related person to the patient --></role> <name><!-- 0..* 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> <communication> <!-- 0..* A language which may be used to communicate with the related person about the patient's health --> <language><!-- 1..1 CodeableConcept The language which can be used to communicate with the related person about the patient's health --></language> <preferred value="[boolean]"/><!-- 0..1 Language preference indicator --> </communication> </RelatedPerson>
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
"active" : <boolean>, // Whether this related person's record is in active use
"patient" : { Reference(Patient) }, // R! The patient this person is related to
"
"relationship" : [{ CodeableConcept }], // The personal relationship of the related person to the patient
"role" : [{ CodeableConcept }], // The functional role of the related person to the patient
"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
"communication" : [{ // A language which may be used to communicate with the related person about the patient's health
"language" : { CodeableConcept }, // R! The language which can be used to communicate with the related person about the patient's health
"preferred" : <boolean> // Language preference indicator
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:RelatedPerson; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* A human identifier for this person fhir:active [ boolean ] ; # 0..1 Whether this related person's record is in active use fhir:patient [ Reference(Patient) ] ; # 1..1 The patient this person is related to fhir:relationship ( [ CodeableConcept ] ... ) ; # 0..* The personal relationship of the related person to the patient fhir:role ( [ CodeableConcept ] ... ) ; # 0..* The functional role of the related person to the patient fhir:name ( [ HumanName ] ... ) ; # 0..* A name associated with the person fhir:telecom ( [ ContactPoint ] ... ) ; # 0..* A contact detail for the person fhir:gender [ code ] ; # 0..1 male | female | other | unknown fhir:birthDate [ date ] ; # 0..1 The date on which the related person was born fhir:address ( [ Address ] ... ) ; # 0..* Address where the related person can be contacted or visited fhir:photo ( [ Attachment ] ... ) ; # 0..* Image of the person fhir:period [ Period ] ; # 0..1 Period of time that this relationship is considered valid fhir:communication ( [ # 0..* A language which may be used to communicate with the related person about the patient's health fhir:language [ CodeableConcept ] ; # 1..1 The language which can be used to communicate with the related person about the patient's health fhir:preferred [ boolean ] ; # 0..1 Language preference indicator ] ... ) ; ]
Changes from both R4 and R4B
| RelatedPerson | |
| RelatedPerson.role |
|
| RelatedPerson.communication.language |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| RelatedPerson.relationship |
PersonalRelationshipRoleType
|
Preferred |
Types of personal relationships between two living subjects. *Example:*Parent, sibling, unrelated friend, neighbor |
| RelatedPerson.role | PatientRelationshipType | Preferred |
A set of codes that can be used to indicate the relationship between a Patient and a Related Person. |
| RelatedPerson.gender | AdministrativeGender | Required |
The gender of a person used for administrative purposes. |
| RelatedPerson.communication.language |
AllLanguages
(a
valid
code
from
Tags
for
the
Identification
of
Languages
)
|
Required |
This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47) |
| Common Languages | starter |
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| active | token | Indicates if the related person record is active | RelatedPerson.active | |
| address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | RelatedPerson.address | 4 Resources |
| address-city | string | A city specified in an address | RelatedPerson.address.city | 4 Resources |
| address-country | string | A country specified in an address | RelatedPerson.address.country | 4 Resources |
| address-postalcode | string | A postal code specified in an address | RelatedPerson.address.postalCode | 4 Resources |
| address-state | string | A state specified in an address | RelatedPerson.address.state | 4 Resources |
| address-use | token | A use code specified in an address | RelatedPerson.address.use | 4 Resources |
| birthdate | date | The Related Person's date of birth | RelatedPerson.birthDate | 3 Resources |
| token | A value in an email contact | RelatedPerson.telecom.where(system='email') | 5 Resources | |
| family | string | A portion of the family name of the related person | RelatedPerson.name.family | |
| gender | token | Gender of the related person | RelatedPerson.gender | 4 Resources |
| given | string | A portion of the given name of the related person | RelatedPerson.name.given | |
| identifier | token | An Identifier of the RelatedPerson | RelatedPerson.identifier |
|
| name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | RelatedPerson.name | |
| patient | reference | The patient this related person is related to |
RelatedPerson.patient
( Patient ) |
|
| phone | token | A value in a phone contact | RelatedPerson.telecom.where(system='phone') | 5 Resources |
| phonetic | string | A portion of name using some kind of phonetic matching algorithm | RelatedPerson.name | 4 Resources |
| relationship | token | The personal relationship between the patient and the relatedperson | RelatedPerson.relationship | |
| role | token | The functional relationship between the patient and the relatedperson | RelatedPerson.relationship | |
| telecom | token | The value in any kind of contact | RelatedPerson.telecom | 5 Resources |