Template

Show index

Template CCD Person 2007‑04‑01

Id2.16.840.1.113883.3.1937.777.4.10.1Effective Date2007‑04‑01
Statuspending Under pre-publication reviewVersion Label
NameCCDPersonDisplay NameCCD Person
Description

7.4.1 Entity Identifiers

CDA Release 2.0 does not provide a mechanism to determine when two participants in different roles are in fact the same entity (i.e., an entity can be a person, organization or device). A CDA Document identifies each participant through the application of a role identifier. This identifier can be used to trace the participation of an entity in a given role, but cannot necessarily be used to determine that two entities are the same. While more role identities could be provided whose intended use is to unify the entities, this is better modeled through the use of an entity identifier. Therefore, to facilitate this capability, this guide defines an extension to CDA Release 2.0 that allows the person or organization playing the role to be uniquely identified, by the inclusion of an identifier on the entity.

An entity identifier opaquely represents the entity referenced in a clinical document. It has no required relationship between the entity and the role that they play in that document. Use of an entity identifier therefore gives CDA producing and consuming applications a mechanism to unite the various entities represented in the CDA document, and thereby expose relationships that would otherwise be obscured when entities cannot be recognized as being identical. When two participants have the same entity identifier, they can be assumed to be the same entity.

In the CDA Release 2.0 schema, organizations and the patient already carry an identifier on the entity, and devices can have only one form of participation (as assignedAuthoringDevice). Therefore, only those elements describing participant persons that are not the patient need to support an element to identify the person. To state it simply, each person that is represented by the CDA document that does not already have an id element may now generate one if necessary using this extension. The identifier MAY be provided in an id element from the urn:hl7-org:sdtc namespace. This element SHALL be an instance identifier (II) and SHALL appear just before name element of any person described by any role in the CDA Release 2.0 schema.

A document that identifies one person in this fashion SHOULD identify all persons in this way, otherwise there will be unidentified persons described by the document, and the utility of this extension will be negated.

Because the patient already supports an identifier element according to the CDA schema, an additional id element is not necessary and SHOULD NOT be provided in the patient element. However, to represent the patient in any other role, the identifier used in the corresponding id element SHOULD be the same as the identifier used to represent the patient.

CONF-537: An assignedPerson, informationRecipient, maintainingPerson, guardianPerson, relatedPerson, associatedPerson or subjectMAY include an id element from the urn:hl7-org:sdtc namespace to uniquely identify the person.
CONF-538: The id element SHALL use the instance identifier (II) data type.
CONF-539: The id element SHALL appear just before the name element of the entity.

ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 1 transaction and 58 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.777.4.4.1Transactionfinal Continuity of Care Document (CCD) (Release 1.1)2013‑01‑31
2.16.840.1.113883.3.1937.777.4.10.4Containmentpending CCDSupportingParticipant2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.5Containmentpending CCD Author (Body)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.11Containmentpending CCD AuthoringDevice2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.15linkpending CCD Performer (Body)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.16Containmentpending CCD AssignedEntity2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.17linkpending CCD Informant2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.18Containmentpending CCD RelatedEntity2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.20linkpending CCD Informant (Body)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.27linkpending CCD legalAuthenticator2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.28linkpending CCD authenticator2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.29linkpending CCD dataEnterer2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.31Containmentpending CCD informationRecipient2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.32Containmentpending CCD participant2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.34linkpending CCD componentOf2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.44linkpending Plan of care activity (act)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.45linkpending Plan of care activity (encounter)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.46linkpending Plan of care activity (observation)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.47linkpending Plan of care activity (procedure)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.48linkpending Plan of care activity (substance administration)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.49linkpending Plan of care activity (supply)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.50linkpending Procedure activity (act)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.51linkpending Procedure activity (observation)2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.52linkpending Procedure activity (procedure)2007‑04‑01
2.16.840.1.113883.10.20.1Containmentpending CCD v1.0 Templates Root2007‑04‑01
2.16.840.1.113883.10.20.1.1linkpending Advance directives section2007‑04‑01
2.16.840.1.113883.10.20.1.2linkpending Alerts section2007‑04‑01
2.16.840.1.113883.10.20.1.3linkpending Encounters section2007‑04‑01
2.16.840.1.113883.10.20.1.4linkpending Family history section2007‑04‑01
2.16.840.1.113883.10.20.1.5linkpending Functional status section2007‑04‑01
2.16.840.1.113883.10.20.1.6linkpending Immunization section2007‑04‑01
2.16.840.1.113883.10.20.1.7linkpending Medical equipment section2007‑04‑01
2.16.840.1.113883.10.20.1.8linkpending Medication section2007‑04‑01
2.16.840.1.113883.10.20.1.9linkpending Payers section2007‑04‑01
2.16.840.1.113883.10.20.1.10linkpending Plan of care section2007‑04‑01
2.16.840.1.113883.10.20.1.11linkpending Problem section2007‑04‑01
2.16.840.1.113883.10.20.1.12linkpending Procedures section2007‑04‑01
2.16.840.1.113883.10.20.1.14linkpending Results section2007‑04‑01
2.16.840.1.113883.10.20.1.15linkpending Social history section2007‑04‑01
2.16.840.1.113883.10.20.1.16linkpending Vital signs section2007‑04‑01
2.16.840.1.113883.10.20.1.17linkpending Advance directive observation2007‑04‑01
2.16.840.1.113883.10.20.1.18linkpending Alert observation2007‑04‑01
2.16.840.1.113883.10.20.1.20linkpending Coverage activity2007‑04‑01
2.16.840.1.113883.10.20.1.21linkpending Encounter activity2007‑04‑01
2.16.840.1.113883.10.20.1.22linkpending Family history observation2007‑04‑01
2.16.840.1.113883.10.20.1.23linkpending Family history organizer2007‑04‑01
2.16.840.1.113883.10.20.1.24linkpending Medication activity2007‑04‑01
2.16.840.1.113883.10.20.1.26Containmentpending Policy activity2007‑04‑01
2.16.840.1.113883.10.20.1.27linkpending Problem act2007‑04‑01
2.16.840.1.113883.10.20.1.28linkpending Problem observation2007‑04‑01
2.16.840.1.113883.10.20.1.31linkpending Result observation2007‑04‑01
2.16.840.1.113883.10.20.1.32linkpending Result organizer2007‑04‑01
2.16.840.1.113883.10.20.1.33linkpending Social history observation2007‑04‑01
2.16.840.1.113883.10.20.1.34linkpending Supply activity2007‑04‑01
2.16.840.1.113883.10.20.1.35linkpending Vital signs organizer2007‑04‑01
2.16.840.1.113883.10.20.1.41linkpending Episode observation2007‑04‑01
2.16.840.1.113883.10.20.1.42linkpending Cause of death observation2007‑04‑01
2.16.840.1.113883.10.20.1.46linkpending Medication series number observation2007‑04‑01
2.16.840.1.113883.10.20.1.54linkpending Reaction observation2007‑04‑01
RelationshipAdaptation: template 2.16.840.1.113883.10.12.152 (2005‑09‑07)
ItemDTCardConfDescriptionLabel
@classCode
cs0 … 1 
 CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.1.11.20049 EntityClassPerson (DYNAMIC)
@determinerCode
cs0 … 1FINSTANCE
sdtc:id
II0 … CONF‑537 / CONF‑538 / CONF‑539
hl7:name
PN0 … *CCDPerson
sdtc:asPatientRelationship

7.4.3 Patient Relationship

CDA Release 2.0 does not provide a mechanism to relate participants other than an informant to the patient. Often useful information, such as the relationship between the patient and the policy subscriber, or the patient and the author, cannot be easily determined by traversal of the CDA document. To facilitate this capability, this guide defines an extension to CDA Release 2.0 which allows the relationship to the patient to be expressed for any participant.

Each participant other than an informant may have zero or more relationship roles with the patient. Each of these roles can be expressed by an asPatientRelationship element which further describes the type of role in a code element. The informant participant already supports specification of the relationship between the informant and the patient via the RelatedEntity class, and therefore should not include this extension.

Figure 16. Example use of the sdtc:asPatientRelationship extension

 <ClinicalDocument xmlns='urn:hl7-org:v3' xmlns:sdtc='urn:hl7-org:sdtc'> ... <author> <time value='20050329224411+0500'/> <assignedAuthor> ... <assignedPerson> <sdtc:id extension='12345' root='2.16.840.1.113883.3.933'/> <name> <prefix>Mrs.</prefix> <given>Abigail</given> <family>Ruth</family> </name> <sdtc:asPatientRelationship classCode='PRS'> <code code='65656005' codeSystem='2.16.840.1.113883.6.96'  displayName='Biological mother'/> </sdtc:asPatientRelationship> </assignedPerson> </assignedAuthor> </author> ... </ClinicalDocument> 

CONF-546: sdtc:asPatientRelationshipSHALL contain exactly one sdtc:asPatientRelationship / @classCode, valued with “PRS”. CONF-547: sdtc:asPatientRelationshipSHALL contain exactly one sdtc:asPatientRelationship / code, of datatype CE. CONF-548: The value for “sdtc:asPatientRelationship / code” SHOULD be selected from ValueSet 2.16.840.1.113883.1.11.19579 FamilyHistoryRelatedSubjectCode DYNAMIC or 2.16.840.1.113883.1.11.20.21 FamilyHistoryPersonCode DYNAMIC. CONF-549: An informant SHALL NOT contain any relatedPerson / sdtc:asPatientRelationship elements.

CONF‑546
@classCode
cs1 … 1FPRSCONF‑547
 Schematron assertrolered error 
 testnot(ancestor::hl7:informant) 
 MessageCONF-549: An informant SHALL NOT contain any relatedPerson / sdtc:asPatientRelationship elements. 
sdtc:code
CE1 … 1MCONF‑548
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19579 FamilyMember (DYNAMIC)
or
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.20.21 FamilyHistoryPersonCode (DYNAMIC)