Id1.3.182.11.1.21Effective Date2014‑10‑09 10:06:16
Statusdraft DraftVersion Label1.0
NameCDARelatedEntityDisplay NameCDA RelatedEntity
Description
Template CDA RelatedEntity (prototype, directly derived from POCD_RM000040 MIF)

The relatedEntity class is used to provide information about persons who are in a defined relationship with the patient. The type of relationship can be specified by providing the appropriate code.

An informant can be a person in one of two roles. The RelatedEntity role is used to represent an informant without a role.id (e.g. a parent or guy on the street). The informant in this case bears some formal or personal relationship to the patient. The role is unscoped, with the assumption that the patient is always the implied scoper. RelatedEntity.code can be used to specify the nature of the relationship. The AssignedEntity role is used for an identified informant, and is scoped by an Organization. 

ClassificationCDA Header Level Template
Open/ClosedClosed (only defined elements are allowed)
Used by / Uses
Used by 0 transactions and 1 template, Uses 3 templates
Used by as NameVersion
1.3.182.11.1.18Containmentdraft CDA Informant (1.0)2014‑10‑09 10:04:24
Uses as NameVersion
1.3.182.11.1.1Includedraft ADDR (1.3)DYNAMIC
1.3.182.11.1.15Containmentdraft CDA Person (1.0)DYNAMIC
1.3.182.11.22Includedraft CDA telecom (1.0)DYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.12.316 CDA RelatedEntity (2005‑09‑07)
ref
ad1bbr-
ItemDTCardConfDescriptionLabel
@classCode
cs1 … 1RDefines the type of relationship.
 CONF
The value of @classCode shall be drawn from value set 1.3.182.10.25.1 eSante_RoleClassMutualRelationship (DYNAMIC)
hl7:code
CE0 … 1

This code may be given to further specify the relationship. If given, possible values shall be from value set eSanté_PersonalRelationShipRoleType. If known a code may be provided, otherwise the element may be omitted.


CDARdotstity
 CONF
The value of @code shall be drawn from value set 1.3.182.10.22.1 eSante_PersonalRelationShipRoleType (DYNAMIC)
Included0 … * from 1.3.182.11.1.1 ADDR (DYNAMIC)
hl7:addr
AD0 … *ADDR
@use
cs0 … 1 Information about the usage or context of the address information. E.g. home, work, …
Not mandatory if addr is nullFlavored.

 CONF
The value of @use shall be drawn from value set 1.3.182.10.2.1 eSante_AddressUse (DYNAMIC)
hl7:streetAddressLine
ADXP0 … 1ADDR
hl7:streetName
ADXP0 … 1ADDR
hl7:houseNumber
ADXP0 … 1ADDR
hl7:postalCode
ADXP0 … 1RADDR
hl7:city
ADXP0 … 1RADDR
hl7:state
ADXP0 … 1ADDR
hl7:country
ADXP0 … 1RADDR
 ConstraintThe country code shall come from the value set eSanté_CountryCodes
 Variable letNamecountry 
 Valuetext() 
 Schematron assertrolered error 
 testcount(distinct-values(doc('include/voc-1.3.182.10.33.1-DYNAMIC.xml')/*/valueSet/conceptList/concept[@code = $country]))=1 
 MessageThe country code shall come from the value set eSanté_CountryCodes 
hl7:additionalLocator
ADXP0 … 1ADDR
 Schematron assertrolered error 
 test@nullFlavor or (((hl7:streetAddressLine and not(hl7:streetName) and not(hl7:houseNumber)) or (hl7:streetName and hl7:houseNumber and not(hl7:streetAddressLine))) and @use) 
 MessageAddress can either have @nullFlavor or need to have @use attribute and streetAddressLine or houseNumber and streetName.  
 Schematron assertrolered error 
 test@nullFlavor or (hl7:postalCode and hl7:city and hl7:country) 
 MessageIf addr is not nullFlavored, PostalCode, City and Country shall be provided. 
Included0 … * from 1.3.182.11.22 CDA telecom (DYNAMIC)
hl7:telecom
0 … *CDAtdotsecom
@use
set_cs0 … 1 
 CONF
The value of @use shall be drawn from value set 1.3.182.10.28.1 eSante_TelecomAddressUse (DYNAMIC)
@value
st1 … 1R
 Variable letNamemyAttValue 
 Valuesubstring-before(@value,':') 
 Variable letNamemyAttCheck 
 Valuedistinct-values(doc('include/voc-1.3.182.10.29.1-DYNAMIC.xml')/*/valueSet/conceptList/concept[@code = $myAttValue]) 
 Schematron assertrolered error 
 testcount($myAttValue)=count($myAttCheck) 
 MessageValue must start with communication - scheme from value set eSanté_URLScheme 
hl7:effectiveTime
0 … 1Indicating when the related person (who is the information provider about the patient) was related to the patient.
CDARdotstity
hl7:low
IVXB_TS1 … 1RCDARdotstity
@nullFlavor
cs0 … 1FUNK
@value
ts0 … 1 
hl7:high
IVL_TS1 … 1RCDARdotstity
@nullFlavor
cs0 … 1FUNK
@value
ts0 … 1 
hl7:relatedPerson
1 … 1MContains 1.3.182.11.1.15 CDA Person (DYNAMIC)CDARdotstity