FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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 GroupMaturity Level: 2 Trial UseCompartments: 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 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 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, MedicationAdministration, MedicationDispense, MedicationRequest, MedicationStatement, Observation, Patient, Person, Procedure, ProcedureRequest, Provenance, QuestionnaireResponse, ReferralRequest, RequestGroup, Schedule, SupplyRequest and Task

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson DomainResourceAn 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..1CodeableConceptThe nature of the relationship
PatientRelationshipType (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

doco Documentation for this format

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson DomainResourceAn 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..1CodeableConceptThe nature of the relationship
PatientRelationshipType (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

doco Documentation for this format

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..1 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
  • 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 (for ) + JSON Schema, ShEx (for Turtle)

PathDefinitionTypeReference
RelatedPerson.relationship The nature of the relationship between a patient and the related personPreferredPatientRelationshipType
RelatedPerson.gender The gender of a person used for administrative purposes.RequiredAdministrativeGender

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, 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
telecomtokenThe value in any kind of contactRelatedPerson.telecom4 Resources