FHIR Release 3 (STU) Current Build
This page is part of FHIR STU 3 (v3.0.1) in it's permanent home (it will always be available at this URL). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .

8.2 Resource RelatedPerson - Content

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:

  • A patient's wife or husband
  • A patient's relatives or friends
  • A neighbour 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 , ImagingManifest Group , ImagingStudy , Immunization , Invoice , MeasureReport , Media , MedicationAdministration , MedicationDispense , MedicationRequest , MedicationStatement MedicationUsage , Observation , Patient , Person , Procedure , ProcedureRequest , Provenance , QuestionnaireResponse , ReferralRequest , RequestGroup , Schedule , ServiceRequest , SupplyRequest and Task .

This resource implements the ParticipantLiving pattern.

Structure

Name Flags Card. Type Description & Constraints doco
. . RelatedPerson TU DomainResource An 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..1 0..* CodeableConcept The nature of the relationship
PatientRelationshipType 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
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

doco Documentation for this format

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 relationship : CodeableConcept [0..1] [0..*] « The nature of the relationship between a patient and the related person person. (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. (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 that during which this relationship is considered to be valid. 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" for England English language : 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 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 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>

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

  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:

  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 DSTU2 R3

RelatedPerson RelatedPerson.active Added Element RelatedPerson.relationship Remove Binding http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype (required)
RelatedPerson.name RelatedPerson.gender
  • Max Cardinality changed Change value set from 1 http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0 to * http://hl7.org/fhir/ValueSet/administrative-gender|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

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

Structure

Name Flags Card. Type Description & Constraints doco
. . RelatedPerson TU DomainResource An 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..1 0..* CodeableConcept The nature of the relationship
PatientRelationshipType 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
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

doco Documentation for this format

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 relationship : CodeableConcept [0..1] [0..*] « The nature of the relationship between a patient and the related person person. (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. (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 that during which this relationship is considered to be valid. 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" for England English language : 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 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 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>

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

  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:

  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 DSTU2 Release 3

RelatedPerson RelatedPerson.active Added Element RelatedPerson.relationship Remove Binding http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype (required)
RelatedPerson.name RelatedPerson.gender
  • Max Cardinality changed Change value set from 1 http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0 to * http://hl7.org/fhir/ValueSet/administrative-gender|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

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

 

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

Path Definition Type Reference
RelatedPerson.relationship The nature of the relationship between a patient and the related person person. Preferred PatientRelationshipType
RelatedPerson.gender The gender of a person used for administrative purposes. Required AdministrativeGender
RelatedPerson.communication.language A human 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 3 Resources
address-city string A city specified in an address RelatedPerson.address.city 3 Resources
address-country string A country specified in an address RelatedPerson.address.country 3 Resources
address-postalcode string A postal code specified in an address RelatedPerson.address.postalCode 3 Resources
address-state string A state specified in an address RelatedPerson.address.state 3 Resources
address-use token A use code specified in an address RelatedPerson.address.use 3 Resources
birthdate date The Related Person's date of birth RelatedPerson.birthDate 2 Resources
email token A value in an email contact RelatedPerson.telecom.where(system='email') 4 Resources
gender token Gender of the related person RelatedPerson.gender 3 Resources
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') 4 Resources
phonetic string A portion of name using some kind of phonetic matching algorithm RelatedPerson.name 3 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 Resources