R6 Ballot (2nd Draft)

Publish-box (todo)

8.2 Resource RelatedPerson - Content

Patient Administration icon Work GroupMaturity Level: 5 Trial UseSecurity 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.

8.2.1 Scope and Usage

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:

  • A patient's wife or husband
  • A patient's relatives or friends
  • A neighbor bringing a patient to the hospital
  • The owner or trainer of a horse
  • A patient's attorney or guardian
  • A Guide Dog

8.2.2 Boundaries and Relationships

The primary distinction between a Practitioner and a RelatedPerson is based on whether:

  • The person/animal operates on behalf of the care delivery organization over multiple patients (Practitioner) or,
  • Where the person/animal is not associated with the organization, and instead is allocated tasks specifically for the RelatedPerson's Patient (RelatedPerson).

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.

8.2.3 References to this Resource

8.2.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... role Σ 0..* CodeableConcept The functional role of the related person to the patient
Binding: Patient Relationship Type (Preferred)

... 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
Binding: 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 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
Binding: All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set

.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

RelatedPerson (DomainResource)Identifier for a person within a particular scopeidentifier : Identifier [0..*]Whether this related person record is in active use (this element modifies the meaning of other elements)active : boolean [0..1]The patient this person is related topatient : Reference [1..1] « Patient »The nature of the personal relationship between the related person and the patientrelationship : CodeableConcept [0..*] « null (Strength=Preferred)PersonalRelationshipRoleType? »The nature of the functional relationship between the patient and the related personrole : CodeableConcept [0..*] « null (Strength=Preferred)PatientRelationshipType? »A name associated with the personname : HumanName [0..*]A contact detail for the person, e.g. a telephone number or an email addresstelecom : ContactPoint [0..*]Administrative Gender - the gender that the person is considered to have for administration and record keeping purposesgender : code [0..1] « null (Strength=Required)AdministrativeGender! »The date on which the related person was bornbirthDate : date [0..1]Address where the related person can be contacted or visitedaddress : Address [0..*]Image of the personphoto : Attachment [0..*]The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknownperiod : Period [0..1]CommunicationThe language which may be used to communicate with the individuallanguage : CodeableConcept [1..1] « null (Strength=Required)AllLanguages! »Indicates whether or not the related person prefers this language (over other languages he or she masters up a certain level)preferred : boolean [0..1]A language which may be used to communicate with the related person about the patient's healthcommunication[0..*]

XML Template

<RelatedPerson xmlns="http://hl7.org/fhir"> doco
 <!-- 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 personal relationship of the related person to the patient icon --></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>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:RelatedPerson;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .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
  • Added Element
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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... role Σ 0..* CodeableConcept The functional role of the related person to the patient
Binding: Patient Relationship Type (Preferred)

... 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
Binding: 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 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
Binding: All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set

.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

RelatedPerson (DomainResource)Identifier for a person within a particular scopeidentifier : Identifier [0..*]Whether this related person record is in active use (this element modifies the meaning of other elements)active : boolean [0..1]The patient this person is related topatient : Reference [1..1] « Patient »The nature of the personal relationship between the related person and the patientrelationship : CodeableConcept [0..*] « null (Strength=Preferred)PersonalRelationshipRoleType? »The nature of the functional relationship between the patient and the related personrole : CodeableConcept [0..*] « null (Strength=Preferred)PatientRelationshipType? »A name associated with the personname : HumanName [0..*]A contact detail for the person, e.g. a telephone number or an email addresstelecom : ContactPoint [0..*]Administrative Gender - the gender that the person is considered to have for administration and record keeping purposesgender : code [0..1] « null (Strength=Required)AdministrativeGender! »The date on which the related person was bornbirthDate : date [0..1]Address where the related person can be contacted or visitedaddress : Address [0..*]Image of the personphoto : Attachment [0..*]The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknownperiod : Period [0..1]CommunicationThe language which may be used to communicate with the individuallanguage : CodeableConcept [1..1] « null (Strength=Required)AllLanguages! »Indicates whether or not the related person prefers this language (over other languages he or she masters up a certain level)preferred : boolean [0..1]A language which may be used to communicate with the related person about the patient's healthcommunication[0..*]

XML Template

<RelatedPerson xmlns="http://hl7.org/fhir"> doco
 <!-- 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 personal relationship of the related person to the patient icon --></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>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:RelatedPerson;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .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
  • Added Element
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

8.2.4.1 Terminology Bindings

Path ValueSet Type Documentation
RelatedPerson.relationship PersonalRelationshipRoleType icon 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 icon) Required

This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
  Common Languages starter

8.2.5 Search Parameters

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
email 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 65 Resources
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)		 65 Resources
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