Current Build

8.2 Resource RelatedPerson - Content

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

  • 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, 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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson TUDomainResourceA 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..*IdentifierA human identifier for this person
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient Σ1..1Reference(Patient)The patient this person is related to
... relationship Σ0..*CodeableConceptThe nature of the relationship
Patient relationship type (Preferred)
... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Common Languages (Preferred but limited to AllLanguages)
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

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 relationship between a patient and the related personrelationship : CodeableConcept [0..*] « The nature of the relationship between a patient and the related person. (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] « The gender of a person used for administrative purposes. (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 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" for England Englishlanguage : CodeableConcept [1..1] « A human language. (Strength=Preferred)CommonLanguages? »Indicates whether or not the patient prefers this language (over other languages he masters up a certain level)preferred : boolean [0..1]A language which may be used to communicate with 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 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>

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:RelatedPerson.identifier [ Identifier ], ... ; # 0..* A human identifier for this person
  fhir:RelatedPerson.active [ boolean ]; # 0..1 Whether this related person's record is in active use
  fhir:RelatedPerson.patient [ Reference(Patient) ]; # 1..1 The patient this person is related to
  fhir:RelatedPerson.relationship [ CodeableConcept ], ... ; # 0..* The nature of the relationship
  fhir:RelatedPerson.name [ HumanName ], ... ; # 0..* A name associated with the person
  fhir:RelatedPerson.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the person
  fhir:RelatedPerson.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:RelatedPerson.birthDate [ date ]; # 0..1 The date on which the related person was born
  fhir:RelatedPerson.address [ Address ], ... ; # 0..* Address where the related person can be contacted or visited
  fhir:RelatedPerson.photo [ Attachment ], ... ; # 0..* Image of the person
  fhir:RelatedPerson.period [ Period ]; # 0..1 Period of time that this relationship is considered valid
  fhir:RelatedPerson.communication [ # 0..* A language which may be used to communicate with about the patient's health
    fhir:RelatedPerson.communication.language [ CodeableConcept ]; # 1..1 The language which can be used to communicate with the patient about his or her health
    fhir:RelatedPerson.communication.preferred [ boolean ]; # 0..1 Language preference indicator
  ], ...;
]

Changes since R3

RelatedPerson
RelatedPerson.active
  • Default Value "true" removed
RelatedPerson.relationship
  • Max Cardinality changed from 1 to *
RelatedPerson.gender
  • Change value set from http://hl7.org/fhir/ValueSet/administrative-gender to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0
RelatedPerson.communication
  • Added Element
RelatedPerson.communication.language
  • Added Mandatory Element
RelatedPerson.communication.preferred
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson TUDomainResourceA 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..*IdentifierA human identifier for this person
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient Σ1..1Reference(Patient)The patient this person is related to
... relationship Σ0..*CodeableConceptThe nature of the relationship
Patient relationship type (Preferred)
... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Common Languages (Preferred but limited to AllLanguages)
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

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 relationship between a patient and the related personrelationship : CodeableConcept [0..*] « The nature of the relationship between a patient and the related person. (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] « The gender of a person used for administrative purposes. (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 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" for England Englishlanguage : CodeableConcept [1..1] « A human language. (Strength=Preferred)CommonLanguages? »Indicates whether or not the patient prefers this language (over other languages he masters up a certain level)preferred : boolean [0..1]A language which may be used to communicate with 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 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>

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:RelatedPerson.identifier [ Identifier ], ... ; # 0..* A human identifier for this person
  fhir:RelatedPerson.active [ boolean ]; # 0..1 Whether this related person's record is in active use
  fhir:RelatedPerson.patient [ Reference(Patient) ]; # 1..1 The patient this person is related to
  fhir:RelatedPerson.relationship [ CodeableConcept ], ... ; # 0..* The nature of the relationship
  fhir:RelatedPerson.name [ HumanName ], ... ; # 0..* A name associated with the person
  fhir:RelatedPerson.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the person
  fhir:RelatedPerson.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:RelatedPerson.birthDate [ date ]; # 0..1 The date on which the related person was born
  fhir:RelatedPerson.address [ Address ], ... ; # 0..* Address where the related person can be contacted or visited
  fhir:RelatedPerson.photo [ Attachment ], ... ; # 0..* Image of the person
  fhir:RelatedPerson.period [ Period ]; # 0..1 Period of time that this relationship is considered valid
  fhir:RelatedPerson.communication [ # 0..* A language which may be used to communicate with about the patient's health
    fhir:RelatedPerson.communication.language [ CodeableConcept ]; # 1..1 The language which can be used to communicate with the patient about his or her health
    fhir:RelatedPerson.communication.preferred [ boolean ]; # 0..1 Language preference indicator
  ], ...;
]

Changes since Release 3

RelatedPerson
RelatedPerson.active
  • Default Value "true" removed
RelatedPerson.relationship
  • Max Cardinality changed from 1 to *
RelatedPerson.gender
  • Change value set from http://hl7.org/fhir/ValueSet/administrative-gender to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0
RelatedPerson.communication
  • Added Element
RelatedPerson.communication.language
  • Added Mandatory Element
RelatedPerson.communication.preferred
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

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

PathDefinitionTypeReference
RelatedPerson.relationship The nature of the relationship between a patient and the related person.PreferredPatientRelationshipType
RelatedPerson.gender The gender of a person used for administrative purposes.RequiredAdministrativeGender
RelatedPerson.communication.language A human language.Preferred, but limited to AllLanguagesCommonLanguages

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
activetokenIndicates if the related person record is activeRelatedPerson.active
addressstringA server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or textRelatedPerson.address3 Resources
address-citystringA city specified in an addressRelatedPerson.address.city3 Resources
address-countrystringA country specified in an addressRelatedPerson.address.country3 Resources
address-postalcodestringA postal code specified in an addressRelatedPerson.address.postalCode3 Resources
address-statestringA state specified in an addressRelatedPerson.address.state3 Resources
address-usetokenA use code specified in an addressRelatedPerson.address.use3 Resources
birthdatedateThe Related Person's date of birthRelatedPerson.birthDate2 Resources
emailtokenA value in an email contactRelatedPerson.telecom.where(system='email')4 Resources
gendertokenGender of the related personRelatedPerson.gender3 Resources
identifiertokenAn Identifier of the RelatedPersonRelatedPerson.identifier
namestringA server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or textRelatedPerson.name
patientreferenceThe patient this related person is related toRelatedPerson.patient
(Patient)
phonetokenA value in a phone contactRelatedPerson.telecom.where(system='phone')4 Resources
phoneticstringA portion of name using some kind of phonetic matching algorithmRelatedPerson.name3 Resources
relationshiptokenThe relationship between the patient and the relatedpersonRelatedPerson.relationship
telecomtokenThe value in any kind of contactRelatedPerson.telecom4 Resources