~~DSTU2~~ STU 3 Ballot

~~This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is~~

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0 ~~. For a full list of available versions, see the Directory of published versions~~ . For a full list of available versions, see the Directory of published versions ~~. Page versions:~~ . Page versions: R5 R4B R4 R3 R2

5.2 8.2 Resource RelatedPerson - Content Resource RelatedPerson - Content

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

~~Patient Administration~~ Patient Administration

~~Work Group~~ Work Group

~~Maturity Level : 1~~ Maturity Level : 1

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.

5.2.1 Scope and Usage 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 neighbor bringing a patient to the hospital The owner or trainer of a horse A patient's attorney or guardian A Guide Dog

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

5.2.2 8.2.2 Boundaries and Relationships 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

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~~ can be used to indicate the species of a service animal.

This resource is referenced by AllergyIntolerance , , Appointment , , AppointmentResponse , , AuditEvent , , Basic , , CarePlan , , CareTeam , Claim , Communication , , CommunicationRequest , , Composition , , Consent , Contract , , Coverage , DeviceUseRequest , DiagnosticRequest , DocumentManifest , , DocumentReference , , Encounter , , ExplanationOfBenefit , Goal ~~, ImagingObjectSelection ,~~ , GuidanceResponse , ImagingManifest , MedicationAdministration , , MedicationStatement , , Observation , , Patient , Person , , Procedure , , ProcedureRequest , , Provenance , , QuestionnaireResponse ~~and~~ , Schedule and Task

5.2.3 Resource Content 8.2.3 Resource Content

Structure
UML
XML
JSON
Turtle
R2 Diff
All

Structure

Name	Flags	Card.	Type	~~Description & Constraints~~ Description & Constraints
RelatedPerson			DomainResource	~~An person that is related to a patient, but who is not a direct target of care~~ An person that is related to a patient, but who is not a direct target of care
identifier	Σ	0..*	Identifier	~~A human identifier for this person~~ A human identifier for this person
~~patient~~ 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~~ The patient this person is related to
relationship	Σ	0..1	CodeableConcept	~~The nature of the relationship~~ The nature of the relationship PatientRelationshipType ~~( Required~~ ( Extensible )
name	Σ	~~0..1~~ 0..*	HumanName	~~A name associated with the person~~ A name associated with the person
telecom	Σ	0..*	ContactPoint	~~A contact detail for the person~~ A contact detail for the person
gender	Σ	0..1	code	~~male \| female \| other \| unknown~~ male \| female \| other \| unknown AdministrativeGender ( ( Required )
birthDate	Σ	0..1	date	~~The date on which the related person was born~~ The date on which the related person was born
address	Σ	0..*	Address	~~Address where the related person can be contacted or visited~~ Address where the related person can be contacted or visited
photo		0..*	Attachment	~~Image of the person~~ Image of the person
period		0..1	Period	~~Period of time that this relationship is considered valid~~ Period of time that this relationship is considered valid
~~Documentation for this format~~ Documentation for this format

~~UML Diagram~~ UML Diagram ( Legend )

~~XML Template~~ XML Template <

<RelatedPerson xmlns="http://hl7.org/fhir"> 

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <</patient>
 <</relationship>
 <</name>
 <</telecom>
 <
 <
 <</address>
 <</photo>
 <</period>

 <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..1 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~~ JSON Template ~~{ "resourceType" : "",~~

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

RelatedPerson.relationship

Change binding strength from required to extensible

RelatedPerson.name

Max Cardinality changed from 1 to *

See the Full Difference for further information

Structure

Name	Flags	Card.	Type	~~Description & Constraints~~ Description & Constraints
RelatedPerson			DomainResource	~~An person that is related to a patient, but who is not a direct target of care~~ An person that is related to a patient, but who is not a direct target of care
identifier	Σ	0..*	Identifier	~~A human identifier for this person~~ A human identifier for this person
~~patient~~ 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~~ The patient this person is related to
relationship	Σ	0..1	CodeableConcept	~~The nature of the relationship~~ The nature of the relationship PatientRelationshipType ~~( Required~~ ( Extensible )
name	Σ	~~0..1~~ 0..*	HumanName	~~A name associated with the person~~ A name associated with the person
telecom	Σ	0..*	ContactPoint	~~A contact detail for the person~~ A contact detail for the person
gender	Σ	0..1	code	~~male \| female \| other \| unknown~~ male \| female \| other \| unknown AdministrativeGender ( ( Required )
birthDate	Σ	0..1	date	~~The date on which the related person was born~~ The date on which the related person was born
address	Σ	0..*	Address	~~Address where the related person can be contacted or visited~~ Address where the related person can be contacted or visited
photo		0..*	Attachment	~~Image of the person~~ Image of the person
period		0..1	Period	~~Period of time that this relationship is considered valid~~ Period of time that this relationship is considered valid
~~Documentation for this format~~ Documentation for this format

~~UML Diagram~~ UML Diagram ( Legend )

~~XML Template~~ XML Template <

<RelatedPerson xmlns="http://hl7.org/fhir"> 

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <</patient>
 <</relationship>
 <</name>
 <</telecom>
 <
 <
 <</address>
 <</photo>
 <</period>

 <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..1 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~~ JSON Template ~~{ "resourceType" : "",~~

{
  "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

}
 
Alternate
definitions:

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

RelatedPerson.relationship

Change binding strength from required to extensible

RelatedPerson.name

Max Cardinality changed from 1 to *

See the Full Difference for further information

Alternate definitions: Master Definition ( XML , JSON ), XML Schema / Schematron ~~, Resource Profile ( XML ,~~ (for ) + JSON Schema , ShEx (for Turtle ~~), Questionnaire~~ )

5.2.3.1 Terminology Bindings 8.2.3.1 Terminology Bindings

~~RelatedPerson.relationship~~ ~~RelatedPerson.gender~~

Path	Definition	Type	Reference
RelatedPerson.relationship	~~The nature of the relationship between a patient and the related person~~ The nature of the relationship between a patient and the related person	~~Required~~ Extensible	PatientRelationshipType
RelatedPerson.gender	~~The gender of a person used for administrative purposes.~~ 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~~ The nature of the relationship between a patient and the related person

~~Required~~ Extensible

PatientRelationshipType

RelatedPerson.gender

~~The gender of a person used for administrative purposes.~~ The gender of a person used for administrative purposes.

Required

AdministrativeGender

5.2.4 Search Parameters 8.2.4 Search Parameters Search parameters for this resource. The common parameters also apply. See

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

~~© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100. Links: Search | Version History | Table of Contents | Compare to DSTU1~~

Name	Type	Description	Paths
active	token	Wheter the related person record is active	RelatedPerson.active
address	string	~~An address in any kind of address/part~~ A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text	RelatedPerson.address
address-city	string	~~A city specified in an address~~ A city specified in an address	RelatedPerson.address.city
address-country	string	~~A country specified in an address~~ A country specified in an address	RelatedPerson.address.country
address-postalcode	string	~~A postal code specified in an address~~ A postal code specified in an address	RelatedPerson.address.postalCode
address-state	string	~~A state specified in an address~~ A state specified in an address	RelatedPerson.address.state
address-use	token	~~A use code specified in an address~~ A use code specified in an address	RelatedPerson.address.use
birthdate	date	~~The Related Person's date of birth~~ The Related Person's date of birth	RelatedPerson.birthDate
email	token	~~A value in an email contact~~ A value in an email contact	RelatedPerson.telecom(system=email)
gender	token	~~Gender of the person~~ Gender of the person	RelatedPerson.gender
identifier	token	~~A patient Identifier~~ A patient Identifier	RelatedPerson.identifier
name	string	~~A portion of name in any name part~~ 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 person is related to~~ The patient this person is related to	RelatedPerson.patient ( Patient )
phone	token	~~A value in a phone contact~~ A value in a phone contact	RelatedPerson.telecom(system=phone)
phonetic	string	~~A portion of name using some kind of phonetic matching algorithm~~ A portion of name using some kind of phonetic matching algorithm	RelatedPerson.name
telecom	token	~~The value in any kind of contact~~ The value in any kind of contact	RelatedPerson.telecom

© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:07+1000. QA Page
Links: Search | | Version History | Table of Contents | Compare to DSTU2 | ~~| Propose a change~~ try { var currentTabIndex = sessionStorage.getItem('fhir-resource-tab-index'); } catch(exception){ } if (!currentTabIndex) currentTabIndex = '0'; $( '#tabs' ).tabs({ active: currentTabIndex, activate: function( event, ui ) { var active = $('.selector').tabs('option', 'active'); currentTabIndex = ui.newTab.index(); document.activeElement.blur(); try { sessionStorage.setItem('fhir-resource-tab-index', currentTabIndex); } catch(exception){ } } }); | Propose a change