Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version 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 R3 R2

8.2 Resource RelatedPerson - Content

Patient Administration icon Work Group Maturity Level : 2 5   Trial Use 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 target of healthcare, nor has a formal responsibility in the care process.

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

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.

This resource is referenced by Annotation , Signature ,

Structure

Name Flags Card. Type Description & Constraints doco
. . 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
. . . 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 patient related person about his or her the patient's health
Common Binding: All Languages ( Preferred but limited to AllLanguages Required )
Additional Bindings Purpose
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 scope identifier : 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 to patient : Reference [1..1] « Patient » The nature of the relationship between a patient and the related person and the patient relationship : CodeableConcept [0..*] « The nature of the relationship between a patient and the related person. null (Strength=Preferred) PatientRelationshipType ? » A name associated with the person name : HumanName [0..*] A contact detail for the person, e.g. a telephone number or an email address telecom : ContactPoint [0..*] Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes gender : code [0..1] « The gender of a person used for administrative purposes. null (Strength=Required) AdministrativeGender ! » The date on which the related person was born birthDate : date [0..1] Address where the related person can be contacted or visited address : Address [0..*] Image of the person photo : Attachment [0..*] The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown period : Period [0..1] Communication The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" "en-AU" for England Australian English language : CodeableConcept [1..1] « A human language. (Strength=Preferred) null (Strength=Required) CommonLanguages ? AllLanguages ! » Indicates whether or not the patient 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 health communication [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>

 <relationship><!-- 0..* CodeableConcept The relationship of the related person to the patient --></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>
 <
  <</language>
  <

 <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:;

[ 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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
  ], ...;

  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 relationship 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 since R3 from both R4 and R4B

RelatedPerson
RelatedPerson.active Default Value "true" removed RelatedPerson.relationship RelatedPerson.communication.language
  • Max Cardinality changed Change binding strength from 1 preferred to * required
  • RelatedPerson.gender
  • Change value set from http://hl7.org/fhir/ValueSet/administrative-gender Common Languages to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 RelatedPerson.communication Added Element RelatedPerson.communication.language Added Mandatory Element All Languages
  • RelatedPerson.communication.preferred
  • Added Element Change max value set from All Languages to none

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 4 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.) See Conversions Summary .)

Structure

Name Flags Card. Type Description & Constraints doco
. . 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
. . . 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 patient related person about his or her the patient's health
Common Binding: All Languages ( Preferred but limited to AllLanguages Required )
Additional Bindings Purpose
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 scope identifier : 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 to patient : Reference [1..1] « Patient » The nature of the relationship between a patient and the related person and the patient relationship : CodeableConcept [0..*] « The nature of the relationship between a patient and the related person. null (Strength=Preferred) PatientRelationshipType ? » A name associated with the person name : HumanName [0..*] A contact detail for the person, e.g. a telephone number or an email address telecom : ContactPoint [0..*] Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes gender : code [0..1] « The gender of a person used for administrative purposes. null (Strength=Required) AdministrativeGender ! » The date on which the related person was born birthDate : date [0..1] Address where the related person can be contacted or visited address : Address [0..*] Image of the person photo : Attachment [0..*] The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown period : Period [0..1] Communication The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" "en-AU" for England Australian English language : CodeableConcept [1..1] « A human language. (Strength=Preferred) null (Strength=Required) CommonLanguages ? AllLanguages ! » Indicates whether or not the patient 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 health communication [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>

 <relationship><!-- 0..* CodeableConcept The relationship of the related person to the patient --></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>
 <
  <</language>
  <

 <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:;

[ 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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
  ], ...;

  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 relationship 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 since Release 3 from both R4 and R4B

RelatedPerson
RelatedPerson.active Default Value "true" removed RelatedPerson.relationship RelatedPerson.communication.language
  • Max Cardinality changed Change binding strength from 1 preferred to * required
  • RelatedPerson.gender
  • Change value set from http://hl7.org/fhir/ValueSet/administrative-gender Common Languages to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 RelatedPerson.communication Added Element RelatedPerson.communication.language Added Mandatory Element All Languages
  • RelatedPerson.communication.preferred
  • Added Element Change max value set from All Languages to none

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 4 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.) See Conversions Summary .)

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

RelatedPerson.communication.language
Path Definition ValueSet Type Reference Documentation
RelatedPerson.relationship The nature of the relationship between a patient and the related person. PatientRelationshipType Preferred PatientRelationshipType

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 AdministrativeGender

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

  A human language. Common Languages Preferred , but limited to AllLanguages starter CommonLanguages

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 3 4 Resources
address-city string A city specified in an address RelatedPerson.address.city 3 4 Resources
address-country string A country specified in an address RelatedPerson.address.country 3 4 Resources
address-postalcode string A postal code specified in an address RelatedPerson.address.postalCode 3 4 Resources
address-state string A state specified in an address RelatedPerson.address.state 3 4 Resources
address-use token A use code specified in an address RelatedPerson.address.use 3 4 Resources
birthdate date The Related Person's date of birth RelatedPerson.birthDate 2 3 Resources
email token A value in an email contact RelatedPerson.telecom.where(system='email') 4 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 3 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 )
66 Resources
phone token A value in a phone contact RelatedPerson.telecom.where(system='phone') 4 5 Resources
phonetic string A portion of name using some kind of phonetic matching algorithm RelatedPerson.name 3 4 Resources
relationship token The relationship between the patient and the relatedperson RelatedPerson.relationship
telecom token The value in any kind of contact RelatedPerson.telecom 4 5 Resources