R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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

Work Group

Maturity Level: 2

Trial Use

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.

8.2.1 Scope and Usage

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

This resource is referenced by Account, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, AuditEvent, Basic, BiologicallyDerivedProduct, CarePlan, CareTeam, ChargeItem, Claim, Communication, CommunicationRequest, Composition, Condition, Consent, Contract, Coverage, DeviceRequest, DeviceUseStatement, DocumentManifest, DocumentReference, Encounter, ExplanationOfBenefit, Goal, ImagingStudy, Invoice, MeasureReport, Media, MedicationAdministration, MedicationDispense, MedicationRequest, MedicationStatement, Observation, OccupationalData, Patient, Person, Procedure, Provenance, QuestionnaireResponse, RequestGroup, Schedule, ServiceRequest, SupplyRequest, Task and UserSession

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 PatientRelationshipType (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
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>
</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
}

Turtle Template

@prefix fhir: <http://hl7.org/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: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
]

Changes since DSTU2

RelatedPerson

RelatedPerson.active

Added Element

RelatedPerson.relationship

Max Cardinality changed from 1 to *
Remove Binding http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype (required)

RelatedPerson.name

Max Cardinality changed from 1 to *

See the Full Difference for further information

This analysis is available as XML or JSON.

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

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 PatientRelationshipType (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
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>
</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
}

Turtle Template

@prefix fhir: <http://hl7.org/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: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
]

Changes since DSTU2

RelatedPerson

RelatedPerson.active

Added Element

RelatedPerson.relationship

Max Cardinality changed from 1 to *
Remove Binding http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype (required)

RelatedPerson.name

Max Cardinality changed from 1 to *

See the Full Difference for further information

This analysis is available as XML or JSON.

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

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

8.2.3.1 Terminology Bindings

Path	Definition	Type	Reference
RelatedPerson.relationship	The nature of the relationship between a patient and the related person	Preferred	PatientRelationshipType
RelatedPerson.gender	The gender of a person used for administrative purposes.	Required	AdministrativeGender

Path

Definition

Type

Reference

RelatedPerson.relationship

The nature of the relationship between a patient and the related person

Preferred

PatientRelationshipType

RelatedPerson.gender

The gender of a person used for administrative purposes.

Required

AdministrativeGender

8.2.4 Search Parameters

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
telecom	token	The value in any kind of contact	RelatedPerson.telecom	4 Resources