Back To Index  <<  Back To Templates

ref Template  CCD Person

Id 2.16.840.1.113883.3.1937.777.4.10.1
ref
ccd1-
Effective Date 2007‑04‑01
Status pending Under pre-publication review Version Label
Name CCDPerson Display Name CCD 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 subject MAY 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.

Classification CDA Header Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 6 templates, Uses 0 templates
Used by as Name Version
2.16.840.1.113883.3.1937.777.4.10.16 Containment pending CCD AssignedEntity 2007‑04‑01
2.16.840.1.113883.3.1937.777.4.10.15 link pending CCD Performer (Body) 2007‑04‑01
2.16.840.1.113883.10.20.1.46 link pending Medication series number observation 2007‑04‑01
1.3.6.1.4.1.19376.1.5.3.1.4.12 link active IHE Immunizations Entry (2014) 2013‑12‑20
1.3.6.1.4.1.19376.1.5.3.1.3.23 link active IHE Immunizations Section (2014) 2013‑12‑20
1.3.6.1.4.1.19376.1.9.1.1.6 link pending IHE Medication Treatment Plan Document Content Module (2017) 2018‑01‑17 17:33:23
Relationship Adaptation: template 2.16.840.1.113883.10.12.152 (2005‑09‑07)
Item DT Card Conf Description Label
@classCode
0 … 1  
  CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.1.11.20049 EntityClassPerson (DYNAMIC)
@determinerCode
0 … 1 F INSTANCE
sdtc:id
II 0 …  CONF‑537 / CONF‑538 / CONF‑539
hl7:name
PN 0 … * (CCDdotsson)
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:asPatientRelationship SHALL contain exactly one sdtc:asPatientRelationship / @classCode, valued with “PRS”. CONF-547: sdtc:asPatientRelationship SHALL 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
1 … 1 F PRS CONF‑547
  Schematron assert role red error  
  test not(ancestor::hl7:informant)  
  Message CONF-549: An informant SHALL NOT contain any relatedPerson / sdtc:asPatientRelationship elements.  
sdtc:code
CE 1 … 1 M CONF‑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)