Release
4
4B
Administration
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v4.3.0:
R4B
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R4B
R4
R3
R2
|
Patient
Administration
Work
Group
|
Maturity Level : 2 | Trial Use | Security Category : Patient | Compartments : Patient , RelatedPerson |
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 Annotation , Signature , Account , AdverseEvent , AllergyIntolerance , Appointment , AppointmentResponse , AuditEvent , Basic , CarePlan , CareTeam , ChargeItem , Claim , Communication , CommunicationRequest , Composition , Condition , Consent , Contract , Coverage , DeviceRequest , DeviceUseStatement , DocumentManifest , DocumentReference , Encounter , ExplanationOfBenefit , Goal , Group , ImagingStudy , Invoice , MeasureReport , Media , MedicationAdministration , MedicationDispense , MedicationRequest , MedicationStatement , Observation , Patient , Person , Procedure , Provenance , QuestionnaireResponse , RequestGroup , Schedule , ServiceRequest , SupplyRequest and Task .
This resource does not implement any patterns.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
RelatedPerson
|
TU | 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 |
|
identifier
|
Σ | 0..* | Identifier |
A
human
identifier
for
this
person
|
active
|
?! Σ | 0..1 | boolean | Whether this related person's record is in active use |
patient
|
Σ | 1..1 | Reference ( Patient ) | The patient this person is related to |
|
relationship
|
Σ | 0..* | CodeableConcept |
The
nature
of
the
relationship
|
|
name
|
Σ | 0..* | HumanName |
A
name
associated
with
the
person
|
|
telecom
|
Σ | 0..* | ContactPoint |
A
contact
detail
for
the
person
|
|
gender
|
Σ | 0..1 | code |
male
|
female
|
other
|
unknown
AdministrativeGender ( Required ) |
|
birthDate
|
Σ | 0..1 | date | The date on which the related person was born |
|
address
|
Σ | 0..* | Address |
Address
where
the
related
person
can
be
contacted
or
visited
|
|
photo
|
0..* | Attachment |
Image
of
the
person
|
|
|
period
|
0..1 | Period | Period of time that this relationship is considered valid | |
communication
|
0..* | BackboneElement |
A
language
which
may
be
used
to
communicate
with
about
the
patient's
health
|
|
language
|
1..1 | CodeableConcept |
The
language
which
can
be
used
to
communicate
with
the
patient
about
his
or
her
health
Common Languages ( Preferred but limited to AllLanguages ) |
|
preferred
|
0..1 | boolean | Language preference indicator | |
|
Documentation
for
this
format
|
||||
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><!-- 0..* CodeableConcept The nature of the relationship --></relationship> <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 about the patient's health --> <language><!-- 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her 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 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
"communication" : [{ // A language which may be used to communicate with about the patient's health
"language" : { CodeableConcept }, // R! The language which can be used to communicate with the patient about his or her health
"preferred" : <boolean> // Language preference indicator
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes
since
R3
R4
| RelatedPerson |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions between R3 and R4
See R3 <--> R4 Conversion Maps (status = 4 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
RelatedPerson
|
TU | 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 |
|
|
identifier
|
Σ | 0..* | Identifier |
A
human
identifier
for
this
person
|
|
active
|
?! Σ | 0..1 | boolean | Whether this related person's record is in active use |
|
patient
|
Σ | 1..1 | Reference ( Patient ) | The patient this person is related to |
|
relationship
|
Σ | 0..* | CodeableConcept |
The
nature
of
the
relationship
|
|
name
|
Σ | 0..* | HumanName |
A
name
associated
with
the
person
|
|
telecom
|
Σ | 0..* | ContactPoint |
A
contact
detail
for
the
person
|
|
gender
|
Σ | 0..1 | code |
male
|
female
|
other
|
unknown
AdministrativeGender ( Required ) |
|
birthDate
|
Σ | 0..1 | date | The date on which the related person was born |
|
address
|
Σ | 0..* | Address |
Address
where
the
related
person
can
be
contacted
or
visited
|
|
photo
|
0..* | Attachment |
Image
of
the
person
|
|
|
period
|
0..1 | Period | Period of time that this relationship is considered valid | |
|
communication
|
0..* | BackboneElement |
A
language
which
may
be
used
to
communicate
with
about
the
patient's
health
|
|
|
language
|
1..1 | CodeableConcept |
The
language
which
can
be
used
to
communicate
with
the
patient
about
his
or
her
health
Common Languages ( Preferred but limited to AllLanguages ) |
|
|
preferred
|
0..1 | boolean | Language preference indicator | |
|
Documentation
for
this
format
|
||||
XML Template
<RelatedPerson xmlns="http://hl7.org/fhir">
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 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
"communication" : [{ // A language which may be used to communicate with about the patient's health
"language" : { CodeableConcept }, // R! The language which can be used to communicate with the patient about his or her health
"preferred" : <boolean> // Language preference indicator
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes
since
Release
3
4
| RelatedPerson |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions between R3 and R4
See R3 <--> R4 Conversion Maps (status = 4 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| RelatedPerson.relationship |
|
Preferred | PatientRelationshipType |
| RelatedPerson.gender |
|
Required | AdministrativeGender |
| RelatedPerson.communication.language |
|
Preferred , but limited to AllLanguages | CommonLanguages |
Search parameters for 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 |
|
| address-city | string | A city specified in an address | RelatedPerson.address.city |
|
| address-country | string | A country specified in an address | RelatedPerson.address.country |
|
| address-postalcode | string | A postal code specified in an address | RelatedPerson.address.postalCode |
|
| address-state | string | A state specified in an address | RelatedPerson.address.state |
|
| address-use | token | A use code specified in an address | RelatedPerson.address.use |
|
| birthdate | date | The Related Person's date of birth | RelatedPerson.birthDate |
|
| token | A value in an email contact | RelatedPerson.telecom.where(system='email') |
|
|
| gender | token | Gender of the related person | RelatedPerson.gender |
|
| 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') |
|
| phonetic | string | A portion of name using some kind of phonetic matching algorithm | RelatedPerson.name |
|
| relationship | token | The relationship between the patient and the relatedperson | RelatedPerson.relationship | |
| telecom | token | The value in any kind of contact | RelatedPerson.telecom |
|
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
generated
on
Fri,
Nov
1,
2019
09:36+1100.
QA
Page
Sat,
May
28,
2022
12:57+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
QA
Page
|
Compare
to
R3
R4
|
|
Propose
a
change