Difference between revisions of "DraftCDA2.1.b"

From HL7 Publishing Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 23: Line 23:
 
==Header==
 
==Header==
  
−
The purpose of the CDA header is to enable clinical document exchange across and within institutions; facilitate clinical document management; and facilitate compilation of an individual patient's clinical documents into a lifetime electronic patient record. The CDA header sets the context for the document as a whole and the context for understanding the content contained in the document.
+
==Body==
−
 
 
−
===ClinicalDocument===
 
  
−
The CDA schema was produced by serialization of the CDA model. The starting point for his serialization was the ClinicalDocument class. The ClinicalDocument is the root element in a CDA document instance.
+
===<big>Body Choice</big>===
  
−
[[Image:Header.png|400px|border|center|Authenicator]]
+
[[Image:BodyChoice.png|800px|border|center|Body Choice]]
  
−
====ClinicalDocument Attributes====
+
The CDA body choice can be either a document body in a format other than XML, or the CDA structured body. Every CDA document has exactly one body, associated with the ClinicalDocument class through the component relationship.
  
−
This section describes attributes defined in the ClinicalDocument class.
+
<div id="div-component"></div>
 +
=====<big>component</big>=====
  
−
The table below identifies the attributes of ClinicalDocument. For each item, the name is provided, along with the data type, wire cardinality*, code bindings, and binding type or strength. The links allow will access to the item's definition, data type definition, and when appropriate, the concept domain or value set used with the item.
+
The component class relates the ClinicalDocument header to the body choice; NonXMLBody or StructuredBody.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: ClinicalDocument Attributes  
+
|+Table {{AUTOTABLENUM}}: documentationOf Attributes  
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att   classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActRelationshipType.htm#ActRelationshipDocuments DOC]||Fixed
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att    moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#InfrastructureRoot-typeId-att  typeId]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..1]|| ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#InfrastructureRoot-templateId-att templateId]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[0..*]|| ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..1]||||
 
−
|- 
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[1..1]||[http://cda/infrastructure/vocabulary/vs_LN.htm#DocumentType D:DocumentType]||Open
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-title-att title]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ST ST]||[0..1]||||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[0..1]||||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/vs_Confidentiality.htm#x_BasicConfidentialityKind V:x_BasicConfidentialityKind]||Open
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-setId-att setId]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[0..1]||||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-versionNumber-att versionNumber]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ST.SIMPLE ST.SIMPLE]||[0..1]||||
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-copyTime-att copyTime] ('''Deprecated''')||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[0..1]||||
+
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-contextConductionInd-att contextConductionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 
|}
 
|}
−
'''Note*:''' The wire cardinality represents is the effective cardinality of an element, taking into account [[#Recipient Responsibilities|1.3.1 Recipient Responsibilities]], relaxation of the requirement to exchange fixed and defaulted values. The logical cardinality expressed in the CDA Hierarchical Description is still present, but assumed by the recipient, not imposed on the wire format of an instance of a CDA document. 
 
−
 
−
 
−
'''ClinicalDocument.classCode'''
 
  
−
The ClinicalDocument.classCode in the CDA model is fixed to "DOCCLIN". As a result, in the CDA R2.1 Schema, the ClinicalDocument/@classCode has been fixed to "DOCCLIN".  
+
'''component.typeCode'''
  
−
As noted in section [[#Recipient Responsibilities|1.3.1 Recipient Responsibilities]], fixed and default values asserted in this standard are not required to be present in CDA document instances. However, CDA Implementation Guides can still require them via conformance statements.
+
The component.typeCode is fixed to "COMP", which indicates that the body is a component part of the StructuredDocument.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed ClinicalDocument.classCode
+
|+Table {{AUTOTABLENUM}}: Fixed component.typeCode
 
!Code!!Display Name
 
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||clinical document
+
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMP COMP]||has component
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
+
!style="text-align:left;"  colspan="2" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 
|}
 
|}
  
−
'''ClinicalDocument.moodCode'''
+
'''component.contextConductionInd'''
 +
 
 +
The component.contextConductionInd indicator is fixed to "true". Ancestor elements () which propagate, will conduct through this component class to the associated child element.
 +
 
 +
====<big>NonXMLBody</big>====
 +
 
 +
The NonXMLBody class represents a document body that is in some format other than XML.  The NonXMLBody can be used to represent scanned document(s) or legacy document(s) needing to be transferred using the CDA standard. 
  
−
The ClinicalDocument.moodCode in the CDA model is fixed to "EVN" or event mood to indicate that this is documentation of a past service. In the CDA R2.1 Schema, the ClinicalDocument/@moodCode has been fixed to "EVN".
 
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed ClinicalDocument.moodCode
+
|+Table {{AUTOTABLENUM}}: NonXMLBody Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
!Code!!Display Name
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att    classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att    moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[1..1]||||
 +
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/vs_Confidentiality.htm#x_BasicConfidentialityKind V:x_BasicConfidentialityKind]||Open
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
+
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
 
|}
 
|}
  
−
The ClinicalDocument class inherits various attributes from the {{ext|infrastructure/rim/rim.htm#InfrastructureRoot-cls|InfrastructureRoot class}} of the RIM, including ClinicalDocument.templateId and ClinicalDocument.typeId which are discussed here. All CDA classes inherit from infrastructureRoot, which is discussed in Section (link here).
+
'''NonXMLBody.typeCode'''
  
−
'''ClinicalDocument.typeId'''
+
The ClinicalDocument.classCode in the CDA model is fixed to "DOCCLIN".
  
−
ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).
+
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed NonXMLBody.classCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOCBODY DOCBODY]||document body
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
  
−
'''ClinicalDocument.templateId'''
+
'''NonXMLBody.moodCode'''
  
−
When a templateId is present in a CDA element, it signals the imposition of a set of template-defined constraints for that element. The templateId is one of the infrastructure attributes added to all CDA classes.  It has only been displayed for ClinicalDocument, but is present in all CDA classes, where it can be used to identify constraints defined in an external Implementation Guide template. See 4.3.2 Template Versioning.
+
The NonXMLBody.moodCode is fixed to "EVN" or event mood to indicate that this is documentation of a past service.
  
−
'''ClinicalDocument.id'''
+
{| class='wikitable'
−
 
+
|+Table {{AUTOTABLENUM}}: Fixed NonXMLBody.moodCode
−
Represents the unique instance identifier of a clinical document.
+
!Code!!Display Name
−
 
+
|-
−
'''ClinicalDocument.code'''
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
−
 
+
|-
−
The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note). The value set is drawn from LOINC, and has a CWE coding strength.
+
!style="text-align:left;" colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
−
 
+
|}
−
Within the LOINC database, beginning with version 2.09, May 2003, document type codes are those that have a value of "DOC" in the Scale component. This subset of LOINC is included in the appendix (see [[#LOINC_Document_Codes|LOINC Document Codes]]).
 
−
 
 
−
'''ClinicalDocument.title'''
 
−
 
 
−
Represents the title of the document. It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of ClinicalDocument.code (e.g. a "consultation" or "progress note"). Where these display names are rendered to the clinician, or where the document has a unique title, the ClinicalDocument.title component should be used. In the example document in the appendix (see [[#Sample_Document|Sample Document]]), the value of ClinicalDocument.title = "Good Health Clinic Consultation Note".
 
  
−
'''ClinicalDocument.effectiveTime'''
+
'''NonXMLBody.text'''
  
−
Signifies the document creation time, when the document first came into being. Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document was created. The time when the transform occurred is not currently represented in CDA.
+
NonXMLBody.text is used to reference data that is stored externally to the CDA document or to encode the data directly inline. Rendering a referenced non-XML body requires a software tool that recognizes the particular MIME media type for this type of body.
  
−
'''ClinicalDocument.ConfidentialityCode'''
+
'''NonXMLBody.confidentialityCode'''
  
−
Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value (as further described in [[#CDA_Context|CDA Context]]). A best practice for clinical documents is to assert the highest level of confidentiality present within a document at the header level.
+
Confidentiality is a required contextual component of CDA, where the value expressed in the ClinicalDocument can be overridden for the NonXMLBody of the document.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Value set for ClinicalDocument.confidentialityCode
+
|+Table {{AUTOTABLENUM}}: Value set for NonXMLBody.confidentialityCode
−
! style="text-align:left;"  colspan="5" |  x_BasicConfidentialityKind <small>[2.16.840.1.113883.1.11.16926] (OPEN) </small>
+
! style="text-align:left;"  colspan="5" |  X_BasicConfidentialityKind <small>[2.16.840.1.113883.1.11.16926] (OPEN) </small>
 
|-
 
|-
 
!Code !!Display Name!! !!Code !!Display Name
 
!Code !!Display Name!! !!Code !!Display Name
Line 142: Line 127:
 
!style="text-align:left;"  colspan="5" |<small> Code System: Confidentiality (HL7) Code System OID: 2.16.840.1.113883.5.25</small>
 
!style="text-align:left;"  colspan="5" |<small> Code System: Confidentiality (HL7) Code System OID: 2.16.840.1.113883.5.25</small>
 
|}
 
|}
−
 
 
<nowiki>*</nowiki> The codeSystem value is included here because confidentialityCode is of type CE, and therefore must carry both a code and a codeSystem.
 
<nowiki>*</nowiki> The codeSystem value is included here because confidentialityCode is of type CE, and therefore must carry both a code and a codeSystem.
  
−
'''ClinicalDocument.languageCode'''
+
'''NonXMLBody.languageCode'''
  
−
Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF (Internet Engineering Task Force) RFC 3066 for the Identification of Languages, ed. H. Alvestrand. 1995, which obsoletes RFC 1766. The HL7 code system for these values is "2.16.840.1.113883.6.121". Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value (as further described in [[#CDA_Context|CDA Context]]).
+
Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF (Internet Engineering Task Force) RFC 3066 for the Identification of Languages, ed. H. Alvestrand. 1995, which obsoletes RFC 1766. The HL7 code system for these values is "2.16.840.1.113883.6.121". Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by the NonXMLBody (as further described in [[#CDA_Context|CDA Context]]).
  
−
'''ClinicalDocument.setId'''
+
====<big>StructuredBody</big>====
  
−
Represents an identifier that is common across all document revisions.
+
The StructuredBody class represents a CDA document body that is comprised of one or more document sections.
  
−
'''ClinicalDocument.versionNumber'''
+
{| class='wikitable'
−
 
+
|+Table {{AUTOTABLENUM}}: StructuredBody Attributes
−
An integer value used to version successive replacement documents.
+
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
−
 
+
|-
−
'''ClinicalDocument.copyTime (Deprecated)'''
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att    classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||Fixed
−
 
+
|-
−
Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att    moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
−
 
+
|-
−
Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.
+
|[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/vs_Confidentiality.htm#x_BasicConfidentialityKind V:x_BasicConfidentialityKind]||Open
−
 
+
|-
−
===Header Participants===
+
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
−
 
+
|}
−
This section describes classes related to the root ClinicalDocument class via a Participation.
 
−
 
 
−
====<big>authenticator</big>====
 
−
 
 
−
[[Image:Authenicator.png|800px|border|center|authenicator]]
 
−
 
 
−
Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it. (See also [[#legalAuthenticator|legalAuthenticator]])
 
  
−
A clinical document can have zero to many authenticators. Both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual.  
+
'''StructuredBody.classCode'''
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Authenicator
+
|+Table {{AUTOTABLENUM}}: Fixed StructuredBody.classCode
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUTHEN AUTHEN]||Fixed
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOCBODY DOCBODY]||document body
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att  time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[1..1]||||
+
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att signatureCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CV CV]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationSignature.htm S]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-signatureText-att  signatureText]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED] ||[0..1]||||
 
 
|}
 
|}
  
−
'''authenticator.typeCode'''
+
'''StructuredBody.moodCode'''
−
 
 
−
The authenticator.typeCode is fixed to "AUTHEN" to indicate that a participant has attested his participation through a signature.
 
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed authenticator.typeCode
+
|+Table {{AUTOTABLENUM}}: Fixed StructuredBody.moodCode
 
!Code!!Display Name
 
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUTHEN AUTHEN]||authenticator
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
+
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 
|}
 
|}
  
−
'''authenticator.time'''
+
'''StructuredBody.confidentialityCode'''
−
 
 
−
Authenticator has a required authenticator.time indicating the time of authentication.
 
−
 
 
−
'''authenticator.signatureCode'''
 
−
 
 
−
Authenicator has a required authenticator.signatureCode, indicating that a signature has been obtained and is on file.
 
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed authenticator.signatureCode
+
|+Table {{AUTOTABLENUM}}: Value set for StructuredBody.confidentialityCode
−
!Code!!Display Name
+
! style="text-align:left;"  colspan="5" |  X_BasicConfidentialityKind <small>[2.16.840.1.113883.1.11.16926] (OPEN) </small>
 +
|-
 +
!Code !!Display Name!! !!Code !!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/Confidentiality.htm#N  N]||normal || ||[http://cda/infrastructure/vocabulary/Confidentiality.htm#R  R]||restricted
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationSignature.htm S] ('''Fixed''')||signed
+
|[http://cda/infrastructure/vocabulary/Confidentiality.htm#V  V]||very restricted|| || ||
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: ParticipationSignature (HL7) Code System OID: 2.16.840.1.113883.5.89</small>
+
!style="text-align:left;"  colspan="5" |<small> Code System: Confidentiality (HL7) Code System OID: 2.16.840.1.113883.5.25</small>
 
|}
 
|}
 +
<nowiki>*</nowiki> The codeSystem value is included here because confidentialityCode is of type CE, and therefore must carry both a code and a codeSystem.
 +
 +
'''confidentialityCode.HumanLanguage'''
  
−
'''Note''': CDA Release One represented either an intended ("X") or actual ("S") authenticator.  CDA Release 2 and 2.1 only represents an actual authenticator, so usage of "X" and "I" are deprecated.
+
=====<big>component</big>=====
  
−
'''authenticator.signatureText'''
+
A component class is used to relate the body choice (NonXMLBody, StructuredBody) to it's component Section(s).
 +
See [[#div-component|component]] for its attributes.
  
−
A new attribute, SignatureText has been added to authenticator. The signature can be represented either inline or by reference according to the ED data type. Typical cases are:
+
===<big>Section Attributes</big>===
  
−
# Paper-based signatures: the ED data type may refer to a document or other resource that can be retrieved through an electronic interface to a hardcopy archive.
 
−
# Electronic signature: this attribute can represent virtually any electronic signature scheme.
 
−
# Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.
 
  
−
<div id="div-AssignedEntity"></div>
+
[[Image:Section.png|800px|border|center|Section]]
−
=====AssignedEntity=====
 
  
−
An authenticator is a person in the role of an assigned entity (AssignedEntity class). An assigned entity is a person assigned to the role by the scoping organization. The entity playing the role is a person (Person class). The entity scoping the role is an organization (Organization class). (See {{ext|infrastructure/rim/rim.htm#Role-cls|here}} for a description of "player" and "scoper" role associations.)
+
Document sections can nest, can override context propagated from the header (see [[#CDA_Context|CDA Context]], and can contain narrative and CDA entries.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: AssignedEntity
+
|+Table {{AUTOTABLENUM}}: Section Attributes
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att   classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCSECT DOCSECT]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-id-att id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[1..*]|| ||  
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#RoleCode D:RoleCode]|| Open
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II ii]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[1..1]||[http://cda/infrastructure/vocabulary/vs_LN.htm#DocumentSectionType D:DocumentSectionType]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-title-att title]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ST ST]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED.STRUCTURED_TEXT ED.STRUCTURED_TEXT]||[0..1]||||
 +
|-  
 +
|[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/vs_Confidentiality.htm#x_BasicConfidentialityKind V:x_BasicConfidentialityKind]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
 +
|}
 +
 
 +
An XML attribute "ID" of type XML ID, is added to Section within the CDA Schema. This attribute serves as the target of a  reference (see [[#reference|reference]]). All values of attributes of type XML ID must be unique within the document (per the [http://www.w3.org/TR/2004/REC-xml-20040204/#id W3C XML specification]).
 +
 
 +
'''Section.classCode'''
 +
 
 +
The Section.classCode is fixed to "DOCSECT", which represents a context that subdivides the body of a document. Document sections are typically used for human navigation, to give a reader a clue as to the expected content. Document sections are used to organize and provide consistency to the contents of a document body. Document sections can contain document sections and can contain entries.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Section.classCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att  addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOCSECT DOCSECT]||document section
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||
+
!style="text-align:left;" colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
|}
 
|}
  
−
'''AssignedEntity.classCode'''
+
'''Section.moodCode'''
  
−
The classCode is fixed to "ASSIGNED", which is used in this context to indicate that a person in the employ of an organization was acting as their agent.
+
The Section.moodCode is fixed to "EVN" (event) which indicates the section is about a service that actually happens, may be an ongoing service or a documentation of a past service.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed AssignedEntity.classCode
+
|+Table {{AUTOTABLENUM}}: Fixed Section.moodCode
 
!Code!!Display Name
 
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED ]||assigned entity
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 
|}
 
|}
  
−
'''AssignedEntity.id'''
+
'''Section.id'''
  
−
In this context, it is a unique identifier for the person in this Role.
+
The unique instance identifier of a particular document section.
  
−
'''AssignedEntity.code'''
+
'''Section.code'''
  
−
Identifies the specific kind of Role to which an Role-instance belongs. The AssignedEntity.code is bound to D:RoleCode, which enables any code from the HL7 [http://cda/infrastructure/vocabulary/RoleCode.htm RoleCode vocabulary].  
+
The code specifying the particular kind of section (e.g. Chief Complaint, Review of Systems, Assessment). The value set is drawn from LOINC, and has a CWE coding strength.
  
−
'''AssignedEntity.addr'''
+
'''Section.title'''
  
−
A postal address for the Entity while in the Role.
+
Represents the label of a section. If valued, it is to be rendered as part of the narrative content of the clinical document body.
  
−
'''AssignedEntity.telecom'''
+
'''Section.text'''
  
−
A telecommunication address for the Entity while in the Role.
+
Used to store narrative to be rendered. Also referred to as the CDA Narrative Block. See [[#Section_Narrative_Block|Section Narrative Block]] for details.
  
−
=====Person=====
+
'''Section.confidentialityCode'''
  
−
Refer to [[#div-person|Person]] as defined for Author participation.
+
A value for Section.confidentialityCode overrides the value propagated from StructuredBody. See [[#CDA_Context|CDA Context]] for more details.
  
−
<div id="div-organization"></div>
 
−
<div id="div-Organization"></div>
 
−
=====Organization=====
 
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Organization
+
|+Table {{AUTOTABLENUM}}: Value set for Section.confidentialityCode
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
! style="text-align:left;"  colspan="5" | X_BasicConfidentialityKind <small>[2.16.840.1.113883.1.11.16926] (OPEN) </small>
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#ORG ORG]||Fixed
+
!Code !!Display Name!! !!Code !!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||Fixed
+
|[http://cda/infrastructure/vocabulary/Confidentiality.htm#N  N]||normal || ||[http://cda/infrastructure/vocabulary/Confidentiality.htm#R  R]||restricted
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-id-att id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||  
+
|[http://cda/infrastructure/vocabulary/Confidentiality.htm#V V]||very restricted|| || ||
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-name-att name]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ON ON]>||[0..1]|| ||
+
!style="text-align:left;" colspan="5" |<small> Code System: Confidentiality (HL7) Code System OID: 2.16.840.1.113883.5.25</small>
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-telecom-att  telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Organization-addr-att  addr]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Organization-standardIndustryClassCode-att  standardIndustryClassCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]|| [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#OrganizationIndustryClass D:OrganizationIndustryClass]
 
 
|}
 
|}
 +
<nowiki>*</nowiki> The codeSystem value is included here because confidentialityCode is of type CE, and therefore must carry both a code and a codeSystem.
 +
 +
'''Section.languageCode'''
  
−
'''Organization.classCode'''
+
Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF (Internet Engineering Task Force) RFC 3066: Tags for the Identification of Languages, ed. H. Alvestrand. 1995 , which obsoletes RFC 1766. The HL7 code system for these values is "2.16.840.1.113883.6.121".
−
With the code fixed to "ORG", it indicates we are referencing an Organization.  
 
  
−
{| class='wikitable' 
+
A value for Section.languageCode overrides the value propagated from StructuredBody. See [[#CDA_Context|CDA Context]] for more details.
−
|+Table {{AUTOTABLENUM}}: Fixed Organization.classCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/EntityClass.htm#ORG ORG] ||organization
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
 
−
|}
 
  
−
'''Organization.determinerCode'''
+
===<big>Section Participants</big>===
  
−
The determinerCode is fixed to "INSTANCE", which indicates that the scoping organization referenced, is a specific instance of an organization.
+
====<big>author</big>====
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed Organization.determinerCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System:  EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
 
−
|}
 
  
−
'''Organization.id'''
+
The author participant (described above, see [[#author|author]]), can be ascribed to a CDA section, where it overrides the value(s) propagated from the CDA header.
  
−
A unique identifier for the Organization.
+
====<big>informant</big>====
−
 
 
−
'''Organization.name'''
 
−
 
 
−
A non-unique textual identifier or moniker for the organization.
 
−
 
 
−
'''Organization.telecom'''
 
−
 
 
−
A telecommunication address for the Organization.
 
−
 
 
−
'''Organization.addr'''
 
−
 
 
−
The postal or residential address of an organization.
 
  
−
'''Organization.standardIndustryClassCode'''
+
The informant participant (described above, see [[#informant|informant]]), can be ascribed to a CDA section where it overrides the value(s) propagated from the CDA header.
  
−
A code which identifies the industrial category of an organization. In the US Realm, it has been bound to the Code System: North American Industry Classification System  [2.16.840.1.113883.6.85] (NAICS).  The binding type is Open, so other code system and values sets may be used in the US and other realms.  [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#OrganizationIndustryClass D:OrganizationIndustryClass]
+
====<big>subject</big>====
  
−
<div id="div-OrganizationPartOf"></div>
+
The subject participant represents the primary target of the entries recorded in the document. Most of the time the subject is the same as the recordTarget (see [[#recordTarget|recordTarget]]), but need not be, for instance when the subject is a fetus observed in an obstetrical ultrasound.
−
=====OrganizationPartOf=====
 
  
−
A scoping organization can be part of a larger organization. Where there is a need to include whole-part relationships, the OrganizationPartOf role can be used. OrganizationPartOf.statusCode indicates the state of the whole-part relationship (e.g. "active", "terminated").  
+
The subject participant can be ascribed to a CDA section or a CDA entry. It propagates to nested components, unless overridden. The subject of a document is presumed to be the patient.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: OrganizationPartOf
+
|+Table {{AUTOTABLENUM}}: informant
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#PART PART]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#INF INF]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-id-att id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[1..*]|| ||
+
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#RoleCode D:RoleCode]|| Open
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-statusCode-att  statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleStatus.htm V:RoleStatus]||Closed
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] >||[0..1]|| ||  
+
|[http://cda/infrastructure/rim/rim.htm#Participation-awarenessCode-att awarenessCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://ceb/infrastructure/vocabulary/voc_ConceptDomains.htm#TargetAwareness D:TargetAwareness]||Open
 
|}
 
|}
  
 +
'''subject.typeCode'''
  
−
'''OrganizationPartOf.classCode'''
+
The subject.typeCode is fixed to "SBJ" to indicate that a participant that is the principle target (subject) of the service acts documented.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed OrganizationPartOf.classCode
+
|+Table {{AUTOTABLENUM}}: Fixed subject.typeCode
 
!Code!!Display Name
 
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PART PART]||part
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#SBJ SBJ]||subject
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
!style="text-align:left;"  colspan="2" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 
|}
 
|}
  
−
'''OrganizationPartOf.id'''
+
'''subject.contextControlCode'''
−
 
 
−
A unique identifier for the player organization in this Role.
 
−
 
 
−
'''OrganizationPartOf.code'''
 
−
 
 
−
The specific kind of Role to which an Role-instance belongs.
 
  
−
'''OrganizationPartOf.statusCode'''
+
The subject.contextControlCode is fixed to "OP". Any subject(s) defined for a section will override the the Patient in recordTarget (an implicit subject) and propagate to the sub-sections and entries this section contains.  
−
 
 
−
The state of this Role as defined in the state-transition model.
 
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Value set for OrganizationPartOf.statusCode
+
|+Table {{AUTOTABLENUM}}: Fixed subject.contextControlCode
−
! style="text-align:left;"  colspan="5" |  V:RoleStatus      <small>[2.16.840.1.113883.5.1068] (CLOSED) </small>
+
!Code!!Display Name
 
|-
 
|-
−
!Code!!Display Name!! !!Code!!Display Name
+
|[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||overriding, propagating
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleStatus.htm#normal normal]||normal||
+
!style="text-align:left;"  colspan="2" | <small> Code System: ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057</small>
−
||[http://cda/infrastructure/vocabulary/RoleStatus.htm#active active]||active
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/RoleStatus.htm#cancelled cancelled]||cancelled||
 
−
||[http://cda/infrastructure/vocabulary/RoleStatus.htm#pending pending]||pending
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/RoleStatus.htm#suspended suspended]||suspended||
 
−
||[http://cda/infrastructure/vocabulary/RoleStatus.htm#terminated terminated]||terminated
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/RoleStatus.htm#nullified nullified]||nullified||
 
−
|| ||
 
−
|-
 
−
!style="text-align:left;"  colspan="5" |<small> Code System: RoleStatus (HL7) Code System OID: 2.16.840.1.113883.5.1068</small>
 
 
|}
 
|}
  
−
'''OrganizationPartOf.effectiveTime'''
+
=====RelatedSubject=====
−
 
 
−
The OrganizationPartOf.effectiveTime is an interval of time specifying the period during which the whole-part relationhship is in effect, if such time limit is applicable and known.
 
−
 
 
−
====<big>author</big>====
 
−
 
 
−
[[Image:Author.png|800px|border|center|author]]
 
  
−
Represents the humans and/or machines that authored the document.  
+
A subject is a person playing one of several possible roles (RelatedSubject class).  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: author
+
|+Table {{AUTOTABLENUM}}: RelatedSubject
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUT AUT]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_RoleClass.htm#x_DocumentSubject x_DocumentSubject]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-functionCode-att  functionCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ParticipationFunction D:ParticipationFunction]|| Open
+
|[http://cda/infrastructure/rim/rim.htm#Role-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#PersonalRelationshipRoleType D:PersonalRelationshipRoleType ]|| Open
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||  
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[1..1]||||
+
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||  
 
|}
 
|}
  
−
'''author.typeCode'''
+
'''RelatedSubject.classCode'''
  
−
The author.typeCode is fixed to "AUT", used to indicate the party that originates the document and is responsible for the information in the document.
+
The RelatedSubject.classCode can take two codes; "PAT" a Role of a LivingSubject (player) as a recipient of health care services from a healthcare provider (scoper) and "PRS" which links two people in a personal relationship. The character of the relationship must be defined by a PersonalRelationshipRoleType code.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed author.typeCode
+
|+Table {{AUTOTABLENUM}}: Value set for RelatedSubject.classCode
−
!Code!!Display Name
+
! style="text-align:left;"  colspan="5" | v:x_DocumentSubject  <small>[2.16.840.1.113883.1.11.19368] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name !!  !!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUT AUT]||author
+
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PAT PAT] ('''Default''')||patient ||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PRS PRS]||personal relationship
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
+
!style="text-align:left;"  colspan="5" | <small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
 
|}
 
|}
  
−
'''author.functionCode'''
+
'''RelatedSubject.code'''
−
 
 
−
 
 
−
The author.functionCode is bound to the concept domain ParticipationFunction, which is used to specify the exact function an actor had in a service in all necessary detail. This domain may include local extensions (Open).
 
−
 
 
−
In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "Medical Student Progress Note". The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply "Physician Progress Note" and the value of Author.functionCode is "rounding physician"), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.
 
  
−
'''author.contextControlCode'''
+
The RelatedSubject.code is bound to the [http://cda/infrastructure/vocabulary/vs_RoleCode.htm#PersonalRelationshipRoleType PersonalRelationshipRoleType] concept domain
  
−
The author.contextControlCode is fixed to "OP". It means that the author will replace the set of author participations that have propagated from ancestor Acts, and will itself be the only author to propagate to any child Acts that allow context to be propagated. 
+
'''RelatedSubject.addr'''
  
−
{| class='wikitable' 
+
An optional postal address for the subject.
−
|+Table {{AUTOTABLENUM}}: Fixed author.contextControlCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||overriding, propagating
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057</small>
 
−
|}
 
  
−
'''author.time'''
+
'''RelatedSubject.telecom'''
  
−
The author.time is used to capture the time this specific author contributed content to the document.
+
An optional phone number for the subject.
  
−
=====AssignedAuthor=====
+
=====SubjectPerson=====
  
−
An author is a person in the role of an assigned author (AssignedAuthor class). The entity playing the role is a person (Person class) or a device (AuthoringDevice class). The entity scoping the role is an organization (Organization class), and is the organization from which the document originates.  
+
The entity playing in the role RelatedSubject, is a person (SubjectPerson class).
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: AssignedAuthor
+
|+Table {{AUTOTABLENUM}}: SubjectPerson
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#PSN PSN]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-id-att  id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[1..*]|| ||  
+
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE  INSTANCE]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-id-att  id] ||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-name-att  name]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PN PN]>||[0..*]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-desc-att  desc ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#LivingSubject-administrativeGenderCode-att administrativeGenderCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/AdministrativeGender.htm D:administrativeGender]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#LivingSubject-birthTime-att birthTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]|| ||
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#LivingSubject-deceasedInd-att deceasedInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#LivingSubject-deceasedTime-att deceasedTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]|| ||
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#LivingSubject-multipleBirthInd-att multipleBirthInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#LivingSubject-multipleBirthOrderNumber-att multipleBirthOrderNumber]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-INT INT]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Person-maritalStatusCode-att maritalStatusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/vs_MaritalStatus.htm#MaritalStatus D:MaritalStatus]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-code-att code ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#RoleCode D:RoleCode]|| Open
+
|[http://cda/infrastructure/rim/rim.htm#Person-religiousAffiliationCode-att religiousAffiliationCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/ReligiousAffiliation.htm D:ReligousAffiliation]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||  
+
|[http://cda/infrastructure/rim/rim.htm#Person-raceCode-att raceCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||<span class="change-highlight">[0..*]</span>||[http://cda/infrastructure/vocabulary/Race.htm D:Race]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||  
+
|[http://cda/infrastructure/rim/rim.htm#Person-ethnicGroupCode-att ethnicGroupCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||<span class="change-highlight">[0..*]</span>||[http://cda/infrastructure/vocabulary/Ethnicity.htm D:Ethnicity]||Open
−
|}
+
|}  
−
+
 
−
'''AssignedAuthor.classCode'''
+
'''SubjectPerson.classCode'''
  
−
The classCode is fixed to "ASSIGNED", which is used in this context to indicate that a person in the employ of an organization was acting as their agent.
+
The SubjectPerson.classCode is fixed to "PSN", indicating that the entity is a person.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed AssignedAuthor.classCode
+
|+Table {{AUTOTABLENUM}}: Fixed SubjectPerson.classCode
 
!Code!!Display Name
 
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED ]||assigned entity
+
|[http://cda/infrastructure/vocabulary/EntityClass.htm#PSN PSN]||person
 
|-
 
|-
−
!style="text-align:left;"  colspan="5" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
!style="text-align:left;"  colspan="2" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
 
|}
 
|}
  
−
'''AssignedAuthor.id'''
+
'''SubjectPerson.determinerCode'''
  
−
In this context, it is a unique identifier for the person in this Role.
+
The determinerCode is fixed to "INSTANCE", which indicates a specific person is a SubjectPerson.  
  
−
'''AssignedAuthor.code'''
+
{| class='wikitable'
−
 
+
|+Table {{AUTOTABLENUM}}: Fixed SubjectPerson.determinerCode
−
Identifies the specific kind of Role to which an Role-instance belongs. The AssignedEntity.code is bound to D:RoleCode, which enables any code from the HL7 [http://cda/infrastructure/vocabulary/RoleCode.htm RoleCode vocabulary].  
+
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System:  EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
 +
|}
 +
 
 +
'''SubjectPerson.id'''
  
−
'''AssignedAuthor.addr'''
+
Optional identifier for the SubjectPerson.
  
−
A postal address for the Entity while in the Role.
+
'''SubjectPerson.name'''
  
−
'''AssignedAuthor.telecom'''
+
The subject's name.
  
−
A telecommunication address for the Entity while in the Role.
+
Note: The person name data type "PN" supports current, and historical names using validTime, and the specification of different use codes can indicate legal name, tribal name, stage name and others.  
  
−
<div id='div-person'></div>
+
'''SubjectPerson.desc'''
  
−
=====Person=====
+
A textual or multimedia depiction of the subject.
  
−
A human being.
+
'''SubjectPerson.administrativeGenderCode'''
−
{| class='wikitable'
 
−
|+Table {{AUTOTABLENUM}}: Person
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#PSN PSN]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE  INSTANCE]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-name-att  name]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PN PN]>||[0..*]|| ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-desc-att  desc ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]|| ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#LivingSubject-birthTime-att birthTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]|| ||
 
−
|}
 
  
−
'''Person.classCode'''
+
The gender (i.e., the behavioral, cultural, or psychological traits typically associated with one sex) of a living subject as defined for administrative purposes.  
  
−
With the code fixed to "PSN", it indicates we are referencing a Person.
+
'''SubjectPerson.birthTime'''
  
−
{| class='wikitable' 
+
The date and time of the subject's birth.
−
|+Table {{AUTOTABLENUM}}: Fixed Person.classCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/EntityClass.htm#PSN PSN]||person
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System:  EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
 
−
|}
 
  
−
'''Person.determinerCode'''
+
'''<span class="change-highlight">SubjectPerson.deceasedInd</span>'''
  
−
The determinerCode is fixed to "INSTANCE", which indicates that we are dealing with a specific person.
+
<span class="change-highlight">An indication that the subject is dead.</span>
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed Person.determinerCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE] ('''Fixed''')||specific
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System:  EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
 
−
|}
 
  
−
'''Person.name'''
+
'''<span class="change-highlight">SubjectPerson.deceasedTime</span>'''
  
−
The person's name.  
+
<span class="change-highlight">The date and time that the Subject's death occurred.</span>
  
−
Note: The person name data type "PN" supports current, and historical names using validTime, and the specification of different use codes can indicate legal name, tribal name, stage name and others.
+
'''<span class="change-highlight">SubjectPerson.multipleBirthInd</span>'''
  
−
'''Person.desc'''
+
<span class="change-highlight">An indication as to whether the subject was part of a multiple birth.</span>
  
−
A textual or multimedia depiction of the person.
+
'''<span class="change-highlight">SubjectPerson.multipleBirthOrderNumber</span>'''
  
−
'''Person.birthTime'''
+
<span class="change-highlight">The order within a multiple birth in which this subject was born.</span>
  
−
The date and time of a person's birth.
+
'''SubjectPerson.maritalStatusCode'''
  
−
=====AuthoringDevice=====
+
The domestic partnership status of the subject.
  
−
{| class='wikitable'
+
'''SubjectPerson.religiousAffiliationCode'''
−
|+Table {{AUTOTABLENUM}}: AuthoringDevice
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#DEV DEV]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE  INSTANCE]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EntityCode D:EntityCode] ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-manufacturerModelName-att  manufacturerModelName ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SC SC]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ManufacturerModelName  D:ManufacturerModelName ] ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#softwareName-desc-att  softwareName ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SC SC]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#SoftwareName  D:SoftwareName ] ||
 
−
|}
 
  
−
'''AuthoringDevice.classCode'''
+
The primary religious preference of the subject.
  
−
The AuthoringDevice.classCode if fixed to "DEV" indicating that a device was used to generate content in the document.
+
'''SubjectPerson.raceCode'''
−
{| class='wikitable'
 
−
|+Table {{AUTOTABLENUM}}: Fixed AuthoringDevice.classCode 
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/EntityClass.htm#DEV DEV]||role
 
−
|-
 
−
!style="text-align:left;"  colspan="5" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
 
−
|}
 
  
−
'''AuthoringDevice.determinerCode'''
+
The race of the subject.  
  
−
The determinerCode is fixed to "INSTANCE", which indicates we are referencing a specific device.
+
<span class="change-highlight">'''Note:''' More than one race code is now supported in CDA R2.1.</span>
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed AuthoringDevice.determinerCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
 
−
|-
 
−
!style="text-align:left;" colspan="2" | <small> Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
 
−
|}
 
  
−
'''AuthoringDevice.code'''
+
'''SubjectPerson.ethnicGroupCode'''
  
−
The AuthoringDevice.code is bound to the EntityCode domain.
+
The ethnic group of the subject.
  
−
'''AuthoringDevice.manufacturerModelName'''
+
<span class="change-highlight">'''Note:''' More than one ethnic group is now supported in CDA R2.1.</span>
  
−
Is used to convey a coded name for the device.
+
'''Note:''' See 2.7 Backwards and Forwards Compatibility, for discussion on sdtc: extensions defined for CDA R2.0 and CDA R2.1.
  
−
'''AuthoringDevice.softwareName'''
+
===<big>Section Relationships</big>===
  
−
Is used to convey a coded name for the software used to author content.
+
====<big>component</big>====
  
−
=====MaintainedEntity=====
+
The "component" Act Relationship is used to nest a Section within a Section. Context propagates to nested sections (see [[#CDA_Context|CDA Context]]).  Refer to [[#div-component|component]] above for more information.
  
−
:'''NOTE:''' In CDA, Release One, it was possible to specify those individuals responsible for the device. This functionality has been deprecated in CDA, Release Two. The MaintainedEntity class is present for backwards compatibility, and its use is discouraged, except where needed to support the transformation of CDA, Release One documents.
+
====<big>entry</big>====
  
−
{| class='wikitable' 
+
The relationship between a section and its entries is encoded in the intervening "entry" Act Relationship.
−
|+Table {{AUTOTABLENUM}}: MaintainedEntity
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#MNT MNT]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]|| ||
 
−
|}
 
  
−
'''MaintainedEntity.classCode'''
+
The narrative of each Section, together with the multimedia content referenced in the narrative, comprises the complete authenticated content of the Section. This multimedia content consists of ObservationMedia and RegionOfInterest entries referenced by  tags in the Section.text. This is the only case where the entries contain authenticated content that must be rendered with the narrative.
  
−
With the classCode fixed to "MNT", it indicates that AuthoringDevice is maintained by person assuming responsibility for proper operation, quality, and safety.  
+
:'''NOTE:''' See [[#Referencing_in_and_out_of_the_narrative_block|Referencing in and out of the narrative block]] for a discussion of referencing in and out of a section's narrative block.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed MaintainedEntity.classCode
+
|+Table {{AUTOTABLENUM}}: entry Attributes
−
!Code!!Display Name
+
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#MNT MNT]||maintained entity
+
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActRelationshipType.htm#x_ActRelationshipEntry V:x_ActRelationshipEntry]||Fixed
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-contextConductionInd-att contextConductionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 
|}
 
|}
  
−
'''MaintainedEntity.effectiveTime'''
+
'''entry.typeCode'''
  
−
An interval of time specifying the period during which the Role is in effect.
+
In terms of the relationship between a section and its entries, CDA defines a default general case, and a more specific case that can be used when applicable.
  
−
====<big>custodian</big>====
+
The entry relationship is defaulted to "COMP" (component), for the general case where the only assertion is that the related entries are contained within the source section and no other semantics are implied. In this case, the narrative is the original authenticated content. The CDA entries are created by various techniques (e.g., natural language processing, a human coder, a structured data entry tool that outputs both entries and a text report). The method of entry creation may be indicated by the entry participants (e.g., by identifying the algorithm or person that generated them). Relationships between various entries (such as two Observations or an Observation and an ObservationMedia) are encoded using the relationship types defined in [[#entryRelationship|entryRelationship]].
  
−
[[Image:Custodian.png|800px|border|center|custodian]]
+
A section may also have no narrative content in the case where the entries represent information that is not part of the clinical content of the document. A report may embed information referencing evidence data, reagents, calibration or other information that may be used for later processing but is not part of the clinical content. Such entries are also linked to the Section with ActRelationships possessing typeCode="COMP".
  
−
Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian.  
+
The entry relationship "DRIV" (is derived from) can be used in the special case where the narrative is fully derived from CDA Entries. When a report consisting entirely of structured entries is transformed into CDA, the encoding application must ensure that the authenticated content (narrative plus multimedia) is a faithful and complete rendering of the clinical content of the structured source data. This ensures that the narrative plus multimedia represents, as in all CDA documents, the complete authenticated content of the Section. In this case, narrative plus multimedia does not contain any clinical content that is not present in the Entries. An example of this case is a DICOM Structured Reporting document of obstetrical measurements made by ultrasound, rendered into a tabular report by a program converting it to CDA narrative block. If the typeCode of the ActRelationship linking these Entries to the Section was "DRIV", it would indicate to a receiving application: 1) the source of the narrative block is the Entries; 2) the contents of the two are equivalent.
  
−
The custodian participation satisfies the CDA definition of Stewardship (see [[#What_is_the_CDA|What is the CDA]]). Because CDA is an exchange standard and may not represent the original form of the authenticated document, the custodian represents the steward of the original source document.  
+
The entries sourced from a Section may have a mix of ActRelationship typeCodes. In such a case, the union of the targets with a "DRIV" relationship are those used to generate the narrative block, and are those that, taken in total, are equivalent to the narrative block. Additional entries with "COMP" relationships are contained within the same section, with no implied semantics.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: custodian
+
|+Table {{AUTOTABLENUM}}: Value set for entry.typeCode
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
! style="text-align:left;" colspan="5" | V:x_ActRelationshipEntry  <small>[2.16.840.1.113883.1.11.19446] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name!! !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMP COMP] ('''Default''')||has component ||
 +
||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#DRIV DRIV]||is derived from
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#CST CST]||Fixed
+
!style="text-align:left;" colspan="5" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 
|}
 
|}
  
−
'''custodian.typeCode'''
+
'''entry.contextConductionInd'''
 +
 
 +
The component.contextConductionInd indicator is fixed to "true". Ancestor elements () which propagate, will conduct through this component class to the associated child element.
  
−
The custodian.typeCode is fixed to "CST", which indicates in this instance an organization that is in charge of maintaining this document. Examples: Medical Records Dept in hospital, Health Information Management Dept., etc. 
+
===<big>Section Narrative Block</big>===
  
−
{| class='wikitable' 
+
The Section.text field is used to store narrative to be rendered, as described above in [[#CDA_Conformance|CDA Conformance]], and is therefore referred to as the CDA Narrative Block.
−
|+Table {{AUTOTABLENUM}}:Fixed custodian.typeCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CST CST]||custodian
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 
−
|}
 
  
−
A custodian is a scoping organization in the role of an assigned custodian (AssignedCustodian class). The steward organization (CustodianOrganization class) is an entity scoping the role of AssignedCustodian, and has a required CustodianOrganization.id.  
+
{{ext|processable/coreschemas/NarrativeBlock.xsd|The CDA Narrative Block schema can be found here.}}
  
−
=====AssignedCustodian=====
+
The content model of the CDA Narrative Block schema is specially hand crafted to meet the requirements outlined above (see [[#Human_Readability_and_Rendering_CDA_Documents|Human Readability and Rendering CDA Documents]]). The schema is registered as a MIME type (text/x-hl7-text+xml), which is the fixed media type for Section.text. Components of the schema are described in the sections that follow.
  
−
{| class='wikitable' 
+
====<big><content></big>====
−
|+Table {{AUTOTABLENUM}}: AssignedCustodian
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED]||Fixed
 
−
|}
 
  
−
'''AssignedCustodian.classCode
+
The CDA <content> element is used to wrap a string of text so that it can be explicitly referenced, or so that it can suggest rendering characteristics. The <content> element can nest recursively, which enables wrapping a string of plain text down to as small a chunk as desired.
  
−
{| class='wikitable' 
+
The <content> element contains an optional identifier, that can serve as the target of a reference. All values of attributes of type XML ID must be unique within the document (per the [http://www.w3.org/TR/2004/REC-xml-20040204/#id W3C XML specification]). The originalText component of a RIM attribute present in any CDA entry can make explicit reference to the identifier, thereby indicating the original text associated with the attribute in the CDA entry.
−
|+Table {{AUTOTABLENUM}}: Fixed AssignedCustodian.classCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED ]||assigned entity
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
 
−
|}
 
  
−
=====CustodianOrganization=====
+
'''Note:''' The <content> element is not the only element which can serve as the target of a reference. All narrative elements (including <text>) contain an ID element which can be referenced by the originalText component in a CDA entry. <content> is simply a tool which can be used to reference only a portion of a longer string contained in another narrative element.
  
−
{| class='wikitable' 
+
<div align="center">Example {{AUTOEXAMPLENUM}}</div>
−
|+Table {{AUTOTABLENUM}}: CustodianOrganization
+
<nowiki>
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
<section>
−
|-
+
  <code code="10153-2"  
−
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#ORG ORG]||Fixed
+
    codeSystem="2.16.840.1.113883.6.1"
−
|-
+
    codeSystemName="LOINC"/>
−
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||Fixed
+
  <title>Past Medical History</title>
−
|-
+
  <text>
−
|[http://cda/infrastructure/rim/rim.htm#Entity-id-att  id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[1..*]|| ||
+
    There is a history of <content ID="a1">Asthma</content>
−
|-
+
  </text>
−
|[http://cda/infrastructure/rim/rim.htm#Entity-name-att  name]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ON ON]>||[0..1]|| ||
+
  <entry>
−
|-
+
      <observation classCode="OBS" moodCode="EVN">
−
|[http://cda/infrastructure/rim/rim.htm#Entity-telecom-att  telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||
+
        <code code="195967001"
−
|-
+
          codeSystem="2.16.840.1.113883.6.96"
−
|[http://cda/infrastructure/rim/rim.htm#Organization-addr-att  addr]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||
+
          codeSystemName="SNOMED CT"
−
|}
+
          displayName="Asthma">
 +
            <originalText>
 +
              <reference value="#a1"/>
 +
            </originalText>
 +
        </code>
 +
        <statusCode code="completed"/>
 +
      </observation>
 +
  </entry>
 +
</section>
 +
</nowiki>
  
−
'''CustodianOrganization.classCode'''
+
There is no requirement that CDA entries must reference into the CDA Narrative Block. The referencing mechanism can be used where it is important to represent the original text component of a coded CDA entry.
−
With the code fixed to "ORG", it indicates we are referencing an Organization.  
 
  
−
{| class='wikitable' 
+
The <content> element contains an optional "revised" attribute that can be valued with "insert" or "delete", which can be used to indicate narrative changes from the last version of a CDA document. The attribute is limited to a single generation, in that it only reflects the changes from the preceding version of a document. If applied, it needs to be used in conjunction with standard CDA revision tracking. Changes to a CDA document that has been released for patient care still require a formal versioning and revision, and the revised document can optionally carry the "revised" attribute to show the delta in the narrative. Receivers are required to interpret the "revised" attribute when rendering by visually distinguishing or suppressing deleted narrative.
−
|+Table {{AUTOTABLENUM}}: Fixed CustodianOrganization.classCode
+
 
−
!Code!!Display Name
+
====<big><linkHtml></big>====
−
|-
 
−
|[http://cda/infrastructure/vocabulary/EntityClass.htm#ORG ORG] ||organization
 
−
|-
 
−
!style="text-align:left;" colspan="2" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
 
−
|}
 
  
−
'''CustodianOrganization.determinerCode'''
+
The CDA <linkHtml> is a generic referencing mechanism, similar, but not identical, to the HTML anchor tag. It can be used to reference identifiers that are either internal or external to the document.
  
−
The determinerCode is fixed to "INSTANCE", which indicates that the scoping organization referenced, is a specific instance of an organization.  
+
Multimedia that is integral to a document, and part of the attestable content of the document requires the use of the ObservationMedia CDA entry, which is referenced by the <renderMultiMedia> element (see [[#.3CrenderMultiMedia.3E|<renderMultiMedia>]]). Multimedia that is simply referenced by the document and not an integral part of the document can use <linkHtml>.
  
−
{| class='wikitable' 
+
The source of a link uses the linkHtml.href attribute. The target of an internal reference is an identifier of type XML ID, which can exist on other elements in the same or a different narrative block, or XML ID attributes that have been added to the <section>, <ObservationMedia>, or <renderMultiMedia> elements of the CDA Schema. The linkHtml.name attribute is deprecated, because attributes of type XML ID provide an alternative and more consistent target for referencing. Following the conventions of HTML, an internal link is prefaced with the pound sign, as shown in the following example.
−
|+Table {{AUTOTABLENUM}}: Fixed CustodianOrganization.determinerCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System:  EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
 
−
|}
 
  
−
'''CustodianOrganization.id'''
+
<div align="center">Example {{AUTOEXAMPLENUM}}</div>
 +
<nowiki>
 +
<section ID="SECT001">
 +
  <code code="10164-2" codeSystem="2.16.840.1.113883.6.1"
 +
    codeSystemName="LOINC"/>
 +
  <title>History of Present Illness</title>
 +
  <text>Mr. Smith is a 57 year old male presenting with
 +
    chest pain. He sustained a myocardial infarction 3 years
 +
    ago, ...
 +
  </text>
 +
</section>
  
−
A unique identifier for the Organization.
+
...
  
−
'''CustodianOrganization.name'''
+
<section ID="SECT003">
 +
  <code code="10153-2" codeSystem="2.16.840.1.113883.6.1"
 +
    codeSystemName="LOINC"/>
 +
  <title>Past Medical History</title>
 +
  <text>History of coronary artery disease, as noted
 +
    <linkHtml href="#SECT001">above</linkHtml>.</text>
 +
</section>
 +
</nowiki>
  
−
A non-unique textual identifier or moniker for the organization.
+
CDA links do not convey shareable meaning. Shareable semantics are only achieved by the inclusion of CDA entries and their associated formalized relationships. There is no requirement that a receiver render an internal or external link, or the target of an external link.
  
−
'''CustodianOrganization.telecom'''
+
====<big><nowiki><sub> and <sup></nowiki></big>====
  
−
A telecommunication address for the Organization.
+
The CDA &lt;sub> and &lt;sup> elements are used to indicate subscripts and superscripts, respectively.
  
−
'''CustodianOrganization.addr'''
+
Receivers are required to interpret these elements when rendering by visually distinguishing subscripted and superscripted characters.
  
−
The postal or residential address of an organization.
+
====<big><nowiki><br></nowiki></big>====
  
−
====<big>dataEnterer (Transcriptionist)</big>====
+
The CDA &lt;br/> element is used to indicate a hard line break. It differs from the CDA <paragraph> element in that the &lt;br/> element has no content. Receivers are required to interpret this element when rendering so as to represent a line break.
  
−
[[Image:DataEnterer.png|600px|border|center|dataEnterer ]]
+
====<big><footnote> and <footnoteRef></big>====
  
−
Represents the participant who has transformed a dictated note into text.
+
The CDA <footnote> element is used to indicate a footnote. The element contains the footnote, inline with the flow of text to which it is applied.
  
−
{| class='wikitable' 
+
The <footnoteRef> element can reference an existing footnote in the same or different CDA Narrative Block of the same document. It can be used when the same footnote is being used multiple times. The value of the footnoteRef.IDREF must be an footnote.ID value in the same document.
−
|+Table {{AUTOTABLENUM}}: dataEnterer
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ENT ENT]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[1..1]||||
 
−
|}
 
  
−
'''dataEnterer.typeCode'''
+
Receivers are required to interpret these elements when rendering by visually distinguishing footnoted text. The exact rendition is at the discretion of the recipient, and might include a mark at the location of the footnote with a hyperlink to the footnoted text, a simple demarcation (such as "This is the text [this is the footnote] that is being footnoted"), etc.
  
−
The dataEnterer.typeCode is fixed to "ENT".
+
====<big><renderMultiMedia></big>====
  
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed dataEnterer.typeCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#ENT ENT]||data entry person
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 
−
|}
 
  
−
'''dataEnterer.contextControlCode'''
+
The CDA &lt;renderMultiMedia&gt; element references external multimedia that is integral to a document, and part of the attestable content of the document, and serves to show where the referenced multimedia is to be rendered.
  
−
The dataEnterer.contextControlCode is fixed to "OP".
+
The &lt;renderMultiMedia&gt; element has an optional &lt;caption&gt;, and contains a required referencedObject attribute (of type XML IDREFS), the values of which must equal the XML ID value(s) of ObservationMedia or RegionOfInterest CDA entries within the same document.
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed dataEnterer.contextControlCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||overriding, propagating
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057</small>
 
−
|}
 
  
−
'''dataEnterer.time'''
+
<div align="center">Example {{AUTOEXAMPLENUM}}</div>
 +
<nowiki>
 +
<section>
 +
  <code code="8709-8" codeSystem="2.16.840.1.113883.6.1"
 +
    codeSystemName="LOINC"/>
 +
  <title>Skin exam</title>
 +
  <text>Erythematous rash, palmar surface, left index
 +
    finger.<renderMultiMedia referencedObject="MM1"/>
 +
  </text>
 +
  <entry>
 +
      <observationMedia classCode="OBS" moodCode="EVN" ID="MM1">
 +
        <id root="2.16.840.1.113883.19.2.1"/>
 +
        <value xsi:type="ED" mediaType="image/jpeg">
 +
            <reference value="left_hand_image.jpeg"/>
 +
        </value>
 +
      </observationMedia>
 +
  </entry>
 +
</section>
 +
</nowiki>
  
−
The date and time the data was entered into the originating system.
+
Multimedia that is simply referenced by the document and not an integral part of the document must use <linkHtml>.
  
−
=====AssignedEntity=====
+
The expected behavior is that the referenced multimedia should be rendered or referenced at the point of reference. Where a caption is present, it must also be rendered. <renderMultiMedia> can either reference a single ObservationMedia, or one or more RegionOfInterest. If <renderMultiMedia> references a single ObservationMedia, that ObservationMedia should be rendered or referenced at the point of reference. If <renderMultiMedia> references one or more RegionOfInterest, all RegionOfInterests should be rendered or referenced at the point of reference, atop the multimedia they are regions of. If <renderMultiMedia> references more than one RegionOfInterest, each RegionOfInterest must be a region on the same multimedia.
  
−
Refer to [[#div-AssignedEntity|AssignedEntity]] as defined for authenticator participation.
+
====<big><paragraph></big>====
  
−
====<big>encounterParticipant</big>====
+
A CDA <paragraph> is similar to the HTML paragraph, which allows blocks of narrative to be broken up into logically consistent structures. A CDA <paragraph> element contains an optional caption, which if present must come first before any other character data.
  
−
See [[#EncompassingEncounter|EncompassingEncounter]] for a description of the encounterParticipant participant.
+
====<big><list></big>====
  
−
====<big>informant</big>====
+
A CDA <list> is similar to the HTML list. A CDA <list> has an optional caption, and contains one or more <item> elements. A CDA <item> element contains an optional caption, which if present must come first before any other character data. The required listType attribute specifies whether the <list> is ordered or unordered (with unordered being the default). Unordered lists are typically rendered with bullets, whereas ordered lists are typically rendered with numbers, although this is not a requirement.
  
−
[[Image:Informant.png|600px|border|center|informant]]
+
====<big>&lt;table></big>====
  
−
An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.  
+
The CDA &lt;table> is similar to the HTML table. The table markup is for '''presentation purposes only''' and, unlike a database table, does not possess meaningful field names. Remember to access the discrete data conveyed in a CDA document, process the RIM models contained within the &lt;entry> element.
  
−
{| class='wikitable' 
+
CDA modifies the strict XHTML table model by removing formatting tags and by setting the content model of cells to be similar to the contents of other elements in the CDA Narrative Block. <span class="change-highlight">A notable enhancement to the CDA R2.1 standard is the support of the &lt;table> element within &lt;td> & &lt;th> elements. The support of tables within tables was not supported in CDA R2.0, but has been added for those implementation requiring complex table layouts.</span>
−
|+Table {{AUTOTABLENUM}}: informant
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#INF INF]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
 
−
|}
 
−
 
 
−
'''informant.typeCode'''
 
−
The informant.typeCode is fixed to "INF", which indicates the source of reported information (e.g., a next of kin who answers questions about the patient's history).  
 
  
−
{| class='wikitable' 
+
The table.border, table.cellspacing, and table.cellpadding attributes are deprecated, because the styleCode attribute (see [[#styleCode_attribute|styleCode attribute]]) provides a more consistent way for senders to suggest rendering characteristics.
−
|+Table {{AUTOTABLENUM}}: Fixed informant.typeCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#INF INF]||informant
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 
−
|}
 
  
−
'''informant.contextControlCode'''
+
====<big>&lt;caption></big>====
  
−
The informant.contextControlCode is fixed to "OP". It means that the informant will replace the set of informant participations that have propagated from ancestor Acts, and will itself be the only informant to propagate to any child Acts that allow context to be propagated.
+
The CDA &lt;caption> is a label for a paragraph, list, list item, table, or table cell. It can also be used within the <renderMultiMedia> element to indicate a label for referenced ObservationMedia and RegionOfInterest entries. A &lt;caption> contains plain text and may contain links and footnotes.
  
−
{| class='wikitable' 
+
====<big>styleCode attribute</big>====
−
|+Table {{AUTOTABLENUM}}: Fixed informant.contextControlCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||overriding, propagating
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057</small>
 
−
|}
 
  
−
An informant can be a person in one of two roles RelatedEntity or AssignedEntity.
+
The styleCode attribute is used within the CDA Narrative Block to give the instance author the ability to suggest rendering characteristics of the nested character data. Receivers are not required to render documents using the style hints provided and can present stylized text in accordance with their local style conventions.
−
=====RelatedEntity=====
 
  
−
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 value set is drawn from the HL7 styleType vocabulary domain, and has a CWE coding strength.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: RelatedEntity
+
|+Table {{AUTOTABLENUM}}: Value set for styleCode (CWE)
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!Code!!Definition
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#_RoleClassMutualRelationship v:RoleClassMutualRelationship]||Closed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#PersonalRelationshipRoleType D:PersonalRelationshipRoleType ]|| Open
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att  addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||
+
|colspan="2"|Font style (Defines font rendering characteristics.)
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att  telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||
+
|Bold||Render with a bold font.
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]|| ||
+
|Underline||Render with an underlines font.
−
|}
 
−
 
 
−
'''RelatedEntity.classCode'''
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Value set for RelatedEntity.classCode
 
−
! style="text-align:left;"  colspan="5" |  v:RoleClassMutualRelationship  <small>[2.16.840.1.113883.1.11.19316] (CLOSED) </small>
 
 
|-
 
|-
−
!Code!!Display Name!! !!Code!!Display Name
+
|Italics||Render italicized.
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#AFFL AFFL] ||affiliate||
+
|Emphasis||Render with some type of emphasis.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#AGNT AGNT]||agent
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED] ||assigned entity||
+
|colspan="2"|Table rule style (Defines table cell rendering characteristics.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#COMPAR COMPAR]||commissioning party
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SGNOFF SGNOFF] ||signing authority or officer||
+
|Lrule||Render cell with left-sided rule.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CON CON]||contact
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ECON ECON] ||emergency contact||
+
|Rrule||Render cell with right-sided rule.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#NOK NOK]||next of kin
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#GUARD GUARD] ||guardian||
+
|Toprule||Render cell with rule on top.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CIT CIT]||citizen
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#COVPTY COVPTY] ||covered party||
+
|Botrule||Render cell with rule on bottom.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CLAIM CLAIM]||claimant
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#NAMED NAMED] ||named insured||
+
|colspan="2"|Ordered list style (Defines rendering characteristics for ordered lists.)
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#DEPEN DEPEN]||dependent
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#INDIV INDIV] ||individual||
+
|Arabic||List is ordered using Arabic numerals: 1, 2, 3.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#SUBSCR SUBSCR]||subscriber
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PROG PROG] ||program eligible||
+
|LittleRoman||List is ordered using little Roman numerals: i, ii, iii.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CRINV CRINV]||clinical research investigator
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CRSPNSR CRSPNSR] ||clinical research sponsor||
+
|BigRoman||List is ordered using big Roman numerals: I, II, III.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#EMP EMP]||employee
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#MIL MIL] ||military person||
+
|LittleAlpha||List is ordered using little alpha characters: a, b, c.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#GUAR GUAR]||guarantor, GuarantorRole
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#INVSBJ INVSBJ] ||Investigation Subject||
+
|BigAlpha||List is ordered using big alpha characters: A, B, C.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CASEBJ CASEBJ]||Case Subject
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#RESBJ RESBJ] ||research subject||
+
|colspan="2"|Unordered list style (Defines rendering characteristics for unordered lists.)
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#LIC LIC]||licensed entity
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#NOT NOT] ||notary public||
+
|Disc||List bullets are simple solid discs.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PROV PROV]||healthcare provider
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PAT PAT] ||patient||
+
|Circle||List bullets are hollow discs.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PAYEE PAYEE]||payee
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PAYOR PAYOR] ||invoice payor||
+
|Square||List bullets are solid squares.
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#POLHOLD POLHOLD]||policy holder
+
|}
−
|-
+
 
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#QUAL QUAL] ||qualified entity||
+
Local extensions to the styleType vocabulary domain must follow the following convention: [x][A-Za-z][A-Za-z0-9]* (first character is "x", second character is an upper or lower case A-Z, remaining characters are any combination of upper and lower case letters or numbers).
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#SPNSR SPNSR]||coverage sponsor
+
 
−
|-
+
The styleCode attribute can contain multiple values, separated by white space. Where an element containing a styleCode attribute is nested within another element containing a styleCode attribute, the style effects are additive, as in the following example:
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#STD STD] ||student||
 
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#UNDWRT UNDWRT]||underwriter
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CAREGIVER CAREGIVER] ||caregiver||
 
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PRS PRS]||personal relationship
 
−
|-
 
−
!style="text-align:left;" colspan="5" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
 
−
|}
 
−
 
 
−
'''RelatedEntity.code'''
 
−
 
 
−
The RelatedEntity.code is bound to the PersonalRelationshipRoleType concept domain.
 
−
 
 
−
'''RelatedEntity.addr'''
 
  
−
The RelatedEntity.addr is used to convey the postal address for the informant.
+
<div align="center">Example {{AUTOEXAMPLENUM}}</div>
 +
<nowiki>
 +
<section>
 +
  <text><content styleCode="Bold">This is rendered bold,
 +
    <content styleCode="Italics">this is rendered bold and
 +
    italicized,</content> this is rendered bold. </content>
 +
    <content styleCode="Bold Italics">This is also rendered
 +
    bold and italicized.</content>
 +
  </text>
 +
</section>
 +
</nowiki>
  
−
'''RelatedEntity.telecom'''
+
====<big>Referencing in and out of the narrative block</big>====
  
−
The RelatedEntity.telecom is used to convey the phone number for the informant.
+
NOTE: See [[#entry|entry]] for a discussion of the relationships between a section and its contained entries.
  
−
'''RelatedEntity.effectiveTime'''
+
To summarize the mechanisms for referencing in and out of the CDA Narrative Block:
  
−
The RelatedEntity.effectiveTime is used to convey the time period that the role is/was in effect.
+
CDA entries can point in to the <content> element of the CDA Narrative Block (see [[#.3Ccontent.3E|<content>]]).
  
−
=====AssignedEntity=====
+
The <linkHtml> element of the CDA Narrative Block can reference targets that are either internal or external to the document (see [[#.3ClinkHtml.3E|<linkHtml>]]).
  
−
The AssignedEntity role is used for an identified informant, and is scoped by an Organization.  
+
The <footnoteRef> element of the CDA Narrative Block can reference a <footnote> element in the same or different CDA Narrative Block of the same document (see [[#.3Cfootnote.3E_and_.3CfootnoteRef.3E|<footnote> and <footnoteRef>]]).
  
−
Refer to [[#div-AssignedEntity|AssignedEntity]] as defined for authenticator participation.
+
The <renderMultiMedia> element of the CDA Narrative Block can point out to CDA ObservationMedia and RegionOfInterest entries of the same document (see [[#.3CrenderMultiMedia.3E|<renderMultiMedia>]]).
  
−
====<big>informationRecipient</big>====
+
===<big>Entry Acts</big>===
  
 +
CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries.
  
−
[[Image:InformationRecipient.png|600px|border|center|informationRecipient]]
+
Clinical documents contain a wide breadth of content, requiring much of the RIM to enable a full and complete encoding. The current set of CDA entries have been developed in response to identified requirements and scenarios that are in CDA's scope. Rather than creating specific entries for each scenario, similar requirements are merged to create broader entries, which can then be constrained within a particular realm or implementation. This approach is consistent with the approach taken by CEN, DICOM, and OpenEHR.
  
 +
The model for CDA entries is derived from the shared HL7 Clinical Statement model, which is a collaborative project between several committees striving to provide a consistent representation of clinical observations and acts across various V3 specifications.
  
−
Represents a recipient who should receive a copy of the document.
+
====<big><big>Act</big></big>====
 +
[[Image:Act.png|500px|border|center|Act]]
  
−
:'''NOTE:''' The information recipient is an entity to whom a copy of a document is directed, at the time of document authorship. It is not the same as the cumulative set of persons to whom the document has subsequently been disclosed, over the life-time of the patient. Such a disclosure list would not be contained within the document, and it outside the scope of CDA.  
+
A derivative of the RIM Act class, to be used when the other classes present in the CDA Clinical Statement choice pattern are not appropriate.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: informationRecipient
+
|+Table {{AUTOTABLENUM}}: Act Attributes
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActClass.htm#x_ActClassDocumentEntryAct V:x_ActClassDocumentEntryAct]||Closed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActMood.htm#x_DocumentActMood V:x_DocumentActMood]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ParticipationType.htm#x_InformationRecipient  V:x_InformationRecipient]||Closed
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
−
|}
+
|- 
−
 
+
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
−
 
 
−
'''informationRecipient.typeCode'''
 
−
 
 
−
Two values are available for the informationRecipient.typeCode, the default value is primary information recipient an alternative value is tracker.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Value set for informationRecipient.typeCode
 
−
! style="text-align:left;"  colspan="5" | v:x_InformationRecipient <small>[2.16.840.1.113883.1.11.19366] (CLOSED) </small>
 
 
|-
 
|-
−
!Code!!Display Name!! !!Code!!Display Name
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-actionNegationInd-att  actonNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRCP PRCP] ('''Default''')||primary information recipient||
+
|[http://cda/infrastructure/rim/rim.htm#Act-negationInd-att negationInd] ('''Deprecated''')||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#TRC TRC]||tracker
 
 
|-
 
|-
−
!style="text-align:left;"  colspan="5" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
−
|}
 
−
 
 
−
=====IntendedRecipient=====
 
−
 
 
−
Identifies the person(s), organization or health chart to receive the document.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: IntendedRecipient
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_RoleClass.htm#x_InformationRecipientRole V:x_InformationRecipientRole]||Closed
+
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActStatus.htm#ActStatus V:ActStatus]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-id-att id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[1..*]|| ||  
+
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||  
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-activityTime-att activityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||  
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-availabilityTime-att availabilityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]||||
−
|}
+
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-priorityCode-att priorityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority D:ActPriority]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality D:Confidentiality]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-uncertaintyCode-att uncertaintyCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActUncertainty D:ActUncertainty]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Observation-reasonCode-att reasonCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActReason D:ActReason]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
 +
|}
  
−
'''IntendedRecipient.classCode'''
+
'''Act.classCode'''
  
−
Where a person is the intended recipient (IntendedRecipient class), the IntendedRecipient.classCode is valued with "ASSIGNED", and the playing entity is a person (Person class), optionally scoped by an organization (Organization class). Where the intended recipient is an organization, the IntendedRecipient.classCode is valued with "ASSIGNED", and the recipient is reflected by the presence of a scoping Organization, without a playing entity. Where a health chart is the intended recipient, the IntendedRecipient.classCode is valued with "HLTHCHRT" (health chart). In this case there is no playing entity, and an optional scoping organization (Organization class).  
+
The major class of Acts to which an Act-instance belongs.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Value set for IntendedRecipient.classCode
+
|+Table {{AUTOTABLENUM}}: Value set for Act.classCode
−
! style="text-align:left;"  colspan="5" |  V:x_InformationRecipientRole <small>[2.16.840.1.113883.1.11.16772] (CLOSED) </small>
+
! style="text-align:left;"  colspan="5" |  x_ActClassDocumentEntryAct <small>[2.16.840.1.113883.1.11.19599] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACT ACT]||Act||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ACCM ACCM]||accommodation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONS CONS]||consent||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#CTTEVENT CTTEVENT]||clinical trial timepoint event
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#INC INC]||incident||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#INFRM INFRM]||inform
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PCPR PCPR]||care provision||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#REG REG]||registration
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPCTRT SPCTRT]||specimen treatment||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRNS TRNS]||transportation
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#ACSN ACSN]</span>||accession||  ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#CONTREG CONTREG]</span>||container registration
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#DISPACT DISPACT]</span>||disciplinary action||  ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#EXPOS EXPOS]</span>||exposure
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#AEXPOS AEXPOS]</span>||acquisition exposure||  ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#TEXPOS TEXPOS]</span>||transmission exposure
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#LIST LIST]</span>||working list||  ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#MPROT MPROT]</span>||monitoring program
 
|-
 
|-
−
!Code!!Display Name!! !!Code!!Display Name
+
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#REV REV]</span>||review||  ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#STORE STORE]</span>||storage
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED] ('''Default''')||assigned entity||  
+
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActClass.htm#TRFR TRFR]</span>||transfer|| || ||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#HLTHCHRT HLTHCHRT]||health chart
 
 
|-
 
|-
−
!style="text-align:left;"  colspan="5" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
|}
 
|}
  
 +
'''Act.moodCode'''
  
−
'''IntendedRecipient.id'''
+
The intended use of the Act statement: as a report of fact, a command, a possibility, a goal, etc. Since the mood code is a determining factor for the meaning of an entire Act object, the mood must always be known. This means that whenever an act object is instantiated, the mood attribute SHALL be assigned to a valid code, and the mood assignment SHALL NOT change throughout the lifetime of the act object.
  
−
Optional identifier of the intended recipient.
+
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Act.moodCode
 +
! style="text-align:left;"  colspan="5" | V:x_DocumentActMood <small>[2.16.840.1.113883.1.11.19458] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#APT APT]</span>||appointment||  ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#ARQ ARQ]</span>||appointment request
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event|| ||[http://cda/infrastructure/vocabulary/ActMood.htm#DEF DEF]||definition
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#RQO RQO]||request||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#INT INT]||intent
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#PRMS PRMS]||promise||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#PRP PRP]||proposal
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#RSK RSK]</span>||risk||  ||  ||
 +
|-
 +
!style="text-align:left;"  colspan="5" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 +
|}
  
−
'''IntendedRecipient.addr'''
+
'''Act.id'''
  
−
Optional postal address of the intended recipient.
+
A unique identifier for the Act.  
  
−
'''IntendedRecipient.telecom'''
+
'''Act.code'''
  
−
Optional phone number for the intended recipient.
+
The particular kind of Act that the Act-instance represents within its class. Act.code, if used, SHALL be a specialization of the Act.classCode. This attribute defines a specific sub-type of a given Act type (determined by the "classCode" attribute). It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the limited set of Act types defined by "classCode." The Act.code is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActCode ActCode] concept domain.
  
−
=====Person=====
+
'''<span class="change-highlight">Act.actionNegationInd</span>'''
  
−
Refer to [[#div-person|Person]] as defined for Author participation.
+
<span class="change-highlight">The Act.actionNegationInd works as a negative existence quantifier on the actual, intended or described Act event. In Event mood, it indicates the defined act did not occur. In Intent mood, it indicates the defined act is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.  
  
−
=====Organization=====
+
The actionNegationInd negates the Act as described by the descriptive properties which are:  classCode, code, statusCode, effectiveTime, activityTime, priorityCode, reasonCode and any of their components.
  
−
Refer to [[#div-organization|organization]] as defined for authenticator participation.
+
The remaining properties represent the document characteristics, E.g. Act.id, Act.moodCode, Act.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.  
 +
</span>
  
−
====<big>legalAuthenticator</big>====
+
'''Act.negationInd'''
  
−
Represents the participant(s) who has legally authenticated the document.
+
<span class="change-highlight">Act.negationInd, <b><i>is deprecated in RIM 2.35</i></b>, and CDA R2.1 retains it for backwards compatibility.  CDA R2.1 compliant implementation guides should use actionNegationInd moving forward.</span>
  
−
[[Image:Authenicator.png|800px|border|center|authenicator]]
+
'''Act.text'''
  
−
<span class="change-highlight">CDA R2.1, now supports [0..*] legal authentications. This enhancement was put into CDA to support the sharing of medical documents needing to take more than one legal authentication signature.</span>
+
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Act. The Act.text attribute can reference  the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.
  
−
The CDA is a standard that specifies the structure of exchanged clinical documents. In the case where a local document is transformed into a CDA document for exchange, authentication occurs on the local document, and that fact is reflected in the exchanged CDA document. A CDA document can reflect the unauthenticated, authenticated, or legally authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being either authenticated or legally authenticated).
+
'''Act.statusCode'''
  
−
Both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.  
+
The status reflects the state of the activity.   The RIM based [http://cda/infrastructure/rim/rim.htm#ActStatus  state machine diagram] depicts the allowable state transitions that an Act.StatusCodes can take on.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: legalAuthenticator[0..*]
+
|+Table {{AUTOTABLENUM}}: Value set for Act.statusCode
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
! style="text-align:left;"  colspan="5" | V:ActStatus <small>[2.16.840.1.113883.1.11.15933] (CLOSED) </small>
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#LA LA]||Fixed
+
!Code!!Display Name!! !!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#normal normal]||normal|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#aborted aborted]||aborted
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att  time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[1..1]||||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#active active]||active|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#cancelled cancelled]||cancelled
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att signatureCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CV CV]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationSignature.htm S]||Fixed
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#completed completed]||completed|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#held held]||held
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-signatureText-att  signatureText]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED] ||[0..1]||||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#new new]||new|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#suspended suspended]||suspended
−
|}
 
−
 
 
−
'''legalAuthenticator.typeCode'''
 
−
 
 
−
The ClinicalDocument.typeCode is fixed to "LA" to indicate that a participant has legally attested his participation through a signature.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed legalAuthenticator.typeCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUTHEN AUTHEN]||authenticator
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#nullified nullified]||nullified|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#obsolete obsolete]||obsolete
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14</small>
 
|}
 
|}
  
−
'''legalAuthenticator.contextControlCode'''
+
'''Act.effectiveTime'''
−
 
 
−
 
 
−
The legalAuthenticator.contextControlCode is fixed to "OP". It means that the legalAuthenticator will  propagate to any child Acts that allow context to be propagated.
 
−
 
 
−
'''legalAuthenticator.time'''
 
−
 
 
−
legalAuthenticatorhas a required legalAuthenticator.time indicating the time of authentication.
 
  
−
'''legalAuthenticator.signatureCode'''
+
Act.effectiveTime is used to indicate the clinically or operationally relevant time of an act, exclusive of administrative activity.  
  
−
legalAuthenticatorhas a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.
+
'''<span class="change-highlight">Act.activityTime</span>'''
  
−
{| class='wikitable' 
+
<span class="change-highlight">Act.activityTime is a time expression specifying when an act occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the act occurred, is supposed to occur, is scheduled to occur, etc. </span>
−
|+Table {{AUTOTABLENUM}}: Fixed legalAuthenticator.signatureCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ParticipationSignature.htm S] ('''Fixed''')||signed
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System: ParticipationSignature (HL7) Code System OID: 2.16.840.1.113883.5.89</small>
 
−
|}
 
  
−
'''Note''': CDA Release One represented either an intended ("X") or actual ("S") legalAuthenticator.  CDA Release 2 and 2.1 only represents an actual legalAuthenticator, so only S / Signed can be indicated for the signatureCode.
+
'''<span class="change-highlight">Act.availabilityTime</span>'''
  
−
'''legalAuthenticator.signatureText'''
+
<span class="change-highlight">Act.availabilityTime is the point in time at which information about an act instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the act itself.</span>
  
−
A new attribute, SignatureText has been added to legalAuthenticator. The signature can be represented either inline or by reference according to the ED data type. Typical cases are:
+
'''Act.priorityCode'''
  
−
# Paper-based signatures: the ED data type may refer to a document or other resource that can be retrieved through an electronic interface to a hardcopy archive.  
+
The urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Act.priorityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority ActPriority] concept domain.
−
# Electronic signature: this attribute can represent virtually any electronic signature scheme.
 
−
# Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.
 
  
−
{| class='wikitable'
+
'''<span class="change-highlight">Act.confidentialityCode</span>'''
−
|+Table {{AUTOTABLENUM}}: Fixed legalAuthenticator.contextControlCode
 
−
|-
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||overriding, propagating
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057</small>
 
−
|}
 
  
−
A legalAuthenticator is a person in the role of an assigned entity (AssignedEntity class). An assigned entity is a person assigned to the role by the scoping organization. The entity playing the role is a person (Person class). The entity scoping the role is an organization (Organization class).
+
<span class="change-highlight">Constraints around appropriate disclosure of information about this Act, regardless of mood. The Act.confidentialityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality Confidentiality] concept domain.</span>
  
−
=====AssignedEntity=====
+
'''<span class="change-highlight">Act.uncertaintyCode</span>'''
  
−
Refer to [[#div-AssignedEntity|AssignedEntity]] as defined for authenticator participation.
+
<span class="change-highlight">An indication that the Act statement as a whole, with its subordinate components has been asserted to be uncertain in some way. The use of the uncertaintyCode is appropriate only if the entirety of the Act and its dependent Acts is questioned. The Act.uncertaintyCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActUncertainty ActUncertainty] concept domain.</span>
  
−
=====Person=====
+
'''<span class="change-highlight">Act.reasonCode</span>'''
  
−
Refer to [[#div-person|Person]] as defined for Author participation.
+
<span class="change-highlight">The motivation, cause, or rationale of an Act, when such rationale is not reasonably represented as an ActRelationship of type "has reason" linking to another Act.  The Act.reasonCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActReason ActReason] concept domain.</span>
  
−
=====Organization=====
+
<span class="change-highlight">Most reasons for acts can be clearly expressed by linking the new Act to another prior Act record using an ActRelationship of type "has reason." This simply states that the prior Act is a reason for the new Act (see ActRelationship). The prior act can then be a specific existing act or a textual explanation. This works for most cases, and the more specific the reason data is, the more should this reason ActRelationship be used instead of the reasonCode.</span>
  
−
Refer to [[#div-Organization|Organization]] as defined for authenticator participation.
+
<span class="change-highlight">The reasonCode remains as a place for common reasons that are not related to a prior Act or any other condition expressed in Acts. Indicators that something was required by law or was on the request of a patient may qualify. However, if that piece of legislation, regulation, or the contract or the patient request can be represented as an Act (and they usually can), such a representation is preferable to the reasonCode.</span>
  
−
=====OrganizationPartOf=====
+
'''Act.languageCode'''
  
−
Refer to [[#div-OrganizationPartOf|OrganizationPartOf]] as defined for authenticator participation.
+
The primary language in which this Act statement is specified, particularly the language of the Act.text.  The Act.languageCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage HumanLanguage] concept domain.
  
−
====<big>participant</big>====
+
====<big><big>Encounter</big></big>====
 +
A derivative of the RIM PatientEncounter class, used to represent related encounters, such as follow-up visits or referenced past encounters.
  
−
[[Image:Participant.png|800px|border|center|participant]]
+
:'''NOTE:''' The EncompassingEncounter class in the CDA Header (see [[#Header_Relationships|Header Relationships]]) represents the setting of the clinical encounter during which the documented act occurred. The Encounter class in the CDA Body is used to represent other related encounters.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: participant
+
|+Table {{AUTOTABLENUM}}: Encounter Attributes
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm ParticipationType]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#ENC ENC] ||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-functionCode-att functionCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ParticipationFunction D:ParticipationFunction]|| Open
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActMood.htm#x_DocumentEncounterMood V:x_DocumentEncounterMood]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
 +
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[1..1]||||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-actionNegationInd-att actonNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
|}
 
−
 
 
−
'''participant.typeCode'''
 
−
 
 
−
The participant.typeCode is can be any code defined in the ParticipationType domain. Which can be used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Value set for participant.typeCode
 
−
! style="text-align:left;"  colspan="5" | v:ParticipationType <small>[2.16.840.1.113883.1.11.10901] (CLOSED)</small>
 
 
|-
 
|-
−
!Code!!Display Name!! !!Code!!Display Name
+
|[http://cda/infrastructure/rim/rim.htm#Act-negationInd-att negationInd] ('''Deprecated''')||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PART PART]||Participation||
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ADM ADM]||admitter
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#ATND ATND]||attender||
+
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActStatus.htm#ActStatus V:ActStatus]||Closed
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ADM ADM]||admitter
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CALLBCK CALLBCK]|| callback contact ||
+
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#CON CON]||consultant
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#DIS DIS]||discharger||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-activityTime-att activityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ESC ESC]||escort
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#REF REF]||referrer||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-availabilityTime-att availabilityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#TRANS TRANS]||Transcriber
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#ENT ENT]||data entry person||
+
|[http://cda/infrastructure/rim/rim.htm#Act-priorityCode-att priorityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority D:ActPriority]||Open
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#WIT WIT]||witness
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CST CST]||custodian||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality D:Confidentiality]||Open
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#DIR DIR]||direct target
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#BBY BBY]||baby||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-uncertaintyCode-att uncertaintyCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActUncertainty D:ActUncertainty]||Open
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#DEV DEV]||device
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#NRD NRD]||non-reuseable device||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Observation-reasonCode-att reasonCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActReason D:ActReason]||Open
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#RDV RDV]||reusable device
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#EXPAGNT EXPAGNT]||ExposureAgent||
+
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#EXPART EXPART]||ExposureParticipation
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#EXPTRGT EXPTRGT]||ExposureTarget||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Encounter-admissionReferralSourceCode-att admissionReferralSourceCode]</span>||<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EncounterReferralSource D:EncounterReferralSource]||Open
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#EXSRC EXSRC]||ExposureSource
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#IND IND]||indirect target||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Encounter-lengthOfStayQuantity-att lengthOfStayQuantity]</span>||<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ]>.TIME||[0..1]||  ||
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#BEN BEN]||beneficiary
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CAGNT CAGNT]||causative agent||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Encounter-dischargeDispositionCode-att dischargeDispositionCode]</span>||<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EncounterDischargeDisposition D:EncounterDischargeDisposition]||Open
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#COV COV]||coverage target
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#GUAR GUAR]||guarantor party||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Encounter-preAdmitTestInd-att  preAdmitTestInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#HLD HLD]||holder
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#DON DON]||donor||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Encounter-specialCourtesiesCode-att specialCourtesiesCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EncounterSpecialCourtesy D:EncounterSpecialCourtesy]||Open
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#RCV RCV]||receiver
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#IRCP IRCP]||information recipient||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Encounter-specialArrangementCode-att specialArrangementCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#SpecialArrangement D:SpecialArrangement]||Open
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#NOT NOT]||ugent notification contact
+
|}
 +
 
 +
'''Encounter.classCode'''
 +
 
 +
The Encounter.classCode is fixed to "ENC" to represent an encounter. The encounter class is used to represent an interaction between a patient and healthcare participant(s) for the purpose of providing patient service(s) or assessing the health status of a patient.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Encounter.classCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRCP PRCP]||primary information recipient||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#ENC ENC] ('''Fixed''')||encounter
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#REFB REFB]||Referred By
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#REFT REFT]||Referred to||
+
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#TRC TRC]||tracker
+
|}
 +
 
 +
'''Encounter.moodCode'''
 +
 
 +
The Encounter.moodCode is bound to the x_DocumentEncounterMood value set. This enables to the modeling of both past, present and planned future encounters.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Encounter.moodCode
 +
! style="text-align:left;"  colspan="5" | V:x_DocumentEncounterMood <small>[2.16.840.1.113883.1.11.19459] (CLOSED) </small>
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#LOC LOC]||location||
+
!Code!!Display Name!!  !!Code!!Display Name
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#DST DST]||destination
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#ELOC ELOC]||entry location||
+
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#APT APT]</span>||appointment|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#ARQ ARQ]</span>||appointment request
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ORG ORG]||origin
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#RML RML]||remote||
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#DEF DEF]</span>||definition
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#VIA VIA]||via
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#RESP RESP]||responsible party||
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#RQO RQO]||request|| ||[http://cda/infrastructure/vocabulary/ActMood.htm#INT INT]||intent
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#VRF VRF]||verifier
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUTHEN AUTHEN]||authenticator||
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#PRMS PRMS]||promise|| ||[http://cda/infrastructure/vocabulary/ActMood.htm#PRP PRP]||proposal
−
|| ||
 
 
|-
 
|-
−
!colspan="5" |Use the following participations, only if the other participations provided in CDA will not work
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 +
|}
 +
 
 +
'''Encounter.id'''
 +
 
 +
The optional Encounter.id can be used to uniquely identify the encounter.
 +
 
 +
'''Encounter.code'''
 +
 
 +
The optional Encounter.code is bound to the ActEncounterCode value set.
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for EncompassingEncounter.code
 +
! style="text-align:left;"  colspan="5" | V:ActEncounterCode <small> [2.16.840.1.113883.1.11.13955] (OPEN)</small>
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#RCT RCT]||record target||
+
!Code!!Display Name!!  !!Code!!Display Name
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUT AUT]||author (originator)
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#INF INF]||informant||
+
|[http://cda/infrastructure/vocabulary/ActCode.htm#AMB AMB]||ambulatory|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#EMER EMER]||emergency
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#CSM CSM]||consumable
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRD PRD]||product||
+
|[http://cda/infrastructure/vocabulary/ActCode.htm#FLD FLD]||field|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#HH HH]||home health
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#SBJ SBJ]||subject
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#SPC SPC]||specimen||
+
|[http://cda/infrastructure/vocabulary/ActCode.htm#IMP IMP]||inpatient encounter|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#ACUTE ACUTE]||inpatient acute
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRF PRF]||performer
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#DIST DIST]||distributor||
+
|[http://cda/infrastructure/vocabulary/ActCode.htm#NONAC NONAC]||virtual|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#SS SS]||short stay
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#PPRF PPRF]||primary performer
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#SPRF SPRF]||secondary performer||
+
|[http://cda/infrastructure/vocabulary/ActCode.htm#VR VR]||inpatient non-acute|| || ||
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#LA LA]||legal authenticator
 
 
|-
 
|-
−
!style="text-align:left;"  colspan="5" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
+
!style="text-align:left;"  colspan="5" | <small> Code System: ActCode (HL7) Code System OID: 2.16.840.1.113883.5.4</small>
 
|}
 
|}
  
−
'''participant.functionCode'''
+
'''<span class="change-highlight">Encounter.actionNegationInd</span>'''
 +
 
 +
<span class="change-highlight">The Encounter.actionNegationInd works as a negative existence quantifier on the actual, intended or described Encounter event. In Event mood, it indicates the defined encounter did not occur. In Intent mood, it indicates the defined encounter is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.
 +
 
 +
The actionNegationInd negates the Encounter as described by the descriptive properties which are:  classCode, code, statusCode, effectiveTime, activityTime, priorityCode, reasonCode, admissionReferralSourceCode, lengthOfStayQuantity, dischargeDispositionCode, preAdmitTestInd, specialCourtesiesCode, specialArrangementCode and any of their components.
 +
 
 +
The remaining properties represent the document characteristics, E.g. Encounter.id, Encounter.moodCode, Encounter.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative encounter. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance. </span>
  
−
The participant.functionCode is bound to the concept domain ParticipationFunction, which is used to specify the exact function an actor had in a service in all necessary detail. This domain may include local extensions (Open).  
+
'''Encounter.text'''
  
−
'''participant.contextControlCode'''
+
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Encounter. The Encounter.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.  
  
−
The participant.contextControlCode is fixed to "OP". It means that the participantType code specified in participant.typeCode will replace the set of author participations that have propagated from ancestor Acts, and will itself be the only author to propagate to any child Acts that allow context to be propagated. 
+
'''Encounter.statusCode'''
  
−
{| class='wikitable' 
+
The status reflects the state of the Encounter. The RIM based state machine diagram depicts the allowable state transitions that an Encounter.statusCode can take on.  
−
|+Table {{AUTOTABLENUM}}: Fixed participant.contextControlCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP] ('''Fixed''')||overriding, propagating
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System:  ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057</small>
 
−
|}
 
  
−
'''participant.typeCode.time'''
+
'''Encounter.effectiveTime'''
  
−
The participant.typeCode.time is the date and time the specific participation occurred.
+
For Encounters, the effectiveTime is the "administrative" time, i.e., the encounter start and end date as established by business rules.  For inpatient encounters, the effectiveTime/low value is the admission date and time and the effectiveTime/high value is the discharge date and time. Note: If the encounter is still active at the time of document creation, the effectiveTime/high element can be omitted to indicate the encounter is on-going.  
  
−
=====AssociatedEntity=====
+
'''<span class="change-highlight">Encounter.activityTime</span>'''
  
−
A participant is a person or organization in the role of a participating entity (AssociatedEntity class). The entity playing the role is a person (Person class). The entity scoping the role is an organization (Organization class).
+
<span class="change-highlight">Encounter.activityTime is a time expression specifying when an Encounter occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the Encounter occurred, is supposed to occur, is scheduled to occur, etc.</span>
  
−
{| class='wikitable'
+
'''<span class="change-highlight">Encounter.availabilityTime</span>'''
−
|+Table {{AUTOTABLENUM}}: AssociatedEntity
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_RoleClass.htm#RoleClassAssociative V:RoleClassAssociative]||Closed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-id-att  id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#RoleCode D:RoleCode]|| Open
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att  addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att  telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||
 
−
|}
 
  
−
'''AssociatedEntity.classCode'''
+
<span class="change-highlight">Encounter.availabilityTime is the point in time at which information about an Encounter instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the Encounter itself.</span>
  
−
When the participating entity is an organization, this is reflected by the presence of a scoping Organization, without a playing entity. Otherwise, the participating entity is considered a person with or without a scoping Organization.  
+
'''Encounter.priorityCode'''
  
−
{| class='wikitable'
+
The urgency under which the Encounter happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Encounter.priorityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority ActPriority] concept domain.
−
|+Table {{AUTOTABLENUM}}: Value set for ParticipatingEntity.classCode 
+
 
−
! style="text-align:left;" colspan="5" | V:RoleClassAssociative <small>[2.16.840.1.113883.1.11.19313] (CLOSED) </small>
+
'''<span class="change-highlight">Encounter.confidentialityCode</span>'''
−
|-
+
 
−
!Code!!Display Name!! !!Code!!Display Name
+
<span class="change-highlight">Constraints around appropriate disclosure of information about this Encounter, regardless of mood. The Encounter.confidentialityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality Confidentiality] concept domain.</span>
 +
 
 +
'''<span class="change-highlight">Encounter.reasonCode</span>'''
 +
 
 +
<span class="change-highlight">The motivation, cause, or rationale of an Encounter, when such rationale is not reasonably represented as an ActRelationship of type "has reason" linking to another Act. The Encounter.reasonCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActReason ActReason] concept domain.</span>
 +
 
 +
'''Encounter.languageCode'''
 +
 
 +
The primary language in which this Encounter statement is specified, particularly the language of the Encounter.text.  The Encounter.languageCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage HumanLanguage] concept domain.
 +
 
 +
'''<span class="change-highlight">Encounter.admissionReferralSourceCode</span>'''
 +
 
 +
<span class="change-highlight">The optional EncompassingEncounter.admissionReferralSourceCode can be use to depict the type of place or organization responsible for the patient's care immediately prior to a patient encounter.</span>
 +
 
 +
'''<span class="change-highlight">Encounter.lengthOfStayQuantity</span>'''
 +
 
 +
<span class="change-highlight">The total quantity of time when the subject is expected to be or was resident at a facility as part of an encounter. Note, the actual days quantity cannot be simply calculated from the admission and discharge dates because of possible leaves of absence.</span>
 +
 
 +
'''<span class="change-highlight">Encounter.dischargeDispositionCode</span>'''
 +
 
 +
<span class="change-highlight">The optional EncompassingEncounter.dischargeDispositionCode can be used to depict the disposition of the patient at the time of hospital discharge (e.g., discharged to home, expired, against medical advice, etc.).</span>
 +
 
 +
'''<span class="change-highlight">Encounter.preAdmitTestInd</span>'''
 +
 
 +
<span class="change-highlight">An indication that pre-admission tests are required for this patient encounter.</span>
 +
 
 +
'''<span class="change-highlight">Encounter.specialCourtesiesCode</span>'''
 +
 
 +
<span class="change-highlight">Extraordinary considerations or services provided within the context of the Patient Encounter. Examples include: Professional courtesy, VIP courtesies, no courtesies</span>
 +
 
 +
'''<span class="change-highlight">Encounter.specialArrangementCode</span>'''
 +
 
 +
<span class="change-highlight">Extraordinary provisions required in the context of the patient encounter. For encounters in intention moods, this information can be used to identify special arrangements that will need to be made for the incoming patient.</span>
 +
 
 +
====<big><big>Observation</big></big>====
 +
 
 +
A derivative of the [http://cda/infrastructure/rim/rim.htm#Observation-clsObservation Observation(§ RIM 5.36)] class, it is intended to result in new information about a subject. The main difference between Observations and other Acts is that Observations have a value attribute. The code attribute of Observation and the value attribute of Observation must be considered in combination to determine the semantics of the observation.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Observation Attributes
 +
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ROL ROL] ('''Default''')||role||
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]|| <= OBS"  is [http://cda/infrastructure/vocabulary/vs_ActClass.htm#ActClassObservation V:ActClassObservation]   ||Closed
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#AFFL AFFL]||affiliate
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#AGNT AGNT]||agent||
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActMood.htm#x_ActMoodDocumentObservation V:x_ActMoodDocumentObservation]||Closed
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED]||assigned entity
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#COMPAR COMPAR]||commissioning party||
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#SGNOFF SGNOFF]||signing authority or officer
+
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ObservationType D:ObservationType]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CON CON]||contact||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-actionNegationInd-att  actionNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ECON ECON]||emergency contact
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#NOK NOK]||next of kin||
+
|[http://cda/infrastructure/rim/rim.htm#Act-negationInd-att negationInd] ('''Deprecated''')||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#GUARD GUARD]||guardian
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CIT CIT]||citizen||
+
|[http://cda/infrastructure/rim/rim.htm#Act-derivationExpr-att derivationExpr]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ST ST]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#COVPTY COVPTY]||covered party
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CLAIM CLAIM]||claimant||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-title-att title]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#NAMED NAMED]||named insured
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#DEPEN DEPEN]||dependent||
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#INDIV INDIV]||individual
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SUBSCR SUBSCR]||subscriber||
+
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActStatus.htm#ActStatus V:ActStatus]||Closed
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PROG PROG]||program eligible
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CRINV CRINV]||clinical research investigator||
+
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CRSPNSR CRSPNSR]||clinical research sponsor
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#EMP EMP]||employee||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-activityTime-att activityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#MIL MIL]||military person
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#GUAR GUAR]||guarantor||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-availabilityTime-att availabilityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#INVSBJ INVSBJ]||Investigation Subject
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CASEBJ CASEBJ]||Case Subject||
+
|[http://cda/infrastructure/rim/rim.htm#Act-priorityCode-att priorityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority D:ActPriority]||Open
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#RESBJ RESBJ]||research subject
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#LIC LIC]||licensed entity||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality D:Confidentiality]||Open
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#NOT NOT]||notary public
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PROV PROV]||healthcare provider||
+
|[http://cda/infrastructure/rim/rim.htm#Act-repeatNumber-att repeatNumber]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-INT INT]>||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PAT PAT]||patient
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PAYEE PAYEE]||payee||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-uncertaintyCode-att uncertaintyCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActUncertainty D:ActUncertainty]||Open
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PAYOR PAYOR]||invoice payor
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#POLHOLD POLHOLD]||policy holder||
+
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#QUAL QUAL]||qualified entity
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SPNSR SPNSR]||underwriter||
+
|[http://cda/infrastructure/rim/rim.html#Act-isCriterionInd-att isCriterionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#STD STD]||student
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#UNDWRT UNDWRT]||coverage sponsor||
+
|[http://cda/infrastructure/rim/rim.html#Observation-value-att value]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ANY ANY]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ObservationValue D:ObservationValue]||Open
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CAREGIVER CAREGIVER]||caregiver
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PRS PRS]||personal relationship||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Observation-valueNegationInd-att valueNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ACCESS ACCESS]||access
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ADMM ADMM]||Administerable Material||
+
|[http://cda/infrastructure/rim/rim.html#Observation-interpretationCode-att interpretationCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ObservationInterpretation D:ObservationInterpretation]||Open
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#BIRTHPL BIRTHPL]||birthplace
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#DEATHPLC DEATHPLC]||place of death||
+
|[http://cda/infrastructure/rim/rim.html#Observation-methodCode-att methodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ObservationMethod D:ObservationMethod]||Open
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#DST DST]||distributed material
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#RET RET]||retailed material||
+
|[http://cda/infrastructure/rim/rim.html#Observation-targetSiteCode-att targetSiteCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActSite D:ActSite]||Open
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#EXPR EXPR]||exposed entity
+
|}
 +
 
 +
'''Observation.classCode'''
 +
 
 +
The defines a specific sub-type of a given Observation type. 
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Observation.classCode
 +
! style="text-align:left;"  colspan="5" | V:ActClassObservation <small> [2.16.840.1.113883.1.11.11529] (CLOSED)</small>
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#HLD HLD]||held entity||
+
!Code!!Display Name!!  !!Code!!Display Name
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#HLTHCHRT HLTHCHRT]||health chart
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#IDENT IDENT]||identified entity||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBS OBS]||Observation|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#ALRT ALRT]||detected issue
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#MANU MANU]||manufactured product
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#THER THER]||therapeutic agent||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLNTRL CLNTRL]||clinical trial
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#MNT MNT]||maintained entity
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#OWN OWN]||owned entity||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONC CONC]||concern|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#COND COND]||Condition
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#RGPR RGPR]||regulated product
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SDLOC SDLOC]||service delivery location||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#CASE CASE]||public health case|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#OUTB OUTB]||outbreak
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#DSDLOC DSDLOC]||dedicated service delivery location, health care facility
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ISDLOC ISDLOC]||incidental service delivery location||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#DGIMG DGIMG]||diagnostic image|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#GEN GEN]||genomic observation
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#TERR TERR]||territory of authority
+
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DETPOL DETPOL]||determinant peptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#EXP EXP]||expression level
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#LOC LOC]||locus||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#PHN PHN]||phenotype
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POL POL]||polypeptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SEQ SEQ]||bio sequence
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SEQVAR SEQVAR]||bio sequence variation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#INVSTG INVSTG]||investigation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBSSER OBSSER]||observation series||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OBSCOR OBSCOR]||correlated observation sequences
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POS POS]||position||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#POSACC POSACC]||position accuracy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POSCOORD POSCOORD]||position coordinate||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SPCOBS SPCOBS]||specimen observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#VERIF VERIF]||Verification||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ROIBND ROIBND]||bounded ROI
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#LLD LLD] ('''Deprecated''')||left lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PRN PRN] ('''Deprecated''')||prone ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#RLD RLD] ('''Deprecated''')||right lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SFWL SFWL] ('''Deprecated''')||Semi-Fowler's ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SIT SIT] ('''Deprecated''')||sitting
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#STN STN] ('''Deprecated''')||standing ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SUP SUP] ('''Deprecated''')||supine
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#RTRD RTRD] ('''Deprecated''')|| reverse trendelenburg ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRD TRD] ('''Deprecated''')||trendelenburg
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#USED USED]||used entity||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#CNOD CNOD] ('''Deprecated''')||Condition Node || || ||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#WRTE WRTE]||warranted product
 
 
|-
 
|-
−
!style="text-align:left;"  colspan="5" | <small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
|}
 
|}
  
−
'''AssociatedEntity.id'''
+
'''Observation.moodCode'''
  
−
An identifier for the associate person (when present) or the organization.
+
The intended use of the Observation statement: as a report of fact, a command, a possibility, a goal, etc. Since the mood code is a determining factor for the meaning of an entire Observation object, the mood must always be known. This means that whenever an Observation is instantiated, the mood attribute SHALL be assigned to a valid code, and the mood assignment SHALL NOT change throughout the lifetime of the Observation.  
  
−
'''AssociatedEntity.code'''
+
{| class='wikitable' 
−
 
+
|+Table {{AUTOTABLENUM}}: Value set for Observation.moodCode
−
An optional role code taken from the RoleCode concept domain.  This binding is open so other code systems can be used.  
+
! style="text-align:left;"  colspan="5" | V:x_ActMoodDocumentObservation <small>[2.16.840.1.113883.1.11.19644] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#APT APT]</span>||appointment||  ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#ARQ ARQ]</span>||appointment request
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event|| ||[http://cda/infrastructure/vocabulary/ActMood.htm#DEF DEF]||definition
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#GOL GOL]||goal||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#INT INT]||intent
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#PRMS PRMS]||promise||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#PRP PRP]||proposal
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#RSK RSK]</span>||risk||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#RQO RQO]||request
 +
|-
 +
!style="text-align:left;"  colspan="5" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 +
|}
 +
 
 +
'''Observation.id'''
 +
 
 +
A unique identifier for the Observation.
  
−
'''AssociatedEntity.addr'''
+
'''Observation.code'''
  
−
The postal address for  the associate person (when present) or the organization.
+
The particular kind of Observation that the Observation-instance represents within its class. Observation.code, if used, SHALL be a specialization of the Observation.classCode. This attribute defines a specific sub-type of a given Observation type (determined by the "classCode" attribute). The Observation.code is bound to the ActCode concept domain.
  
−
'''AssociatedEntity.telecom'''
+
'''<span class="change-highlight">Observation.actionNegationInd</span>'''
  
−
The phone number for the associated person (when present) or the organization.
+
<span class="change-highlight">The Observation.actionNegationInd works as a negative existence quantifier on the actual, intended or described observation event. In Event mood, it indicates the defined observation did not occur. In Intent mood, it indicates the defined observation is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.  
  
−
=====Person=====
+
The actionNegationInd negates the Observation as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, derivationExpr, repeatNumber, isCriterionInd, value, valueNegationInd,  interpretationCode, methodCode, targetSiteCode,  and any of their components.
  
−
Refer to [[#div-person|Person]] as defined for Author participation.
+
The remaining properties represent the document characteristics, E.g. Observatoin.id, Observation.moodCode, Observation.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.</span>
  
−
=====Organization=====
+
'''Observation.negationInd'''
  
−
Refer to [[#div-Organization|Organization]] as defined for authenticator participation.
+
<span class="change-highlight">Observation.negationInd, <b><I>is deprecated in RIM 2.35</i></b>, and CDA R2.1 retains it for backwards compatibility. It was deprecated as the type of negation required knowledge of template documentation to determine the actual type of negation I.e. value or action negation. CDA R2.1 compliant implementation guides should use actionNegationInd or valueNegationInd moving forward.</span>
  
−
====<big>performer</big>====
+
'''Observation.derivationExpr'''
  
−
See [[#ServiceEvent|ServiceEvent]] for a description of the performer participant.
+
A character string containing a formal language expression that specifies how the Observation's attributes are, should be, or have been derived from input parameters associated with derivation relationships. Derived observations can be defined through association with other observations using ActRelationships of type "derivation." For example, to define a derived observation for Mean Corpuscular Hemoglobin (MCH) one will associate the MCH observation with a Hemoglobin (HGB) observation and a Red Blood cell Count (RBC) observation: the derivation expression value encodes the formula: MCH = HGB / RBC.  
  
−
====<big>recordTarget</big>====
+
'''<span class="change-highlight">Observation.title</span>'''
  
 +
<span class="change-highlight">A word or phrase by which a specific Observation may be known among people. This is not a formal identifier but rather a human-recognizable common name. However it is similar to the id attribute in that it refers to a specific Observation rather than a 'kind' of Observation. (For definition mood, the title refers to that specific definition, rather than to a broad category that might be conveyed with Observation.code.)</span>
  
−
[[Image:RecordTarget.png|800px|border|center|recordTarget]]
+
'''Observation.text'''
  
−
The recordTarget identifies the specified patient's medical record that the document belongs to.  
+
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Observation. The Observation.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.  
  
−
A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participant can be stated.
+
'''Observation.statusCode'''
  
−
Note:
+
The status reflects the state of the activity.  In the case of an Observation, this is the status of the activity of observing (e.g., "new," "complete," "cancelled"), not the status of what is being observed (e.g., disease status, "Active" allergy to penicillin). To convey the status of the subject being observed, consider coordinating it into the code or value attribute of the Observation or using a related Observation.  The RIM based [http://cda/infrastructure/rim/rim.htm#ActStatus  state machine diagram] depicts the allowable state transitions that an Observation.StatusCode can take on.  
−
The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.  However, the patient(s) specified by the recordTarget are assumed to be the default ''subjects'' of the clinical document. Unlike the recordTarget, which can not be overridden, the patients or ''subjects'' propagate to nested components, and can be overridden at the section or entry level.  (see See [[#CDA_Context|CDA Context]]).  
 
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: recordTarget
+
|+Table {{AUTOTABLENUM}}: Value set for Observation.statusCode
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
! style="text-align:left;" colspan="5" | V:ActStatus <small>[2.16.840.1.113883.1.11.15933] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!! !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#normal normal]||normal|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#aborted aborted]||aborted
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#active active]||active|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#cancelled cancelled]||cancelled
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#completed completed]||completed|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#held held]||held
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#new new]||new|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#suspended suspended]||suspended
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#RCT RCT]||Fixed
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#nullified nullified]||nullified|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#obsolete obsolete]||obsolete
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14</small>
 
|}
 
|}
  
−
'''recordTarget.typeCode'''
+
'''Observation.effectiveTime'''
  
−
The recordTarget.typeCode is fixed to "RCT" and indicates that this is a record target participation.   
+
<span class="change-highlight">Observation.effectiveTime is used to indicate the clinically or operationally relevant time of an observation, exclusive of administrative activity. For example, in a Blood Gas Analysis (BGA), a result might not be available for several minutes after the specimen was taken.  The effectiveTime is the time the specimen was taken, the availabilityTime would be the time the result was available for review. For clinical Observations, the effectiveTime represents the time at which the observation holds (is effective) for the patient. In V2 the effectiveTime was known as the biologically relevant time.</span>
  
−
{| class='wikitable'
+
'''<span class="change-highlight">Observation.activityTime</span>'''
−
|+Table {{AUTOTABLENUM}}: Fixed recordTarget.typeCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#RCT RCT]||record target
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 
−
|}
 
  
−
'''recordTarget.contextControlCode'''
+
<span class="change-highlight">Observation.activityTime is a time expression specifying when an Observation occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the observation occurred, is supposed to occur, is scheduled to occur, etc. When an observation of a prior symptom is made, the activityTime describes the time the observation is made, as opposed to effectiveTime which is the time the symptom is reported to have occurred. Thus the activityTime may be entirely different from the effectiveTime for the same observation instance.</span>
  
−
The recordTarget.contextControlCode is fixed to "OP". It means that the recordTarget identified in the header will  propagate to any child Acts that allow context to be propagated.
+
'''<span class="change-highlight">Observation.availabilityTime</span>'''
  
−
{| class='wikitable' 
+
<span class="change-highlight">Observation.availabilityTime is the point in time at which information about an observation instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the Observation itself. For CDA documents, the availabilityTime reported for its contents, would represent the time the observation first became available to a source system generating the CDA document.</span>
−
|+Table {{AUTOTABLENUM}}: Fixed recordTarget.contextControlCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||overriding, propagating
 
−
|-
 
−
!style="text-align:left;" colspan="2" |<small> Code System: ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057</small>
 
−
|}
 
  
−
A recordTarget is represented as a relationship between a person and an organization, where the person is in a patient role (PatientRole class). The entity playing the role is a patient (Patient class). The entity scoping the role is an organization (Organization class). A patient is uniquely identified via the PatientRole.id attribute.
+
'''Observation.priorityCode'''
  
−
=====PatientRole=====
+
The urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Act.priorityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority ActPriority] concept domain.
  
−
{| class='wikitable'
+
'''<span class="change-highlight">Observation.confidentialityCode</span>'''  
−
|+Table {{AUTOTABLENUM}}: PatientRole
+
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
<span class="change-highlight">Constraints around appropriate disclosure of information about this Observation, regardless of mood. The Observation.confidentialityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality Confidentiality] concept domain.</span>
−
|-
+
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#PAT PAT]||Fixed
+
'''Observation.repeatNumber'''
−
|-
+
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-id-att id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[1..*]|| ||
+
An interval of integer numbers stating the minimal and maximal number of repetitions of the Observation.
−
|-
+
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||
+
'''<span class="change-highlight">Observation.uncertaintyCode</span>'''
−
|-
+
 
−
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||
+
<span class="change-highlight">An indication that the Observation statement as a whole, with its subordinate components has been asserted to be uncertain in some way. The use of the uncertaintyCode is appropriate only if the entirety of the Observation and its dependent Acts is questioned. The Observation.uncertaintyCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActUncertainty ActUncertainty] concept domain.</span>
−
|}
+
 
 +
'''Observation.languageCode'''
 +
 
 +
The primary language in which this Observation statement is specified, particularly the language of the Observation.text.  The Observation.languageCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage HumanLanguage] concept domain.
 +
 
 +
'''Observation.isCriterionInd'''
 +
 
 +
Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.  
 +
 
 +
'''Observation.value'''
 +
 
 +
The result of the observation action. Extensive usage notes are available in the RIM, reference [http://cda/infrastructure/rim/rim.htm#Observation-value-att Value UsageNotes]
 +
 
 +
'''<span class="change-highlight">Observation.valueNegationInd</span>'''
 +
 
 +
<span class="change-highlight">Observation.valueNegationInd, indicates that when the observation event occurred, the finding communicated by the value attribute was NOT found. So, when we want to indicate the patient does not have asthma, we can negate a finding of asthma, using this indicator. Note: The RIM indicates that this attribute should only be used when the terminology used for Observation.value is not itself capable of expressing negated findings. (E.g. ICD9).  Implementation experience may override the RIM definition and it's important to review template definitions and Value Set content and binding for consistent negation implementation. Existing CDA R2.0 implementations use negationInd in many C-CDA templates.</span>
  
−
'''PatientRole.classCode'''
+
'''Observation.interpretationCode'''
  
−
The PatientRole.classCode is fixed to "PAT" to indicate a person (Patient) as a recipient of health care services from a healthcare provider.  
+
A qualitative interpretation of the observation. These interpretation codes are sometimes called "abnormal flags," however, the judgment of normalcy is just one of the interpretations, and is often not relevant. For example, the susceptibility interpretations are not about "normalcy," and for any observation of a pathologic condition, it does not make sense to state the normalcy, since pathologic conditions are never considered "normal."
  
−
{| class='wikitable'
+
'''Observation.methodCode'''
−
|+Table {{AUTOTABLENUM}}: Fixed PatientRole.classCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PAT PAT]||patient
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
 
−
|}
 
  
−
'''PatientRole.id'''
+
The means or technique used to ascertain the observation. In all observations the method is already partially specified by the Observation.code. In this case, the methodCode NEED NOT be used at all. The methodCode MAY still be used to identify this method more clearly in addition to what is implied from the Observation.code. However, an information consumer system or process SHOULD NOT depend on this methodCode information for method detail that is implied by the Observation.code.  
  
−
A unique identifier for the person in this patient role.
+
'''Observation.targetSiteCode'''
  
−
'''PatientRole.addr'''
+
The anatomical site or system that is the focus of the observation.  Most observation target sites are implied by the observation definition and Observation.code, or Observation.value. For example, "heart murmur" always has the heart as target. This attribute is used only when the observation target site needs to be refined, to distinguish right from left, etc. If the subject of the Observation is something other than a human patient or animal, the attribute is used analogously to specify a structural landmark of the thing where the Observation focuses. For example, if the subject is a lake, the site could be inflow and outflow, etc. If the subject is a lymphatic node, "hilus," "periphery," or other node sites would be valid target sites.  
  
−
The postal address for the Patient.
+
=====Reference Range=====
  
−
'''PatientRole.telecom'''
+
An Observation can have zero to many referenceRange relationships, which relate an Observation to the ObservationRange class.  
  
−
The phone number for the Patient.
+
'''referenceRange.typeCode'''
  
−
=====Patient=====
+
The referenceRange.typeCode has been fixed to "REFV", which indicates an association to a reference range.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Patient
+
|+Table {{AUTOTABLENUM}}: Fixed referenceRange.typeCode
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!Code!!Display Name
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#PSN PSN]||Fixed
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE  INSTANCE]||Fixed
+
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#REFV REFV]||has reference values
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-id-att  id] ('''Deprecated''')||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||  
+
!style="text-align:left;"  colspan="2" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 +
|}
 +
 
 +
=====ObservationRange=====
 +
 
 +
ObservationRange or reference ranges are essentially descriptors of a class of result values assumed to be "normal", "abnormal", or "critical." Those can vary by sex, age, or any other criterion.  
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: ObservationRange Attributes
 +
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-name-att name]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PN PN]>||[0..*]|| ||
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||  <= OBS  is [http://cda/infrastructure/vocabulary/vs_ActClass.htm#ActClassObservation V:ActClassObservation]||Closed w/ Default
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-desc-att desc ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]|| ||  
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS] ||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN.CRT ENV.CRT] ||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#LivingSubject-administrativeGenderCode-att administrativeGenderCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/AdministrativeGender.htm D:administrativeGender]||Open
+
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[1..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActCode D:ActCode]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#LivingSubject-birthTime-att birthTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]|| ||  
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
 
|-
 
|-
−
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#LivingSubject-deceasedInd-att deceasedInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||  
+
|[http://cda/infrastructure/rim/rim.html#Act-isCriterionInd-att isCriterionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#LivingSubject-deceasedTime-att deceasedTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]|| ||  
+
|[http://cda/infrastructure/rim/rim.html#Observation-value-att value]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ANY ANY]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ObservationValue D:ObservationValue]||Open
 
|-
 
|-
−
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#LivingSubject-multipleBirthInd-att multipleBirthInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||  
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Observation-valueNegationInd-att valueNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#LivingSubject-multipleBirthOrderNumber-att multipleBirthOrderNumber]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-INT INT]||[0..1]|| ||  
+
|[http://cda/infrastructure/rim/rim.html#Observation-interpretationCode-att interpretationCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ObservationInterpretation D:ObservationInterpretation]||Open
 +
|}
 +
 
 +
'''ObservationRange.classCode'''
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for ObservationRange.classCode
 +
! style="text-align:left;"  colspan="5" | V:ActClassObservation <small>[2.16.840.1.113883.1.11.11529] (CLOSED) </small>
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Person-maritalStatusCode-att maritalStatusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/vs_MaritalStatus.htm#MaritalStatus D:MaritalStatus]||Open
+
!Code!!Display Name!!  !!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Person-religiousAffiliationCode-att religiousAffiliationCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/ReligiousAffiliation.htm D:ReligousAffiliation]||Open
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBS OBS] (<b>Default</b>)||Observation|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#ALRT ALRT]||detected issue
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Person-raceCode-att raceCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||<span class="change-highlight">[0..*]</span>||[http://cda/infrastructure/vocabulary/Race.htm D:Race]||Open
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLNTRL CLNTRL]||clinical trial
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Person-ethnicGroupCode-att ethnicGroupCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||<span class="change-highlight">[0..*]</span>||[http://cda/infrastructure/vocabulary/Ethnicity.htm D:Ethnicity]||Open
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONC CONC]||concern|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#COND COND]||Condition
−
|}
 
−
 
 
−
'''Patient.classCode'''
 
−
 
 
−
The Patient.classCode is fixed to "PSN", indicating that the entity is a person.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed Patient.classCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/EntityClass.htm#PSN PSN]||person
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#CASE CASE]||public health case||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OUTB OUTB]||outbreak
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#DGIMG DGIMG]||diagnostic image||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#GEN GEN]||genomic observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DETPOL DETPOL]||determinant peptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#EXP EXP]||expression level
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#LOC LOC]||locus||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#PHN PHN]||phenotype
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POL POL]||polypeptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SEQ SEQ]||bio sequence
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SEQVAR SEQVAR]||bio sequence variation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#INVSTG INVSTG]||investigation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBSSER OBSSER]||observation series||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OBSCOR OBSCOR]||correlated observation sequences
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POS POS]||position||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#POSACC POSACC]||position accuracy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POSCOORD POSCOORD]||position coordinate||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SPCOBS SPCOBS]||specimen observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#VERIF VERIF]||Verification||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ROIBND ROIBND]||bounded ROI
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#LLD LLD] (<b>Deprecated</b>)||left lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PRN PRN] (<b>Deprecated</b>)||prone ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#RLD RLD] (<b>Deprecated</b>)||right lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SFWL SFWL] (<b>Deprecated</b>)||Semi-Fowler's ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SIT SIT] (<b>Deprecated</b>)||sitting
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#STN STN] (<b>Deprecated</b>)||standing ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SUP SUP] (<b>Deprecated</b>)||supine
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#RTRD RTRD] (<b>Deprecated</b>)|| reverse trendelenburg ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRD TRD] (<b>Deprecated</b>)||trendelenburg
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CNOD CNOD] (<b>Deprecated</b>)||Condition Node ||  ||  || 
 +
|-
 +
!style="text-align:left;"  colspan="5" |<small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
|}
 
|}
  
−
'''Patient.determinerCode'''
+
'''ObservationRange.moodCode'''
  
−
The determinerCode is fixed to "INSTANCE", which indicates a specific person is a patient.  
+
The ObservationRange.moodCode is fixed to the "EVN.CRT" (event criterion).  The "EVN.CRT" is a criterion or condition over service events that must apply for an associated service to be considered.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed Patient.determinerCode
+
|+Table {{AUTOTABLENUM}}: Fixed ObservationRange.moodCode
 
!Code!!Display Name
 
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN.CRT EVN.CRT]||event criterion
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
+
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 
|}
 
|}
  
−
'''Patient.id''' ('''Deprecated''')
+
'''ObservationRange.code'''
  
−
CDA Release 1.0 allowed for additional person identifiers, corresponding to the Patient.id attribute in CDA Release 2.1. This attribute is included for backwards compatibility and has been deprecated because having two different ways to identify a patient can result in inconsistent usage. Further use of Patient.id is discouraged.  
+
The particular kind of Observation that the ObservationRange-instance represents within its class. ObservationRange.code, if used, SHALL be a specialization of the ObservationRange.classCode. This attribute defines a specific sub-type of a given Observation type (determined by the "classCode" attribute). The ObservationRange.code is bound to the ActCode concept domain.
  
−
'''Patient.name'''
+
'''ObservationRange.text'''
  
−
The patient's name.
+
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the ObservationRange. The ObservationRange.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.  
  
−
Note: The person name data type "PN" supports current, and historical names using validTime, and the specification of different use codes can indicate legal name, tribal name, stage name and others.  
+
'''ObservationRange.isCriterionInd'''
  
−
'''Patient.desc'''
+
Is set to true to indicate that the data conveyed by the ObservationRange, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.  
  
−
A textual or multimedia depiction of the patient.
+
'''ObservationRange.value'''
  
−
'''Patient.administrativeGenderCode'''
+
The result of the ObservationRange action. Extensive usage notes are available in the RIM, reference [http://cda/infrastructure/rim/rim.htm#Observation-value-att Value UsageNotes]
  
−
The gender (i.e., the behavioral, cultural, or psychological traits typically associated with one sex) of a living subject as defined for administrative purposes.  
+
'''<span class="change-highlight">ObservationRange.valueNegationInd</span>'''
  
−
'''Patient.birthTime'''
+
<span class="change-highlight">ObservationRange.valueNegationInd, indicates that when the ObservationRange event occurred, the finding communicated by the value attribute was NOT found.  Note: This attribute should only be used when the terminology used for ObservationRange.value is not itself capable of expressing negated findings. (E.g. ICD9).</span>
  
−
The date and time of the patient's birth.
+
'''ObservationRange.interprerationCode'''
  
−
'''<span class="change-highlight">Patient.deceasedInd</span>'''
+
A qualitative interpretation of the ObservationRange. These interpretation codes are sometimes called "abnormal flags," however, the judgment of normalcy is just one of the interpretations, and is often not relevant. For example, the susceptibility interpretations are not about "normalcy," and for any observation of a pathologic condition, it does not make sense to state the normalcy, since pathologic conditions are never considered "normal."
  
−
<span class="change-highlight">An indication that the subject is dead.</span>
+
====<big><big>ObservationMedia</big></big>====
  
−
'''<span class="change-highlight">Patient.deceasedTime</span>'''
+
A derivative of the RIM Observation class that represents multimedia that is logically part of the current document. This class is only for multimedia that is logically part of the attested content of the document. Rendering a referenced ObservationMedia requires a software tool that recognizes the particular MIME media type.  The distinction between ObservationMedia and ExternalObservation is that ObservationMedia entries are part of the attested content of the document whereas ExternalObservations are not. For instance, when a clinician draws a picture as part of a progress note, that picture is represented as a CDA ObservationMedia. If that clinician is also describing a finding seen on a chest-x-ray, the referenced chest-x-ray is represented as a CDA ExternalObservation.
  
−
<span class="change-highlight">The date and time that the patient's death occurred.</span>
+
{| class='wikitable'   
−
 
+
|+Table {{AUTOTABLENUM}}: ObservationMedia Attributes
−
'''<span class="change-highlight">Patient.multipleBirthInd</span>'''
+
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
−
 
 
−
<span class="change-highlight">An indication as to whether the patient was part of a multiple birth.</span>
 
−
 
 
−
'''<span class="change-highlight">Patient.multipleBirthOrderNumber</span>'''
 
−
 
 
−
<span class="change-highlight">The order within a multiple birth in which this patient was born.</span>
 
−
 
 
−
'''Patient.maritalStatusCode'''
 
−
 
 
−
The domestic partnership status of the patient.
 
−
 
 
−
'''Patient.religiousAffiliationCode'''
 
−
 
 
−
The primary religious preference of the patient.
 
−
 
 
−
'''Patient.raceCode'''
 
−
 
 
−
The race of the patient.
 
−
 
 
−
<span class="change-highlight">'''Note:''' More than one race code is now supported in CDA R2.1.</span>
 
−
 
 
−
'''Patient.ethnicGroupCode'''
 
−
 
 
−
The ethnic group of the patient.
 
−
 
 
−
<span class="change-highlight">'''Note:''' More than one ethnic group is now supported in CDA R2.1.</span>
 
−
 
 
−
Note: See 2.7 Backwards and Forwards Compatibility, for discussion on sdtc: extensions defined for CDA R2.0 and CDA R2.1.
 
−
 
 
−
=====Organization=====
 
−
 
 
−
The optional Organization in recordTarget identifies the Patient's healthcare organization. Refer to [[#div-Organization|Organization]] as defined for authenticator participation for details.
 
−
 
 
−
=====LanguageCommunication=====
 
−
 
 
−
A patient's language communication skills can be expressed in the associated LanguageCommunication class.
 
−
 
 
−
{| class='wikitable'   
 
−
|+Table {{AUTOTABLENUM}}: LanguageCommunication
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#LanguageCommunication-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Open
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]|| <= OBS is [http://cda/infrastructure/vocabulary/vs_ActClass.htm#ActClassObservation V:ActClassObservation]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#LanguageCommunication-modeCode-att modeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/LanguageAbilityMode.htm D:LanguageAbilityMode]||Open
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#LanguageCommunication-proficiencyLevelCode-att proficiencyLevelCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/LanguageAbilityProficiency.htm D:LanguageAbilityProficiency]||Open
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
 +
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#LanguageCommunication-preferenceInd-att preferenceInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
+
|[http://cda/infrastructure/rim/rim.html#Observation-value-att value]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[1..1]||||
 
|}
 
|}
  
−
'''LanguageCommunication.languageCode'''
+
'''NOTE: XML ID Attribute added'''
−
 
 
−
A language for which the patient has some level of proficiency for communication.
 
−
 
 
−
'''LanguageCommunication.modeCode'''
 
−
 
 
−
The method of expression of the language, e.g. expressed spoken, expressed written, expressed signed, received spoken, received written, received signed
 
−
 
 
−
'''LanguageCommunication.proficiencyLevelCode'''
 
−
 
 
−
The level of proficiency the patient has in a particular language, e.g. excellent, good, fair, poor
 
  
−
'''LanguageCommunication.preferenceInd'''
+
An XML attribute "ID" of type XML ID, is added to ObservationMedia within the CDA Schema. This attribute serves as the target of a <renderMultiMedia> reference (see [[#.3CrenderMultiMedia.3E|<renderMultiMedia>]]). All values of attributes of type XML ID must be unique within the document (per the W3C XML specification).
  
−
An indicator specifying whether the language is preferred by the patient for the associated mode.
+
'''ObservationMedia.classCode'''
  
−
=====Birthplace=====
+
The ObservationMedia.classCode is defaulted to "OBS" for Observation, but can be set to any sub-type of Observation that may more accurately characterize the multi-media referenced via the ObservationMedia class.  
−
 
 
−
A Patient's birthplace is represented as a relationship between a patient and a place. The Birthplace class is played by a place (Place class), and scoped by the patient (Patient class).
 
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Birthplace
+
|+Table {{AUTOTABLENUM}}: Value set for ObservationMedia.classCode
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
! style="text-align:left;"  colspan="5" | V:ActClassObservation <small> [2.16.840.1.113883.1.11.11529] (CLOSED)</small>
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#BIRTHPL BIRTHPL]||Fixed
+
!Code!!Display Name!! !!Code!!Display Name
−
|}
 
−
 
 
−
'''Birthplace.classCode'''
 
−
 
 
−
The Birthplace.classCode it fixed to "BIRTHPL" indicating in this context, that the Place referenced is the birth place of the patient.
 
−
 
 
−
{| class='wikitable'  
 
−
|+Table {{AUTOTABLENUM}}: Fixed Birthplace.classCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#BIRTHPL BIRTHPL]||birthplace
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBS OBS] ('''Default''')||Observation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ALRT ALRT]||detected issue
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLNTRL CLNTRL]||clinical trial
−
|}
 
−
 
 
−
=====Place=====
 
−
 
 
−
{| class='wikitable'  
 
−
|+Table {{AUTOTABLENUM}}: Place
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#PLC PLC]||Fixed
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONC CONC]||concern|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#COND COND]||Condition
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||Fixed
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#CASE CASE]||public health case|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#OUTB OUTB]||outbreak
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Entity-name-att name]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ON ON]>||[0..1]|| ||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#DGIMG DGIMG]||diagnostic image|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#GEN GEN]||genomic observation
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Organization-addr-att addr]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#DETPOL DETPOL]||determinant peptide|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#EXP EXP]||expression level
−
|}
 
−
 
 
−
'''Place.classCode'''
 
−
 
 
−
A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place may or may not be constant.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed Place.classCode 
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/EntityClass.htm#PLC PLC] ||place||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#LOC LOC]||locus|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#PHN PHN]||phenotype
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#POL POL]||polypeptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SEQ SEQ]||bio sequence
−
|}
 
−
 
 
−
'''Place.determinerCode'''
 
−
 
 
−
 
 
−
The determinerCode is fixed to "INSTANCE", which indicates a specific place is being identified.
 
−
 
 
−
{| class='wikitable'  
 
−
|+Table {{AUTOTABLENUM}}: Fixed Place.determinerCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#SEQVAR SEQVAR]||bio sequence variation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#INVSTG INVSTG]||investigation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBSSER OBSSER]||observation series||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OBSCOR OBSCOR]||correlated observation sequences
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POS POS]||position||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#POSACC POSACC]||position accuracy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POSCOORD POSCOORD]||position coordinate||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SPCOBS SPCOBS]||specimen observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#VERIF VERIF]||Verification||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ROIBND ROIBND]||bounded ROI
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#LLD LLD] ('''Deprecated''')||left lateral decubitus
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#PRN PRN] ('''Deprecated''')||prone ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#RLD RLD] ('''Deprecated''')||right lateral decubitus
−
|}
 
−
 
 
−
'''Place.name'''
 
−
 
 
−
The name of place of birth (E.g. Queen Mary)
 
−
 
 
−
'''Place.addr'''
 
−
 
 
−
The postal address for the patient's birthplace.
 
−
 
 
−
=====Guardian=====
 
−
 
 
−
A patient's guardian is a person or organization in the role of guardian (Guardian class). The entity playing the role of guardian is a person (Person class) or organization (Organization class). The entity scoping the role is the patient (Patient class).
 
−
 
 
−
Where a guardian is not explicitly stated, the value should default to local business practice (e.g. the patient makes their own health care decisions unless incapacitated in which case healthcare decisions are made by the patient's spouse).
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Guardian
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/RoleCode.htm#GUARD GUARD]||Fixed
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#SFWL SFWL] ('''Deprecated''')||Semi-Fowler's || ||[http://cda/infrastructure/vocabulary/ActClass.htm#SIT SIT] ('''Deprecated''')||sitting
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-id-att id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#STN STN] ('''Deprecated''')||standing || ||[http://cda/infrastructure/vocabulary/ActClass.htm#SUP SUP] ('''Deprecated''')||supine
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#RoleCode D:RoleCode]|| Open
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#RTRD RTRD] ('''Deprecated''')|| reverse trendelenburg || ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRD TRD] ('''Deprecated''')||trendelenburg
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att  addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||  
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#CNOD CNOD] ('''Deprecated''')||Condition Node || || ||
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||
+
!style="text-align:left;" colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
|}
 
|}
  
−
'''Guardian.classCode'''
+
'''ObservationMedia.moodCode'''
  
−
The Guardian.classCode is fixed to "GUARD", indicating that the associated person or institution are legally empowered with responsibility for the care of a ward.
+
The ObservationMedia.moodCode is fixed to "EVN" or event mood to indicate that this is ObservationMedia is from a past service.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed Guardian.classCode
+
|+Table {{AUTOTABLENUM}}: Fixed ObservationMedia.moodCode
 
!Code!!Display Name
 
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#GUARD GUARD]||guardian
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event (occurrence)
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 
|}
 
|}
  
−
'''Guardian.code'''
+
'''ObservationMedia.id'''
  
−
An optional role code taken from the RoleCode concept domain. This binding is open so other code systems can be used.  
+
An optional identifier for the ObservationMedia instance.
  
−
'''Guardian.addr'''
+
'''ObservationMedia.languageCode'''
  
−
The guardian's postal address.
+
Specifies the human language of character data (whether they be in contents or attribute values).  
  
−
'''Guardian.telecom'''
+
'''ObservationMedia.value'''
  
−
The guardian's phone number.
+
The ObservationMedia.value is set to the xsi:type="ED" which enables the referencing of the multi-media object.  Review the [http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED] data type for more information about linking to files.
  
−
=====Person=====
+
====<big><big>Organizer</big></big>====
−
 
 
−
Refer to [[#div-person|Person]] as defined for Author participation.
 
−
 
 
−
=====Organization=====
 
−
 
 
−
Refer to [[#div-organization|organization]] as defined for authenticator participation.
 
−
 
 
−
====<big>responsibleParty</big>====
 
−
 
 
−
See [[#EncompassingEncounter|EncompassingEncounter]] for a description of the responsibleParty participant.
 
−
 
 
−
====<big>Participant Scenarios</big>====
 
  
−
Several CDA Header participations can be played by the same person. In such cases, the person should be identified as the player for each appropriate participation. For instance, if a person is both the author and the authenticator of a document, the CDA Header should identify that person as both the author participant and the authenticator participant.
+
A derivative of the RIM Act class, which can be used to create arbitrary groupings of other CDA entries that share a common context. An Organizer can contain other Organizers and/or other CDA entries, by traversing the component relationship. An Organizer can refer to external acts by traversing the reference relationship. An Organizer cannot be the source of an entryRelationship relationship.
  
−
On other occasions, CDA Header participants are played by different people. The following table shows a number of scenarios and the values for various participants.  
+
:'''NOTE:''' CDA entries such as Observation can also contain other CDA entries by traversing the entryRelationship class. There is no requirement that the Organizer entry be used in order to group CDA entries.
  
−
<!--For what it's worth, this is the most ridiculous data structure to stick in a table... -->
 
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: CDA participation scenarios
+
|+Table {{AUTOTABLENUM}}: Organizer Attributes
−
|1. StaffPhysicianOne sees a patient as a consultant, dictates a note, and later signs it.
+
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActClass.htm#x_ActClassDocumentEntryOrganizer V:x_ActClassDocumentEntryOrganizer ]||Closed
−
*Author — StaffPhysicianOne
 
−
*Encounter Participant — StaffPhysicianOne (typeCode="CONS")
 
−
*Legal Authenticator — StaffPhysicianOne
 
 
|-
 
|-
−
|2. StaffPhysicianOne sees a patient and dictates a note. StaffPhysicianTwo later signs the note. *
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActMood.htm#ENV EVN]||Fixed
 
|-
 
|-
−
|
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
−
*Author — StaffPhysicianOne
+
|- 
−
*Legal Authenticator — StaffPhysicianTwo
+
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
 
|-
 
|-
−
|3. ResidentOne sees a patient with StaffPhysicianOne. ResidentOne dictates a note and later signs it. The note is co-signed by StaffPhysicianOne. *
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
 
|-
 
|-
−
|
+
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActStatus.htm#ActStatus V:ActStatus]||Closed
−
*Author — ResidentOne
 
−
*Authenticator — ResidentOne
 
−
*Encounter Participant — StaffPhysicianOne (typeCode="ATND")
 
−
*Legal Authenticator — StaffPhysicianOne
 
 
|-
 
|-
−
|4. ResidentOne sees a patient with StaffPhysicianOne. ResidentOne dictates a note and later signs it. The note is co-signed by StaffPhysicianTwo. *
+
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]||||
 
|-
 
|-
−
|
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-activityTime-att activityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
−
*Author — ResidentOne
 
−
*Authenticator — ResidentOne
 
−
*Encounter Participant — StaffPhysicianOne (typeCode="ATND")
 
−
*Legal Authenticator — StaffPhysicianTwo
 
 
|-
 
|-
−
|5. ResidentOne sees a patient with StaffPhysicianOne. ResidentOne dictates a note, and goes off on vacation. The note is signed by ResidentTwo and by StaffPhysicianOne. *
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-availabilityTime-att availabilityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]||||
 
|-
 
|-
−
|
+
|[http://cda/infrastructure/rim/rim.htm#Act-priorityCode-att priorityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority D:ActPriority]||Open
−
*Author — ResidentOne
 
−
*Authenticator — ResidentTwo
 
−
*Encounter Participant — StaffPhysicianOne (typeCode="ATND")
 
−
*Legal Authenticator — StaffPhysicianOne
 
 
|-
 
|-
−
|6. ResidentOne sees a patient with StaffPhysicianOne. ResidentOne dictates a note, which is later signed by ResidentTwo and StaffPhysicianTwo. *
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality D:Confidentiality]||Open
 +
|}
 +
 
 +
'''Organizer.classCode'''
 +
 
 +
The Organizer.classCode can take on one of two values, BATTERY or CLUSTER. 
 +
 
 +
#CLUSTER is an ACT that organizes a set of component acts into a semantic grouping that have a shared subject. The subject may be either a subject participation (SBJ), subject act relationship (SUBJ), or child participation/act relationship types. 
 +
#The BATTERY is an observation that is composed of a set of observations. These observations typically have a logical or practical grouping for generally accepted clinical or functional purposes, such as observations that are run together because of automation. A battery can define required and optional component observations and, in some cases, will define complex rules that determine whether or not a particular observation is made. BATTERY is a constraint on the Observation class in that it is understood to always be composed of component observations.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Organizer.classCode
 +
! style="text-align:left;"  colspan="5" | V:x_ActClassDocumentEntryOrganizer  <small> [2.16.840.1.113883.1.11.19598] (CLOSED)</small>
 
|-
 
|-
−
|
+
!Code!!Display Name!!  !!Code!!Display Name
−
*Author — ResidentOne
 
−
*Authenticator — ResidentTwo
 
−
*Encounter Participant — StaffPhysicianOne (typeCode="ATND")
 
−
*Legal Authenticator — StaffPhysicianTwo
 
 
|-
 
|-
−
|7. StaffPhysicianOne receives an abnormal lab result, attempts to contact patient but can't, and writes and signs a progress note.
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLUSTER CLUSTER]||Cluster
 
|-
 
|-
−
|
+
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
−
*Author — StaffPhysicianOne
+
|}
−
*Legal Authenticator — StaffPhysicianOne
+
 
 +
'''Organizer.moodCode'''
 +
 
 +
The Organizer.moodCode is fixed to the "EVN" or event mood to indicate that the Organizer has been created with the contents specified.
 +
 
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Organizer.moodCode
 +
!Code!!Display Name
 
|-
 
|-
−
|8. ResidentSurgeonOne is operating on a patient with StaffSurgeonOne. StaffSurgeonOne dictates an operative report and later signs it.
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event (occurrence)
 
|-
 
|-
−
|
+
!style="text-align:left;" colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
−
*Author — StaffSurgeonOne
 
−
*Authenticator — null (need not be included)
 
−
*Legal Authenticator — StaffSurgeonOne
 
−
*Performer — StaffSurgeonOne (typeCode="PPRF")
 
−
*Performer — ResidentSurgeonOne (typeCode="SPRF")
 
 
|}
 
|}
  
−
<nowiki>*</nowiki> Note that the ability of one clinician to co-sign or to sign on behalf of another clinician is subject to regulatory and local practice constraints.
+
'''Organizer.id'''
  
−
===Header Relationships===
+
An optional identifier for the Organizer instance.
  
−
This section describes classes related to the root ClinicalDocument class via an ActRelationship.
+
'''Organizer.code'''
  
−
====<big>ParentDocument</big>====
+
The particular kind of Organizer that the Organizer-instance represents within its class. Organizer.code, if used, SHALL be a specialization of the Organizer.classCode. This attribute defines a specific sub-type of a given Organizer type (BATTERY or CLUSTER). The Organizer.code is bound to the ActCode concept domain.
  
−
[[Image:ParentDocument.png|800px|border|center|ParentDocument]]
+
'''Organizer.text'''
  
−
The ParentDocument represents the source of a document revision, addenda, or transformation.  
+
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Organizer. The Organizer.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.  
  
−
=====relatedDocument=====
+
'''Organizer.statusCode'''
  
−
The optional relatedDocument class is used to associate a ClinicalDocument to a ParentDocument.  
+
The status reflects the state of the activity.   The RIM based [http://cda/infrastructure/rim/rim.htm#ActStatus  state machine diagram] depicts the allowable state transitions that an Organizer.StatusCode can take on. 
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: relatedDocument Attributes
+
|+Table {{AUTOTABLENUM}}: Value set for Organizer.statusCode
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
! style="text-align:left;"  colspan="5" | V:ActStatus <small>[2.16.840.1.113883.1.11.15933] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!! !!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActRelationshipType.htm#x_ActRelationshipDocument x_ActRelationshipDocument]||Closed
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#normal normal]||normal|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#aborted aborted]||aborted
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-inversionInd-att inversionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#BL BL]||[0..1]|| ||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#active active]||active|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#cancelled cancelled]||cancelled
−
|}
+
|-
−
 
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#completed completed]||completed|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#held held]||held
−
'''relatedDocument.typeCode'''
 
−
 
 
−
Allowable values for the intervening relatedDocument.typeCode are shown in the following table.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Value set for relatedDocument.typeCode
 
−
! style="text-align:left;"  colspan="5" | v:x_ActRelationshipDocument <small>[2.16.840.1.113883.1.11.11610] (CLOSED) </small>
 
−
|-
 
−
!Code!!Display Name!! !!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#APND APND]||is appendage ||  
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#new new]||new|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#suspended suspended]||suspended
−
||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RPLC RPLC]||replaces
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#XFRM XFRM]] ||transformation || || ||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#nullified nullified]||nullified|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#obsolete obsolete]||obsolete
 
|-
 
|-
−
!style="text-align:left;"  colspan="5" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14</small>
 
|}
 
|}
  
−
A conformant CDA document can have a single relatedDocument with typeCode "APND"; a single relatedDocument with typeCode "RPLC"; a single relatedDocument with typeCode "XFRM"; a combination of two relatedDocuments with typeCodes "XFRM" and "RPLC"; or a combination of two relatedDocuments with typeCodes "XFRM" and "APND". No other combinations are allowed.
+
'''Organizer.effectiveTime'''
 +
 
 +
<span class="change-highlight">The optional Organizer.effectiveTime is used to indicate the clinically or operationally relevant time of an Organizer's component items, exclusive of administrative activity. For example, in a Blood Gas Analysis (BGA), a result might not be available for several minutes after the specimen was taken.  The effectiveTime is the time the specimen was taken, the availabilityTime would be the time the result was available for review. </span>
 +
 
 +
'''<span class="change-highlight">Organizer.activityTime</span>'''
 +
 
 +
<span class="change-highlight">The optional Organizer.activityTime is a time expression specifying when the activityTime of the Organizer's component items occurred, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the component Acts occurred, is supposed to occur, is scheduled to occur, etc. </span>
 +
 
 +
'''<span class="change-highlight">Organizer.availabilityTime</span>'''
 +
 
 +
<span class="change-highlight">The optional Observation.availabilityTime is the point in time at which information about the component Acts regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the Organizer's component activities themselves. </span>
 +
 
 +
'''Organizer.priorityCode'''
  
−
<span class="change-highlight">'''relatedDocument.inversionInd'''</span>
+
The optional priorityCode identifies the urgency under which the component Act's happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Organizer.priorityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority ActPriority] concept domain.
  
−
<span class="change-highlight">'''Technical note''': CDA R2.0 design assumes that ClinicalDocument was the source for all typecodes found in relatedDocument, ("APND", "RPLC" and "XFRM"). For "APND" and "RPLC" this is correct, however for "XFRM", the RIM definition indicates that "''it is used when the target Act is a transformation of the source Act...''".  This  technically is an error in CDA R2.0's design, which normally should have required the use of inversionInd to establish the ClinicalDocument as the target and the ParentDocument as the source for the "XFRM" relation.
+
'''<span class="change-highlight">Organizer.confidentialityCode</span>'''
  
−
As a result, in CDA R2.1 when "XFRM" is assigned to the relatedDocument.typeCode, the associated inversionInd will be assumed to be fixed to true, but will not be required to be present in the instance document. In all other cases, "APND", "RPLC" the associated inversionInd will not be present and will be assumed to be false. This enables wire format compatibility between CDA R2.0 and CDA R2.1, and ensures proper interpretation of the "XFRM" ActRelationshipType code.</span>
+
<span class="change-highlight">The optional confidentialityCode identifies any constraints around appropriate disclosure of information about this Organizer and it's component Acts, regardless of mood. The Organizer.confidentialityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality Confidentiality] concept domain.</span>
  
−
=====ParentDocument=====
+
====<big><big>Procedure</big></big>====
  
−
The ParentDocument identifies and optionally provides a reference to the original document serving as the source for the current document revision, addendum or transformation.  
+
A derivative of the RIM Procedure class, is represents an act whose immediate and primary outcome (post-condition) is the alteration of the physical condition of the subject.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: ParentDocument Attributes  
+
|+Table {{AUTOTABLENUM}}: Procedure Attributes
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att    classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||Fixed
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att   moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]|| <= PROC is [http://cda/infrastructure/vocabulary/vs_ActClass.htm#ActClassProcedure V:ActClassProcedure]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#InfrastructureRoot-typeId-att typeId]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..1]|| ||
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActMood.htm#x_DocumentProcedureMood V:x_DocumentProcedureMood]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..*]||||
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
 
|-   
 
|-   
−
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[1..1]||[http://cda/infrastructure/vocabulary/vs_LN.htm#DocumentType D:DocumentType]||Open
+
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActProcedureCode D:ActProcedureCode]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-actionNegationInd-att actonNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-setId-att setId]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[0..1]||||
+
|[http://cda/infrastructure/rim/rim.htm#Act-negationInd-att negationInd] ('''Deprecated''')||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-versionNumber-att versionNumber]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ST.SIMPLE ST.SIMPLE]||[0..1]||||
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
−
|}
 
−
 
 
−
'''ParentDocument.classCode'''
 
−
 
 
−
The ParentDocument.classCode is fixed to "DOCCLIN".
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed ParentDocument.classCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||clinical document
+
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActStatus.htm#ActStatus V:ActStatus]||Closed
 
|-
 
|-
−
!style="text-align:left;" colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
+
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]||||
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-activityTime-att activityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-availabilityTime-att availabilityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-priorityCode-att priorityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority D:ActPriority]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality D:Confidentiality]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-uncertaintyCode-att uncertaintyCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActUncertainty D:ActUncertainty]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Act-isCriterionInd-att isCriterionInd]</span> ||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Procedure-methodCode-att methodCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ProcedureMethod D:ProcedureMethod]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Procedure-approachSiteCode-att approachSiteCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActSite D:ActSite]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Procedure-targetSiteCode-att targetSiteCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActSite D:ActSite]||Open
 
|}
 
|}
  
−
'''ParentDocument.moodCode'''
+
'''Procedure.classCode'''
  
−
The ParentDocument.moodCode is fixed to "EVN".
+
The defines a specific sub-type of a given Procedure type. The Procedure.classCode is bound to the V:ActClassProcedure value set.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed ParentDocument.moodCode
+
|+Table {{AUTOTABLENUM}}: Value set for Procedure.classCode
−
!Code!!Display Name
+
! style="text-align:left;"  colspan="5" |  V:ActClassProcedure <small>[2.16.840.1.113883.1.11.19665] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!! !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PROC PROC] ('''Default''')||procedure||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#SBEXT SBEXT]||Substance Extraction
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPECCOLLECT SPECCOLLECT]||Specimen Collection||
 +
|| ||
 +
|-
 +
!colspan="5" |  Note: Although SBADM is technically allowed, is best used with the SubstanceAdministration Entry Class
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#SBADM SBADM]||substance administration||
 +
|| ||
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
+
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
|}
 
|}
  
−
'''ParentDocument.id'''
+
'''Procedure.moodCode'''
  
−
The ParentDocument.id is a required identifier, which uniquely identifies the parent document.
+
The intended use of the Procedure statement: as a procedure report, a command, a possibility, a goal, etc. Since the mood code is a determining factor for the meaning of an entire Procedure object, the mood must always be known. This means that whenever an Procedure is instantiated, the mood attribute SHALL be assigned to a valid code, and the mood assignment SHALL NOT change throughout the lifetime of the Procedure.
  
−
'''ParentDocument.code'''
+
{| class='wikitable'
−
 
+
|+Table {{AUTOTABLENUM}}: Value set for Procedure.moodCode
−
The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note). The value set is drawn from LOINC, and has a CWE coding strength.
+
! style="text-align:left;"  colspan="5" |  V:x_DocumentProcedureMood <small>[2.16.840.1.113883.1.11.19460] (CLOSED) </small>
−
 
+
|-
−
'''ParentDocument.text'''
+
!Code!!Display Name!!  !!Code!!Display Name
−
 
+
|-
−
ParentDocument.text is modeled as an ED data type - allowing for the expression of the MIME type of the parent document. It is not to be used to embed the related document, and thus ParentDocument.text.BIN is precluded from use.
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#APT APT]||appointment|| ||[http://cda/infrastructure/vocabulary/ActMood.htm#ARQ ARQ]||appointment request
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event|| ||[http://cda/infrastructure/vocabulary/ActMood.htm#DEF DEF]||definition
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#RQO RQO]||request||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#INT INT]||intent
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#PRMS PRMS]||promise||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#PRP PRP]||proposal
 +
|-
 +
!style="text-align:left;"  colspan="5" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 +
|}
 +
 
 +
'''Procedure.id'''
 +
 
 +
A unique identifier for the Procedure.
 +
 
 +
'''Procedure.code'''
  
−
'''ParentDocument.setId'''
+
The particular kind of Procedure that the Procedure-instance represents within its class. Procedure.code, if used, SHALL be a specialization of the Procedure.classCode. This attribute defines a specific sub-type of a given Procedure type (determined by the "classCode" attribute). The Procedure.code is bound to the ActProcedureCode concept domain.  
  
−
Optional setID for the parent document.
+
'''<span class="change-highlight">Procedure.actionNegationInd</span>'''
  
−
'''ParentDocument.versionNumber'''
+
<span class="change-highlight">The Procedure.actionNegationInd works as a negative existence quantifier on the actual, intended or described Procedure event. In Event mood, it indicates the defined procedure did not occur. In Intent mood, it indicates the defined procedure is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.  
  
−
Optional versionNumber of the parent document.
+
The actionNegationInd negates the Act as described by the descriptive properties which are:  classCode, code, statusCode, effectiveTime, activityTime, priorityCode, isCriterionInd, methodCode, approachSiteCode, targetSiteCode and any of their components.  
  
−
'''Additional Information on Document Identification, Revisions, and Addenda'''
+
The remaining properties represent the document characteristics, E.g. Procedure.id, Procedure.moodCode, Procedure.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.  </span>
  
−
A clinical document can be replaced by a new document and/or appended with an addendum.
+
'''Procedure.negationInd'''
  
−
A replacement document is a new version of the parent document. The parent document is considered superseded, but a system may retain it for historical or auditing purposes. The parent document being replaced is referenced via act relationship relatedDocument, where relatedDocument.typeCode is set to equal "RPLC" (for "replaces"). An example is a report found to contain an error that is subsequently replaced by the corrected report.
+
Procedure.negationInd, <b><i>is deprecated in RIM 2.35</i></b>, and CDA R2.1 retains it for backwards compatibility. CDA R2.1 compliant implementation guides should use actionNegationInd moving forward.
  
−
An addendum is a separate document that references the parent document, and may extend or alter the observations in the prior document. The parent document remains a current component of the patient record, and the addendum and its parent are both read by report recipients. The parent report (represented by the ParentDocument class) being appended is referenced via act relationship relatedDocument, where relatedDocument.typeCode is set to equal "APND" (for "appends").
+
'''Procedure.text'''
  
−
Every CDA document must have a unique ClinicalDocument.id, and thus the replacement or addendum documents each have ClinicalDocument.id that is different from that of the parent document.
+
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Procedure. The Procedure.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.  
  
−
CDA documents may also contain a ClinicalDocument.setId and a ClinicalDocument.versionNumber, which together support a document identification and versioning scheme used in some document management systems. In this scheme, all documents in a chain of replacements have the same ClinicalDocument.setId and are distinguished by an incrementing ClinicalDocument.versionNumber. The initial version of a document gets, in addition to a new unique value for ClinicalDocument.id, a new value for ClinicalDocument.setId, and has the value of ClinicalDocument.versionNumber set to equal "1". A replacement document gets a new globally unique ClinicalDocument.id value, and uses the same value for ClinicalDocument.setId as the parent report being replaced, and increments the value of ClinicalDocument.versionNumber by 1. (Note that version number must be incremented by one when a report is replaced, but can also be incremented more often to meet local requirements.)
+
'''Procedure.statusCode'''
  
−
These relationships are illustrated in the following exhibit "Document Identification, Revisions, and Addenda Scenarios". Typical scenarios are a simple relacement (e.g. ClinicalDocument.id "1.2.345.6789.266" replacing ClinicalDocument.id "1.2.345.6789.123") and a simple append (e.g. ClinicalDocument.id "1.2.345.6789.456" appends ClinicalDocument.id "1.2.345.6789.123"). More complex scenarios that might be anticipated include: [1] replacement of an addendum (e.g. ClinicalDocument.id "1.2.345.6789.224" replaces ClinicalDocument.id "1.2.345.6789.456", which itself is an addendum to ClinicalDocument.id "1.2.345.6789.123") - expected behavior would be to render the replacement as the addendum (e.g. render ClinicalDocument.id "1.2.345.6789.224" as the addendum to ClinicalDocument.id "1.2.345.6789.123"); [2] addendum to a replaced document (e.g. ClinicalDocument.id "1.2.345.6789.456" appends ClinicalDocument.id "1.2.345.6789.123", which has been replaced by ClinicalDocument.id "1.2.345.6789.266") - expected behavior would be to render the addendum along with the replacement (e.g. render ClinicalDocument.id "1.2.345.6789.456" as an addendum to ClinicalDocument.id "1.2.345.6789.266").
+
The status reflects the state of the activity.   The RIM based [http://cda/infrastructure/rim/rim.htm#ActStatus  state machine diagram] depicts the allowable state transitions that an Procedure.statusCode can take on.
  
−
'''Document transformations'''
+
{| class='wikitable'
 +
|+Table {{AUTOTABLENUM}}: Value set for Procedure.statusCode
 +
! style="text-align:left;"  colspan="5" | V:ActStatus <small>[2.16.840.1.113883.1.11.15933] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#normal normal]||normal|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#aborted aborted]||aborted
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#active active]||active|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#cancelled cancelled]||cancelled
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#completed completed]||completed|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#held held]||held
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#new new]||new|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#suspended suspended]||suspended
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActStatus.htm#nullified nullified]||nullified|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#obsolete obsolete]||obsolete
 +
|-
 +
!style="text-align:left;"  colspan="5" |<small> Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14</small>
 +
|}
  
−
A CDA document can be a transformation from some other format, meaning that it has undergone a machine translation from some other format (such as DICOM SR). In this case, relatedDocument.typeCode should be set to "XFRM".
 
  
−
A proper transformation must ensure that the human readable clinical content of the report is not impacted. Local business rules determine whether or not a transformed report replaces the source, but typically this would not be the case. If it is, an additional relationship of type "RPLC" is to be used. The "XFRM" relationship can also be used when translating a document in a local format into CDA for the purpose of exchange. In this case, the target of the "XFRM" relationship is the local document identifier.
+
'''Procedure.effectiveTime'''
  
 +
Procedure.effectiveTime is used to indicate the clinically or operationally relevant time of a procedure, exclusive of administrative activity. For a surgical procedure (operation), the effectiveTime is the time relevant for the patient, i.e., between incision and last suture. For transportation acts, the effective time is the time the transported payload is en route.
  
−
{{ext|infrastructure/cda/graphics/L-cda_figure1.gif|Link to wide graphic (opens in a new window)}}
+
'''<span class="change-highlight">Procedure.activityTime</span>'''
  
−
====<big>ServiceEvent</big>====
+
<span class="change-highlight">Procedure.activityTime is a time expression specifying when a procedure occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the procedure occurred, is supposed to occur, is scheduled to occur, etc. For Procedures the activityTime can provide a needed administrative function by providing a more inclusive time to be anticipated in scheduling.</span>
  
−
[[Image:ServiceEvent.png|800px|border|center|ServiceEvent]]
+
'''<span class="change-highlight">Procedure.availabilityTime</span>'''
  
−
<span class="change-highlight">The ServiceEvent is used to represent the main activity being documented. It may used to represent a specific procedure, such as a colonoscopy, an appendectomy, or other clinical activity. When the ClinicalDocument represents a summary of care, the ServiceEvent.code can be set to "PCPR" to indicate the service is care provisioning.</span>
+
<span class="change-highlight">Procedure.availabilityTime is the point in time at which information about a procedure instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the procedure itself. </span>
  
−
=====documentationOf=====
+
'''Procedure.priorityCode'''
  
−
The optional documentationOf class is used to associate a ClinicalDocument to a ServiceEvent.  
+
The urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Procedure.priorityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority ActPriority] concept domain.
  
−
{| class='wikitable' 
+
'''<span class="change-highlight">Procedure.confidentialityCode</span>'''
−
|+Table {{AUTOTABLENUM}}: documentationOf Attributes
 
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActRelationshipType.htm#ActRelationshipDocuments DOC]||Fixed
 
−
|}
 
  
−
'''documentationOf.typeCode'''
+
<span class="change-highlight">Constraints around appropriate disclosure of information about this Procedure, regardless of mood. The Procedure.confidentialityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality Confidentiality] concept domain.</span>
  
−
The documentationOf.typeCode is fixed to "DOC" which indicates that the ClinicalDocument provides documentation is about ServiceEvent.
+
'''<span class="change-highlight">Procedure.uncertaintyCode</span>'''
  
−
{| class='wikitable' 
+
<span class="change-highlight">An indication that the Procedure statement as a whole, with its subordinate components has been asserted to be uncertain in some way. The use of the uncertaintyCode is appropriate only if the entirety of the Procedure and its dependent Acts is questioned. The Procedure.uncertaintyCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActUncertainty ActUncertainty] concept domain.</span>
−
|+Table {{AUTOTABLENUM}}: Fixed documentationOf.typeCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#DOC DOC]||documents
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 
−
|}
 
  
−
=====ServiceEvent=====
+
'''Procedure.languageCode'''
  
−
In some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "History and Physical Report" and the procedure being documented is a "History and Physical". A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply "Procedure Report" and the procedure was a "colonoscopy". If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.
+
The primary language in which this Procedure statement is specified, particularly the language of the Procedure.text. The Procedure.languageCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage HumanLanguage] concept domain.
  
−
{| class='wikitable'   
+
'''<span class="change-highlight">Procedure.isCriterionInd</span>'''
−
|+Table {{AUTOTABLENUM}}: ServiceEvent Attributes  
+
 
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
<span class="change-highlight">Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.</span>
−
|-
+
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att   classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm V:ActClassRoot]||Fixed
+
'''<span class="change-highlight">Procedure.methodCode</span>'''
 +
 
 +
<span class="change-highlight">The means or technique used to ascertain the observation. In some procedures the method is already partially specified by the Procedure.code. In this case, the methodCode NEED NOT be used at all. The methodCode MAY still be used to identify this method more clearly in addition to what is implied from the Procedure.code. However, an information consumer system or process SHOULD NOT depend on this methodCode information for method detail that is implied by the Procedure.code.</span>
 +
 
 +
'''<span class="change-highlight">Procedure.approachSiteCode</span>'''
 +
 
 +
<span class="change-highlight">The anatomical site or system through which the procedure reaches its target.</span>
 +
 
 +
'''<span class="change-highlight">Procedure.targetSiteCode</span>'''
 +
 
 +
<span class="change-highlight">The anatomical site or system that is the focus of the procedure.  Most procedure target sites are implied by the procedure definition and Procedure.code, or Procedure.value. If the subject of the procedure is something other than a human patient or animal, the attribute is used analogously to specify a structural landmark of the thing where the Procedure occurred.</span>
 +
 
 +
====<big><big>RegionOfInterest</big></big>====
 +
 
 +
A derivative of the RIM Observation class that represents a region of interest on an image, using an overlay shape. RegionOfInterest is used to make reference to specific regions in images, e.g., to specify the site of a physical finding by "circling" a region in a schematic picture of a human body.  The relationship between a RegionOfInterest and its referenced ObservationMedia or ExternalObservation is specified by traversing the entryRelationship or reference class, respectively, where typeCode equals "SUBJ". A RegionOfInterest must reference exactly one ObservationMedia or one ExternalObservation. If the RegionOfInterest is the target of a <renderMultimedia> reference, then it shall only reference an ObservationMedia and not an ExternalObservation.
 +
 
 +
{| class='wikitable'   
 +
|+Table {{AUTOTABLENUM}}: RegionOfInterest Attributes
 +
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActClass.htm#ROIOVL ROIOVL]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att   moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[0..*]||||
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
 
|-   
 
|-   
−
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
+
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ROIOverlayShape V:ROIOverlayShape]||Closed
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActStatus.htm#ActStatus V:ActStatus]||Closed
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]||||
+
|[http://cda/infrastructure/rim/rim.html#Observation-value-att value]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-LIST LIST]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-INT INT]>||[1..*]||||
 
|}
 
|}
  
−
'''ServiceEvent.classCode'''
+
'''NOTE: XML ID Attribute added'''
 +
 
 +
An XML attribute "ID" of type XML ID, is added to RegionOfInterest within the CDA Schema. This attribute serves as the target of a <renderMultiMedia> reference (see [[#.3CrenderMultiMedia.3E|<renderMultiMedia>]]). All values of attributes of type XML ID must be unique within the document (per the W3C XML specification).
 +
 
 +
'''RegionOfInterest.classCode'''
  
−
The ServiceEvent.classCode identifies the RIM Act class code of the service event instance.
+
The RegionOfInterest.classCode is fixed to "ROIOVL" which is a Region of Interest (ROI) specified for an image using an overlay shape. Typically used to make reference to specific regions in images, e.g., to specify the location of a radiologic finding in an image or to specify the site of a physical finding by "circling" a region in a schematic picture of a human body. The units of the coordinate values are in pixels. The origin is in the upper left hand corner, with positive X values going to the right and positive Y values going down. The relationship between a ROI and its referenced Act is specified through an ActRelationship of type "subject" (SUBJ), which must always be present.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Value set for ServiceEvent.classCode
+
|+Table {{AUTOTABLENUM}}: Fixed RegionOfInterest.classCode  
−
! style="text-align:left;"  colspan="5" | V:ActClassRoot <small> [2.16.840.1.113883.1.11.13856] (CLOSED)</small>
+
!Code!!Display Name
 
|-
 
|-
−
!Code!!Display Name!!  !!Code!!Display Name
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACT ACT] ('''Default''')||act||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#COMPOSITION COMPOSITION]||composition, Attestable unit
+
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
 +
 
 +
'''RegionOfInterest.moodCode'''
 +
 
 +
The RegionOfInterest.moodCode is fixed to "EVN" or event mood to indicate that this is region of interest, was created.
 +
 
 +
{| class='wikitable'  
 +
|+Table {{AUTOTABLENUM}}: Fixed RegionOfInterest.moodCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOC DOC]||document||
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN] ('''Fixed''')||event (occurrence)
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||clinical document
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CDALVLONE CDALVLONE]||CDA Level One clinical document||
+
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#CONTAINER CONTAINER]||record container
+
|}
 +
 
 +
'''RegionOfInterest.id'''
 +
 
 +
The optional RegionOfInterest.id allows for the unique identification of the region of interest.
 +
 
 +
'''RegionOfInterest.code'''
 +
 
 +
There are 4 types of regions that can be created, they are determined by the RegionOfInterest.code which can take on 1 of the following codes: circle, ellipse, point and polyline.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for RegionOfInterest.code
 +
! style="text-align:left;"  colspan="5" | V:ROIOverlayShape <small>[2.16.840.1.113883.1.11.16117] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CATEGORY CATEGORY]||category||
+
|[http://cda/infrastructure/vocabulary/ActCode.htm#CIRCLE CIRCLE]||circle|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#ELLIPSE ELLIPSE]||ellipse
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCBODY DOCBODY]||document body
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOCSECT CATEGORY]||document section, Section||
+
|[http://cda/infrastructure/vocabulary/ActCode.htm#POINT POINT]||point|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#POLY POLY]||polyline
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#TOPIC TOPIC]||topic
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#EXTRACT EXTRACT]||extract||
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActCode (HL7) Code System OID: 2.16.840.1.113883.5.4</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#EHR EHR]||electronic health record
+
|}
 +
 
 +
'''RegionOfInterest.value'''
 +
 
 +
The RegionOfInterest.value units are pixels, expressed as a list of integers. The origin is in the upper left hand corner, with positive X values going to the right and positive Y values going down.
 +
 
 +
 
 +
'''EXAMPLE'''
 +
 
 +
The following example illustrates one sample use of RegionOfInterest. In this case, the clinician has identified a rash upon physical examination of the skin, and indicates this by creating a region of interest atop a hand image taken from an image library. The narrative block references the RegionOfInterest via the <renderMultiMedia> tag, and the referenced RegionOfInterest references the hand image.
 +
 
 +
<div align="center">Example {{AUTOEXAMPLENUM}}</div>
 +
<nowiki>
 +
<section>
 +
  <code code="8709-8" codeSystem="2.16.840.1.113883.6.1"
 +
    codeSystemName="LOINC"/>
 +
  <title>Skin Exam</title>
 +
  <text>Erythematous rash, palmar surface, left index
 +
    finger.<renderMultiMedia referencedObject="MM2"/>
 +
  </text>
 +
  <entry>
 +
      <observation classCode="OBS" moodCode="EVN">
 +
        <code code="271807003"
 +
          codeSystem="2.16.840.1.113883.6.96"
 +
          codeSystemName="SNOMED CT"
 +
          displayName="Rash"/>
 +
        <statusCode code="completed"/>
 +
        <targetSiteCode code="48856004"
 +
          codeSystem="2.16.840.1.113883.6.96"
 +
          codeSystemName="SNOMED CT"
 +
          displayName="Skin of palmer surface of index finger">
 +
            <qualifier>
 +
              <name code="78615007"
 +
                codeSystem="2.16.840.1.113883.6.96"
 +
                displayName="with laterality"/>
 +
              <value code="7771000"
 +
                codeSystem="2.16.840.1.113883.6.96"
 +
                displayName="left"/>
 +
            </qualifier>
 +
        </targetSiteCode>
 +
        <entryRelationship typeCode="SPRT">
 +
            <regionOfInterest classCode="ROIOVL" moodCode="EVN" ID="MM2">
 +
              <id root="2.16.840.1.113883.19.3.1"/>
 +
              <code code="ELLIPSE"/>
 +
              <value value="3"/>
 +
              <value value="1"/>
 +
              <value value="3"/>
 +
              <value value="7"/>
 +
              <value value="2"/>
 +
              <value value="4"/>
 +
              <value value="4"/>
 +
              <value value="4"/>
 +
              <entryRelationship typeCode="SUBJ">
 +
                  <observationMedia classCode="OBS" moodCode="EVN">
 +
                    <id root="2.16.840.1.113883.19.2.1"/>
 +
                    <value mediaType="image/jpeg">
 +
                        <reference value="lefthand.jpeg"/>
 +
                    </value>
 +
                  </observationMedia>
 +
              </entryRelationship>
 +
            </regionOfInterest>
 +
        </entryRelationship>
 +
      </observation>
 +
  </entry>
 +
</section>
 +
</nowiki>
 +
 
 +
====<big><big>SubstanceAdministration</big></big>====
 +
 
 +
 
 +
A derivative of the RIM SubstanceAdministration class, used for representing medication-related events such as medication history or planned medication administration orders.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: SubstanceAdministration Attributes
 +
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#FOLDER FOLDER]||folder||
+
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActClass.htm#SBADM SBADM]||Fixed
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#GROUPER GROUPER]||grouper
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CLUSTER CLUSTER]||Cluster||
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActMood.htm#x_DocumentSubstanceMood V:x_DocumentSubstanceMood]||Closed
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#ACCM ACCM]||accommodation
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACCT ACCT]||account||
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#ACSN ACSN]||accession
+
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActSubstanceAdministrationCode D:ActSubstanceAdministrationCode]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ADJUD ADJUD]||financial adjudication, financial adjudication results ||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-actionNegationInd-att  actonNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#CACT CACT]||control act
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACTN ACTN]||action||
+
|[http://cda/infrastructure/rim/rim.htm#Act-negationInd-att negationInd] ('''Deprecated''')||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#INFO INFO]||information
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#STC STC]||state transition control||
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#CNTRCT CNTRCT]||contract
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#FCNTRCT FCNTRCT]||financial contract||
+
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActStatus.htm#ActStatus V:ActStatus]||Closed
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#COV COV]||coverage
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONS CONS]||consent||
+
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#CONTREG CONTREG]||container registration
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CTTEVENT CTTEVENT]||clinical trial timepoint event||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-activityTime-att activityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#DISPACT DISPACT]||disciplinary action
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#EXPOS EXPOS]||exposure||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-availabilityTime-att availabilityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#AEXPOS AEXPOS]||acquisition exposure
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#TEXPOS TEXPOS]||transmission exposure||
+
|[http://cda/infrastructure/rim/rim.htm#Act-priorityCode-att priorityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority D:ActPriority]||Open
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#INC INC]||incident
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#INFRM INFRM]||inform||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality D:Confidentiality]||Open
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#INVE INVE]||invoice element
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#LIST LIST]||working list||
+
|[http://cda/infrastructure/rim/rim.htm#Act-repeatNumber-att repeatNumber]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-INT INT]>||[0..1]||  ||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#MPROT MPROT]||monitoring program
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBS OBS]||Observation|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#ALRT ALRT]||detected issue
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLNTRL CLNTRL]||clinical trial
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Act-isCriterionInd-att isCriterionInd]</span> ||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONC CONC]||concern|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#COND COND]||Condition
+
|[http://cda/infrastructure/rim/rim.htm#SubstanceAdministration-routeCode-att routeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#RouteOfAdministration D:RouteOfAdministration]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CASE CASE]||public health case|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#OUTB OUTB]||outbreak
+
|[http://cda/infrastructure/rim/rim.htm#SubstanceAdministration-approachSiteCode-att approachSiteCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActSite D:ActSite]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DGIMG DGIMG]||diagnostic image||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#GEN GEN]||genomic observation
+
|[http://cda/infrastructure/rim/rim.htm#Act-doseQuantity-att doseQuantity]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ]>||<span class="change-highlight">[0..*]</span>||  ||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DETPOL DETPOL]||determinant peptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#EXP EXP]||expression level
+
|[http://cda/infrastructure/rim/rim.htm#Act-rateQuantity-att rateQuantity]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ]>||<span class="change-highlight">[0..*]</span>||  ||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#LOC LOC]||locus||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#PHN PHN]||phenotype
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#SubstanceAdministration-doseCheckQuantity-att doseCheckQuantity]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-RTO RTO]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ],[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ].TIME>>||[0..*]|| ||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#POL POL]||polypeptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SEQ SEQ]||bio sequence
+
|[http://cda/infrastructure/rim/rim.htm#SubstanceAdministration-maxDoseQuantity-att maxDoseQuantity]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-RTO RTO]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ],[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ].TIME>>||<span class="change-highlight">[0..*]</span>||  ||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SEQVAR SEQVAR]||bio sequence variation|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#INVSTG INVSTG]||investigation
+
|[http://cda/infrastructure/rim/rim.htm#SubstanceAdministration-administrationUnitCode-att administrationUnitCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#AdministrableDrugForm D:AdministrableDrugForm ]||Open
 +
|}
 +
 
 +
'''SubstanceAdministration.classCode'''
 +
 
 +
The SubstanceAdministration.classCode is fixed to "SBADM" which indicates an act of introducing or otherwise applying a substance to the subject.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed SubstanceAdministration.classCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBSSER OBSSER]||observation series||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OBSCOR OBSCOR]||correlated observation sequences
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#SBADM SBADM]||substance administration
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#POS POS]||position||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#POSACC POSACC]||position accuracy
+
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
 +
 
 +
'''SubstanceAdministration.moodCode'''
 +
 
 +
SubstanceAdministration.moodCode has been bound to the x_DocumentSubstanceMood value set.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed SubstanceAdministration.moodCode
 +
! style="text-align:left;"  colspan="5" | V:x_DocumentSubstanceMood <small>[2.16.840.1.113883.1.11.19461] (CLOSED)</small>
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#POSCOORD POSCOORD]||position coordinate||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SPCOBS SPCOBS]||specimen observation
+
!Code!!Display Name!! !!Code!!Display Name
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#VERIF VERIF]||Verification||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ROIBND ROIBND]||bounded ROI
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI||
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActMood.htm#DEF DEF]</span>||definition
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#PCPR PCPR]||care provision
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ENC ENC]||encounter||   
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#RQO RQO]||request||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#INT INT]||intent
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#POLICY POLICY]||policy
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#JURISPOL JURISPOL]||jurisdictional policy||   
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#PRMS PRMS]||promise||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#PRP PRP]||proposal
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#ORGPOL ORGPOL]||organizational policy
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SCOPOL SCOPOL]||scope of practice policy|| 
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#STDPOL STDPOL]||standard of practice policy
+
|}
 +
 
 +
'''SubstanceAdministration.id'''
 +
 
 +
The optional SubstanceAdministration.id can be used to uniquely identify the substance administration.
 +
 
 +
'''SubstanceAdministration.code'''
 +
 
 +
The SubstanceAdministration.code has been bound to the ActSubstanceAdministrationCode concept domain.
 +
 
 +
'''<span class="change-highlight">SubstanceAdministration.actionNegationInd</span>'''
 +
 
 +
<span class="change-highlight">The SubstanceAdministration.actionNegationInd works as a negative existence quantifier on the actual, intended or described substance administration event. In Event mood, it indicates the defined substance administration did not occur. In Intent mood, it indicates the defined substance administration is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.
 +
 
 +
The actionNegationInd negates the SubstanceAdministration as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, repeatNumber, isCriterionInd, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode and any of their components.
 +
 
 +
The remaining properties represent the document characteristics, E.g. SubstanceAdministration.id, SubstanceAdministration.moodCode, SubstanceAdministration.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.</span>
 +
 
 +
'''SubstanceAdministration.negationInd'''
 +
 
 +
SubstanceAdministration.negationInd, <b><i>is deprecated in RIM 2.35</i></b>, and CDA R2.1 retains it for backwards compatibility.  CDA R2.1 compliant implementation guides should use actionNegationInd moving forward.
 +
 
 +
 
 +
 
 +
'''SubstanceAdministration.text'''
 +
 
 +
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the SubstanceAdministration. The SubstanceAdministration.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.
 +
 
 +
'''SubstanceAdministration.statusCode'''
 +
 
 +
The status reflects the state of the activity.  The RIM based [http://cda/infrastructure/rim/rim.htm#ActStatus  state machine diagram] depicts the allowable state transitions that an SubstanceAdministration.StatusCode can take on. 
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for SubstanceAdministration.statusCode
 +
! style="text-align:left;"  colspan="5" | V:ActStatus <small>[2.16.840.1.113883.1.11.15933] (CLOSED) </small>
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#PROC PROC]||procedure||
+
!Code!!Display Name!!  !!Code!!Display Name
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#SBEXT SBEXT]||Substance Extraction
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPECCOLLECT SPECCOLLECT]||Specimen Collection||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#normal normal]||normal|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#aborted aborted]||aborted
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#SBADM SBADM]||substance administration
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#REG REG]||registration||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#active active]||active|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#cancelled cancelled]||cancelled
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#REV REV]||review
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPCTRT SPCTRT]||specimen treatment||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#completed completed]||completed|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#held held]||held
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#SPLY SPLY]||supply
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DIET DIET]||diet||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#new new]||new|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#suspended suspended]||suspended
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#STORE STORE]||storage
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SUBST SUBST]||Substitution||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#nullified nullified]||nullified|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#obsolete obsolete]||obsolete
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#TRFR TRFR]||transfer
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#TRNS TRNS]||transportation||
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#XACT XACT]|| financial transaction
+
|}
−
|-
+
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CNOD CNOD] ('''Deprecated''')||Condition Node||
+
'''SubstanceAdministration.effectiveTime'''
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#LLD LLD] ('''Deprecated''')||left lateral decubitus
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#PRN PRN] ('''Deprecated''')||prone ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#RLD RLD] ('''Deprecated''')||right lateral decubitus
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SFWL SFWL] ('''Deprecated''')||Semi-Fowler's ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SIT SIT] ('''Deprecated''')||sitting
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#STN STN] ('''Deprecated''')||standing ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SUP SUP] ('''Deprecated''')||supine
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#RTRD RTRD] ('''Deprecated''')|| reverse trendelenburg ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRD TRD] ('''Deprecated''')||trendelenburg
 
−
|-
 
−
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
−
|}
 
  
−
'''ServiceEvent.moodCode'''
+
<span class="change-highlight">SubstanceAdministration.effectiveTime is the clinically relevant time of an substance administration act, exclusive of administrative activity.  It is used to indicate the time over which the substance is to be administered, including the frequency of administration (e.g., TID for 10 days). </span>  SubstanceAdministration.effectiveTime is used to describe the timing of administration. It is modeled using the GTS data type to accommodate various dosing scenarios, as illustrated in the following example.
  
−
The ServiceEvent.moodCode is fixed to "EVN", which indicates documentation of a past service.
+
'''<span class="change-highlight">SubstanceAdministration.activityTime</span>'''
  
−
{| class='wikitable' 
+
<span class="change-highlight">SubstanceAdministration.activityTime is a time expression specifying when the substance administration activity occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. The substance administration activityTime can provide a needed administrative function, by providing a more inclusive time to be anticipated in scheduling. </span>
−
|+Table {{AUTOTABLENUM}}: Fixed ServiceEvent.moodCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 
−
|}
 
  
−
'''ServiceEvent.id'''
+
'''<span class="change-highlight">SubstanceAdministration.availabilityTime</span>'''
  
−
The optional unique identifier for the ServiceEvent.  
+
<span class="change-highlight">SubstanceAdministration.availabilityTime is the point in time at which information about a substance administration instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the substance administration itself. </span>
  
−
'''ServiceEvent.code'''
+
'''SubstanceAdministration.priorityCode'''
  
−
The particular kind of service event that the this instance represents within its class code.
+
The urgency under which the SubstanceAdministration happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The SubstanceAdministration.priorityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority ActPriority] concept domain.
−
The ServiceEvent.code is bound to the [http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode] concept domain.
 
  
−
'''ServiceEvent.statusCode'''
+
'''<span class="change-highlight">SubstanceAdministration.confidentialityCode</span>'''
  
−
The ServiceEvent.statusCode can take on any of the values defined in the D:[http://cda/infrastructure/vocabulary/ActStatus.htm ActStatus] domain.
+
<span class="change-highlight">Constraints around appropriate disclosure of information about this SubstanceAdministration, regardless of mood. The SubstanceAdministration.confidentialityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality Confidentiality] concept domain.</span>
  
−
'''ServiceEvent.effectiveTime'''
 
  
−
ServiceEvent.effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place.
+
'''SubstanceAdministration.repeatNumber'''
  
−
=====performer=====
+
An interval of integer numbers stating the minimal and maximal number of repetitions of the SubstanceAdministration.
  
−
The performer participant represents clinicians who actually and principally carry out the ServiceEvent.
+
'''<span class="change-highlight">SubstanceAdministration.languageCode</span>'''
  
−
{| class='wikitable' 
+
<span class="change-highlight">The primary language in which this SubstanceAdministrationstatement is specified, particularly the language of the SubstanceAdministration.text.  The SubstanceAdministration.languageCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage HumanLanguage] concept domain.</span>
−
|+Table {{AUTOTABLENUM}}: performer
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ParticipationType.htm#x_ServiceEventPerformer x_ServiceEventPerformer]||Closed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-functionCode-att functionCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ParticipationFunction D:ParticipationFunction]|| Open
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[1..1]||||
 
−
|}
 
  
−
'''performer.typeCode'''
+
'''<span class="change-highlight">SubstanceAdministration.isCriterionInd</span>'''
  
−
Allows for the optional identification of performers, primary performers and secondary performers.
+
<span class="change-highlight">Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.</span>
  
−
{| class='wikitable'
+
'''SubstanceAdministration.routeCode'''
−
|+Table {{AUTOTABLENUM}}: Value set for performer.typeCode
+
 
−
! style="text-align:left;"  colspan="5" | v:x_ServiceEventPerformer <small>[2.16.840.1.113883.1.11.19601] (CLOSED)</small>
+
The physiological path or route for introducing the therapeutic material into or onto the subject. Route, site of administration (administrationSiteCode), method of administration (methodCode) and the device used in administration are closely related. All four (if present) must be closely coordinated and in agreement. In some cases, the coding system used to specify one may pre-coordinate one or more of the others.  
−
|-
 
−
!Code!!Display Name!! !!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRF PRF]||performer||
 
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#PPRF PPRF]||primary performer
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#SPRF SPRF]||secondary performer||
 
−
|| ||
 
−
|-
 
−
!style="text-align:left;"  colspan="5" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 
−
|}
 
  
−
'''performer.functionCode'''
+
'''SubstanceAdministration.approachSiteCode'''
  
−
Performer.functionCode can be used to specify addition detail about the function of the performer (e.g. scrub nurse, third assistant). The functionCode is bound to the D:[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ParticipationFunction ParticipationFunction] concept domain.
+
The anatomical site or system through which the procedure reaches its target.  
  
−
'''performer.time'''
+
'''SubstanceAdministration.doseQuantity'''
  
−
Performer.time can be used to specify the time during which the performer is involved in the activity.
+
SubstanceAdministration.doseQuantity indicates how much medication is given per dose.  
  
−
=====AssignedEntity=====
+
'''SubstanceAdministration.rateQuantity'''
  
−
A performer is an entity in the role of assigned entity ([[#div-AssignedEntity|AssignedEntity]] class).  
+
SubstanceAdministration.rateQuantity can be used to indicate the rate at which the dose is to be administered (e.g., the flow rate for intravenous infusions).
  
−
=====Person=====
+
'''<span class="change-highlight">SubstanceAdministration.doseCheckQuantity</span>'''
  
−
An assigned entity is a person assigned to the role by the scoping organization.
+
<span class="change-highlight">The ratio of a quantity to be consumed over the period of time during which it expected to be consumed.</span>
−
The entity playing the role is a person ([[#div-person|Person]]] class).  
 
  
−
=====Organization=====
+
'''SubstanceAdministration.maxDoseQuantity'''
  
−
The entity scoping the role is an organization ([[#div-Organization|Organization]] class).
+
SubstanceAdministration.maxDoseQuantity is used to capture the maximum dose of the medication that can be given over a stated time interval (e.g., maximum daily dose of morphine, maximum lifetime dose of doxorubicin).
  
−
====<big>Order</big>====
+
'''SubstanceAdministration.administrationUnitCode'''
  
−
[[Image:Order.png|800px|border|center|Order]]
+
A unit for the administered substance.
 +
# This attribute SHOULD be used if and only if the material specified as the player of the Role attaching to the consumable participation is not in itself the finished dose form to be administered but a larger whole, pack, etc.
 +
# If the material so specified is the proper administered dose form, such as a tablet, capsule, etc. then this attribute SHOULD be valued NULL (not applicable).
 +
# If the material so specified is an amorphous substance (liquid, gas, powder, etc.) to be measured as a volume, mass, etc., then this attribute SHOULD remain NULL (not applicable).
 +
# If the material so specified is a container, and the content is to be measured as a volume, mass, etc., then this attribute SHOULD be specified as "measured portion".  
  
−
This class represents those orders that are fulfilled by this document. For instance, a provider orders an X-Ray. The X-Ray is performed. A radiologist reads the X-Ray and generates a report. The X-Ray order identifier is transmitted in the Order class, the performed X-Ray procedure is transmitted in the ServiceEvent class, and the ClinicalDocument.code would be valued with "Diagnostic Imaging Report".
 
  
−
=====inFullfillmentOf=====
+
<div align="center">Example {{AUTOEXAMPLENUM}}</div>
 +
<nowiki>
 +
<section>
 +
  <text>Take captopril 25mg PO every 12 hours, starting on
 +
    Jan 01, 2002, ending on Feb 01, 2002.
 +
  </text>
 +
  <entry>
 +
      <substanceAdministration classCode="SBADM" moodCode="RQO">
 +
        <effectiveTime xsi:type="IVL_TS">
 +
            <low value="20020101"/>
 +
            <high value="20020201"/>
 +
        </effectiveTime>
 +
        <effectiveTime xsi:type="PIVL_TS" operator="A">
 +
            <period value="12" unit="h"/>
 +
        </effectiveTime>
 +
        <routeCode code="PO"
 +
          codeSystem="2.16.840.1.113883.5.112"
 +
          codeSystemName="RouteOfAdministration"/>
 +
        <doseQuantity value="1"/>
 +
        <consumable>
 +
            <manufacturedProduct>
 +
              <manufacturedLabeledDrug>
 +
                  <code code="318821008"
 +
                  codeSystem="2.16.840.1.113883.6.96"
 +
                  codeSystemName="SNOMED CT"
 +
                  displayName="Captopril 25mg tablet"/>
 +
              </manufacturedLabeledDrug>
 +
            </manufacturedProduct>
 +
        </consumable>
 +
      </substanceAdministration>
 +
  </entry>
 +
</section>
 +
</nowiki>
  
−
The optional inFullfillmentOf class is used to associate a ClinicalDocument to an Order.  
+
=====consumable=====
 +
The capture of medication-related information also involves the interrelationship of SubstanceAdministration with several other classes.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed InFulfillmentOf.typeCode
+
|+Table {{AUTOTABLENUM}}: consumable
−
!Code!!Display Name
+
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#FLFS FLFS]||fulfills
+
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#CSM CSM]||consumable
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
+
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
 
|}
 
|}
  
−
=====Order=====
+
'''consumable.typeCode'''
  
−
A reference to the fulfilled order.  
+
The consumable.typeCode is fixed to "CSM" to represent a consumable participation.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Order Attributes
+
|+Table {{AUTOTABLENUM}}: Fixed consumable.typeCode
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm V:ActClassRoot]||Closed
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CSM CSM]||consumable
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#RQO RQO]||Fixed
+
!style="text-align:left;" colspan="2" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..*]||||
 
−
|-  
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-priorityCode-att priorityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActPriority.htm V:ActPriority]||Open
 
 
|}
 
|}
  
−
'''Order.classCode'''
+
'''consumable.contextControlCode'''
 +
 
 +
The consumable.contextControlCode is fixed to "OP". It means that the consumable identified will replace the set of consumables that have propagated from ancestor Acts, and will itself be the only consumable to propagate to any child Acts that allow context to be propagated.
 +
 
 +
=====ManufacturedProduct=====
  
−
The Order.classCode identifies the RIM Act class code of the order instance.
+
The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance via the ManufacturedProduct role class.
  
−
{| class='wikitable'   
+
'''ManufacturedProduct.classCode'''
−
|+Table {{AUTOTABLENUM}}: Value set for Order.classCode
+
 
−
! style="text-align:left;"  colspan="5" | V:ActClassRoot <small> [2.16.840.1.113883.1.11.13856] (CLOSED)</small>
+
The ManufacturedProduct.typeCode is fixed to "MANU" to represent the role of manufactured. The playing role is what was manufactured and the scoping role identifies the manufacturer.
 +
 
 +
{| class='wikitable'   
 +
|+Table {{AUTOTABLENUM}}: Fixed ManufacturedProduct.classCode  
 +
!Code!!Display Name
 
|-
 
|-
−
!Code!!Display Name!!  !!Code!!Display Name
+
|[http://cda/infrastructure/vocabulary/RoleClass.htm#MANU MANU]||manufactured
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACT ACT] ('''Default''')||act||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#COMPOSITION COMPOSITION]||composition, Attestable unit
+
!style="text-align:left;"  colspan="2" | <small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
 +
|}
 +
 
 +
'''ManufacturedProduct.id'''
 +
 
 +
An optional unique identifier assigned by the manufacturer.
 +
 
 +
=====LabeledDrug=====
 +
 
 +
The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name.
 +
 
 +
'''LabeledDrug.classCode'''
 +
 
 +
The LabeledDrug.classCode is fixed to "MMAT" which indicates the substance administered was manufactured. 
 +
 
 +
{| class='wikitable'  
 +
|+Table {{AUTOTABLENUM}}: Fixed LabeledDrug.classCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOC DOC]||document||
+
|[http://cda/infrastructure/vocabulary/EntityClass.htm#MMAT MMAT] ||A manufactured material.
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||clinical document
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CDALVLONE CDALVLONE]||CDA Level One clinical document||
+
!style="text-align:left;"  colspan="2" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#CONTAINER CONTAINER]||record container
+
|}
 +
 
 +
'''LabeledDrug.determinerCode'''
 +
 
 +
The determinerCode is fixed to "KIND", which indicates that the LabeledDrug referenced, represents a kind or class of Labeled drug.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed LabeledDrug.determinerCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CATEGORY CATEGORY]||category||
+
|[http://cda/infrastructure/vocabulary/EntityClass.htm#KIND KIND]||described
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCBODY DOCBODY]||document body
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOCSECT CATEGORY]||document section, Section||
+
!style="text-align:left;"  colspan="2" | <small> Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#TOPIC TOPIC]||topic
+
|}
 +
 
 +
'''LabeledDrug.code'''
 +
 
 +
The LabeledDrug.code is bound to the DrugEntity concept domain, which identifies a substance whose therapeutic effect is produced by chemical action within the body.
 +
 
 +
'''LabeledDrug.name''''
 +
 
 +
An optional non-unique textual identifier or moniker for the LabeledDrug.
 +
 
 +
=====Material=====
 +
 
 +
The Material entity can be used to identify non-drug administered substances such as vaccines and blood products and drugs.
 +
 
 +
'''Material.classCode'''
 +
 
 +
The Material.classCode is fixed to "MMAT" which indicates the material administered was manufactured.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Material.classCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#EXTRACT EXTRACT]||extract||
+
|[http://cda/infrastructure/vocabulary/EntityClass.htm#MMAT MMAT]||A manufactured material.
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#EHR EHR]||electronic health record
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#FOLDER FOLDER]||folder||
+
!style="text-align:left;"  colspan="2" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#GROUPER GROUPER]||grouper
+
|}
−
|-
+
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CLUSTER CLUSTER]||Cluster||
+
'''Material.determinerCode'''
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#ACCM ACCM]||accommodation
+
 
 +
The determinerCode is fixed to "KIND", which indicates that the Material referenced, represents a kind or class of Material.
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Material.determinerCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACCT ACCT]||account||
+
|[http://cda/infrastructure/vocabulary/EntityClass.htm#KIND KIND]||described
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#ACSN ACSN]||accession
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ADJUD ADJUD]||financial adjudication, financial adjudication results ||
+
!style="text-align:left;"  colspan="2" | <small> Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#CACT CACT]||control act
+
|}
 +
 
 +
'''Material.code'''
 +
 
 +
The Material.code is bound to the MaterialEntityClassType concept domain, which identifies types of materials.
 +
 
 +
'''Material.name'''
 +
 
 +
An optional non-unique textual identifier or moniker for the Material.
 +
 
 +
'''Material.desc'''
 +
 
 +
A textual or multimedia depiction of the Material.
 +
 
 +
'''Material.formCode'''
 +
 
 +
The physical state and nature of the material.
 +
 
 +
'''Material.lotNumberText'''
 +
 
 +
An identifier for a particular batch of manufactured material.
 +
 
 +
====<big><big>Supply</big></big>====
 +
 
 +
The Supply class represents dispensing, whereas the SubstanceAdministration class represents administration. Prescriptions are complex activities that involve both an administration request to the patient (e.g. take digoxin 0.125mg by mouth once per day) and a supply request to the pharmacy (e.g. dispense 30 tablets, with 5 refills). This should be represented in CDA by a SubstanceAdministration entry that has a component Supply entry. The nested Supply entry can have Supply.independentInd set to "false" to signal that the Supply cannot stand alone, without it's containing SubstanceAdministration. The following example illustrates a prescription representation in CDA.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Supply Attributes
 +
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActClass.htm#SPLY SPLY]||Fixed
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACTN ACTN]||action||
+
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ActMood.htm#x_DocumentSubstanceMood V:x_DocumentSubstanceMood]||Closed
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#INFO INFO]||information
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#STC STC]||state transition control||
+
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET] <[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#CNTRCT CNTRCT]||contract
+
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActSupplyType D:ActSupplyType]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#FCNTRCT FCNTRCT]||financial contract||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-actionNegationInd-att  actonNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#COV COV]||coverage
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONS CONS]||consent||
+
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#CONTREG CONTREG]||container registration
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CTTEVENT CTTEVENT]||clinical trial timepoint event||
+
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActStatus.htm#ActStatus V:ActStatus]||Closed
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#DISPACT DISPACT]||disciplinary action
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#EXPOS EXPOS]||exposure||
+
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#AEXPOS AEXPOS]||acquisition exposure
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#TEXPOS TEXPOS]||transmission exposure||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-activityTime-att activityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpltiming GTS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#INC INC]||incident
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#INFRM INFRM]||inform||
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-availabilityTime-att availabilityTime]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]||[0..1]||||
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#INVE INVE]||invoice element
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#LIST LIST]||working list||
+
|[http://cda/infrastructure/rim/rim.htm#Act-priorityCode-att priorityCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority D:ActPriority]||Open
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#MPROT MPROT]||monitoring program
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBS OBS]||Observation|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#ALRT ALRT]||detected issue
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-confidentialityCode-att confidentialityCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality D:Confidentiality]||Open
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLNTRL CLNTRL]||clinical trial
+
|[http://cda/infrastructure/rim/rim.htm#Act-repeatNumber-att repeatNumber]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-INT INT]>||[0..1]|| ||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONC CONC]||concern||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#COND COND]||Condition
+
|[http://cda/infrastructure/rim/rim.htm#Act-independentInd-att independentInd] ||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CASE CASE]||public health case|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#OUTB OUTB]||outbreak
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-languageCode-att languageCode]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage D:HumanLanguage]||Closed
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DGIMG DGIMG]||diagnostic image||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#GEN GEN]||genomic observation
+
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Act-isCriterionInd-att isCriterionInd]</span> ||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DETPOL DETPOL]||determinant peptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#EXP EXP]||expression level
+
|[http://cda/infrastructure/rim/rim.htm#Supply-quantity-att quantity]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ]||[0..1]|| ||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#LOC LOC]||locus||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#PHN PHN]||phenotype
+
|[http://cda/infrastructure/rim/rim.htm#Supply-expectedUseTime-att expectedUseTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]||  ||
 +
|}
 +
 
 +
'''Supply.classCode'''
 +
 
 +
The Supply.classCode is fixed to "SPLY" which is used to represent a Supply. Supply orders and deliveries are simple Acts that focus on the delivered product. The product is associated with the Supply Act via Participation.typeCode="product". With general Supply Acts, the precise identification of the Material (manufacturer, serial numbers, etc.) is important. Most of the detailed information about the Supply should be represented using the Material class.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Supply.classCode
 +
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#POL POL]||polypeptide|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#SEQ SEQ]||bio sequence
+
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPLY SPLY]||supply||
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SEQVAR SEQVAR]||bio sequence variation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#INVSTG INVSTG]||investigation
+
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
 +
 
 +
'''Supply.moodCode'''
 +
 
 +
The Supply.moodCode is bound to the x_ClinicalStatementSubstanceMood value set.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Supply.moodCode
 +
! style="text-align:left;"  colspan="5" |  V:x_ClinicalStatementSubstanceMood <small>[2.16.840.1.113883.1.11.19645] (CLOSED) </small>
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBSSER OBSSER]||observation series|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#OBSCOR OBSCOR]||correlated observation sequences
+
!Code!!Display Name!! !!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#POS POS]||position|| ||[http://cda/infrastructure/vocabulary/ActClass.htm#POSACC POSACC]||position accuracy
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event|| ||[http://cda/infrastructure/vocabulary/ActMood.htm#DEF DEF]||definition
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#POSCOORD POSCOORD]||position coordinate||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SPCOBS SPCOBS]||specimen observation
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#RQO RQO]||request||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#INT INT]||intent
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#VERIF VERIF]||Verification||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ROIBND ROIBND]||bounded ROI
+
|[http://cda/infrastructure/vocabulary/ActMood.htm#PRMS PRMS]||promise||  ||[http://cda/infrastructure/vocabulary/ActMood.htm#PRP PRP]||proposal
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI|| 
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#PCPR PCPR]||care provision
+
|}
 +
 
 +
'''Supply.id'''
 +
 
 +
The optional Supply.id is used to uniquely identify the supply activity.
 +
 
 +
'''Supply.code'''
 +
 
 +
The optional Supply.code is bound to the ActSupplyType concept domain, which is used to further define the type of supply for order or distribution.  Examples:
 +
* central supply
 +
* materials management
 +
* nurse station supply
 +
 
 +
'''<span class="change-highlight">Supply.actionNegationInd</span>'''
 +
 
 +
<span class="change-highlight">The Supply.actionNegationInd works as a negative existence quantifier on the actual, intended or described Supply event. In Event mood, it indicates the defined supply act did not occur. In Intent mood, it indicates the defined supply act is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.
 +
 
 +
The actionNegationInd negates the Supply act as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, repeatNumber, independentInd, isCriterionInd, quantity, expectedUseTime and any of their components.
 +
 
 +
The remaining properties represent the document characteristics, E.g. Supply.id, Supply.moodCode, Supply.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance. </span>
 +
 
 +
'''Supply.text'''
 +
 
 +
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Supply activity.
 +
 
 +
'''Supply.statusCode'''
 +
 
 +
The status reflects the state of the activity.  The RIM based [http://cda/infrastructure/rim/rim.htm#ActStatus  state machine diagram] depicts the allowable state transitions that an Supply.StatusCodes can take on. 
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Supply.statusCode
 +
! style="text-align:left;"  colspan="5" | V:ActStatus <small>[2.16.840.1.113883.1.11.15933] (CLOSED) </small>
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ENC ENC]||encounter||  
+
!Code!!Display Name!! !!Code!!Display Name
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#POLICY POLICY]||policy
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#JURISPOL JURISPOL]||jurisdictional policy|| 
 
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#ORGPOL ORGPOL]||organizational policy
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SCOPOL SCOPOL]||scope of practice policy||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#normal normal]||normal|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#aborted aborted]||aborted
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#STDPOL STDPOL]||standard of practice policy
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#PROC PROC]||procedure||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#active active]||active|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#cancelled cancelled]||cancelled
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#SBEXT SBEXT]||Substance Extraction
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPECCOLLECT SPECCOLLECT]||Specimen Collection||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#completed completed]||completed|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#held held]||held
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#SBADM SBADM]||substance administration
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#REG REG]||registration||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#new new]||new|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#suspended suspended]||suspended
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#REV REV]||review
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPCTRT SPCTRT]||specimen treatment||
+
|[http://cda/infrastructure/vocabulary/ActStatus.htm#nullified nullified]||nullified|| ||[http://cda/infrastructure/vocabulary/ActStatus.htm#obsolete obsolete]||obsolete
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#SPLY SPLY]||supply
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#DIET DIET]||diet||
+
!style="text-align:left;"  colspan="5" |<small> Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14</small>
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#STORE STORE]||storage
+
|}
−
|-
+
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SUBST SUBST]||Substitution||
+
'''Supply.effectiveTime'''
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#TRFR TRFR]||transfer
+
 
−
|-
+
<span class="change-highlight">Supply.effectiveTime is used to indicate the clinically or operationally relevant time of a supply, exclusive of administrative activity. </span>
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#TRNS TRNS]||transportation||
+
 
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#XACT XACT]|| financial transaction
+
'''<span class="change-highlight">Supply.activityTime</span>'''
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CNOD CNOD] ('''Deprecated''')||Condition Node||
 
−
||[http://cda/infrastructure/vocabulary/ActClass.htm#LLD LLD] ('''Deprecated''')||left lateral decubitus
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#PRN PRN] ('''Deprecated''')||prone ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#RLD RLD] ('''Deprecated''')||right lateral decubitus
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#SFWL SFWL] ('''Deprecated''')||Semi-Fowler's ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SIT SIT] ('''Deprecated''')||sitting
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#STN STN] ('''Deprecated''')||standing ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SUP SUP] ('''Deprecated''')||supine
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#RTRD RTRD] ('''Deprecated''')|| reverse trendelenburg ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRD TRD] ('''Deprecated''')||trendelenburg
 
−
|-
 
−
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
−
|}
 
  
−
'''Order.moodCode'''
+
<span class="change-highlight">Supply.activityTime is a time expression specifying when a supply occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the Supply activity occurred, is supposed to occur, is scheduled to occur, etc. </span>
  
−
The Order.moodCode is fixed to "RQO", which indicates we are referencing the actual order instance.  
+
'''<span class="change-highlight">Supply.availabilityTime</span>'''
  
−
{| class='wikitable' 
+
<span class="change-highlight">Supply.availabilityTime is the point in time at which information about an Supply instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the Supply itself.</span>
−
|+Table {{AUTOTABLENUM}}: Fixed Order.moodCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActMood.htm#RQO RQO]||request
 
−
|-
 
−
!style="text-align:left;" colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 
−
|}
 
  
−
'''Order.id'''
+
'''Supply.priorityCode'''
  
−
The Order.id is a unique identifier for the order that was fulfilled.
+
The urgency under which the Supply activity happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Supply.priorityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActPriority ActPriority] concept domain.
  
−
'''Order.code'''
+
'''<span class="change-highlight">Supply.confidentialityCode</span>'''
  
−
The particular kind of order that the this instance represents within its class code.
+
<span class="change-highlight">Constraints around appropriate disclosure of information about this Supply activity, regardless of mood. The Supply.confidentialityCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#Confidentiality Confidentiality] concept domain.</span>
−
The optional Order.code is bound to the [http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode] concept domain.
 
  
−
'''Order.priorityCode'''
+
'''Supply.repeatNumber'''
  
−
The optional Order.priorityCode, identifies the priority requested when the order was placed.  It is bound to the D:ActPriority concept domain.
+
An interval of integer numbers stating the minimal and maximal number of repetitions of the Supply activity.
  
−
====<big>Consent</big>====
+
'''Supply.independentInd'''
  
−
[[Image:Consent.png|800px|border|center|Consent]]
+
An indicator specifying whether the Act can be manipulated independently of other Acts or only through a super-ordinate composite Act that has this Act as a component. By default the independentInd should be true. An Act definition is sometimes marked with independentInd=false if the business rules would not allow this act to be ordered without ordering the containing act group.  
  
−
Provides references to consents on file.  
+
'''<span class="change-highlight">Supply.languageCode</span>'''
  
−
=====authorization=====
+
<span class="change-highlight">The primary language in which this Supply statement is specified, particularly the language of the Supply.text.  The Supply.languageCode is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#HumanLanguage HumanLanguage] concept domain.</span>
  
−
The optional authorization class is used to associate a ClinicalDocument to a Consent.   
 
  
−
{| class='wikitable' 
+
'''<span class="change-highlight">Supply.isCriterionInd</span>'''
−
|+Table {{AUTOTABLENUM}}: authorization Attributes
 
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#AUTH AUTH]||Fixed
 
−
|}
 
  
−
'''authorization.typeCode'''
+
<span class="change-highlight">Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.</span>
  
−
{| class='wikitable'
+
'''Supply.quantity'''
−
|+Table {{AUTOTABLENUM}}: Fixed authorization.typeCode
 
−
|-
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#AUTH AUTH]||authorized by
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 
−
|}
 
−
 
 
−
=====Consent=====
 
  
−
This class references the consents associated with this document.
+
The optional Supply.quantity is used to represent the amount of material that was or is to be supplied.
  
−
{| class='wikitable'
+
'''Supply.expectedUseTime'''
−
|+Table {{AUTOTABLENUM}}: Consent Attributes
 
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#CONS CONS]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att    moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[0..*]||||
 
−
|- 
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
 
−
|-
 
−
|[http://cda/infrastructure/rim/rim.htm#Act-statusCode-att statusCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/ActStatus.htm#completed completed]||Fixed
 
−
|}
 
  
−
'''Consent.classCode'''
+
Th optional Supply.expectedUseTime is used to identify the period time over which the supplied product is expected to be used.
  
−
The Consent.classCode is fixed to "CONS" to represent a consent. The Consent class represents informed consents and all similar medico-legal transactions between the patient (or his legal guardian) and the provider.
+
=====Product=====
  
−
{| class='wikitable' 
+
The dispensed product is associated with the Supply act via a product participant, which connects to the same ManufacturedProduct role used for SubstanceAdministration.
−
|+Table {{AUTOTABLENUM}}: Fixed Consent.classCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONS CONS]||consent
 
−
|-
 
−
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 
−
|}
 
  
−
'''Consent.moodCode'''
+
'''Product.typeCode'''
  
−
The Consent.moodCode is fixed to "EVN" (event) which indicates the consent has already been captured and is assumed to be on file.
+
The Product.typeCode is fixed to "PRD" which represents a product participation.  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}:Fixed Consent.moodCode
+
|+Table {{AUTOTABLENUM}}: Fixed product.typeCode
 
!Code!!Display Name
 
!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRD PRD]||product
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
+
!style="text-align:left;"  colspan="2" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 
|}
 
|}
  
−
'''Consent.id'''
+
=====ManufacturedProduct=====
  
−
Optional identifier for the consent.
+
See [[#ManufacturedProduct|ManufacturedProduct]] above.
  
−
'''Consent.code'''
 
  
−
The Consent.code is bound to the [http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode] concept domain. It is used to optionally identify the type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party).
+
<div align="center">Example {{AUTOEXAMPLENUM}}</div>
 +
<nowiki>
 +
<section>
 +
  <text>Digoxin 0.125mg, 1 PO qDay, #30, 5 refills.</text>
 +
  <entry>
 +
      <substanceAdministration classCode="SBADM" moodCode="RQO">
 +
        <effectiveTime xsi:type="PIVL_TS">
 +
            <period value="24" unit="h"/>
 +
        </effectiveTime>
 +
        <routeCode code="PO"
 +
          codeSystem="2.16.840.1.113883.5.112"
 +
          codeSystemName="RouteOfAdministration"/>
 +
        <doseQuantity value="1"/>
 +
        <consumable>
 +
            <manufacturedProduct>
 +
              <manufacturedLabeledDrug>
 +
                  <code code="317896006"
 +
                  codeSystem="2.16.840.1.113883.6.96"
 +
                  codeSystemName="SNOMED CT"
 +
                  displayName="Digoxin 125micrograms tablet"/>
 +
              </manufacturedLabeledDrug>
 +
            </manufacturedProduct>
 +
        </consumable>
 +
        <entryRelationship typeCode="COMP">
 +
            <supply classCode="SPLY" moodCode="RQO">
 +
              <repeatNumber>
 +
                  <low value="0"/>
 +
                  <high value="5"/>
 +
              </repeatNumber>
 +
              <independentInd value="false"/>
 +
              <quantity value="30"/>
 +
            </supply>
 +
        </entryRelationship>
 +
      </substanceAdministration>
 +
  </entry>
 +
</section>
 +
</nowiki>
  
−
'''Consent.statusCode'''
+
===Entry Participants===
  
−
Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal "completed") and should be on file.
+
CDA structures and entries can have various participants, some of which are also defined in the CDA header. As described in the discussion of CDA context (see [[#CDA_Context|CDA Context]]), participants propagated from the header can be overridden within the body.
  
−
{| class='wikitable' 
+
====<big>author</big>====
−
|+Table {{AUTOTABLENUM}}: Fixed Consent.statusCode
 
−
!Code!!Display Name
 
−
|-
 
−
|[http://cda/infrastructure/vocabulary/ActStatus.htm#completed completed]||completed
 
−
|-
 
−
!style="text-align:left;"  colspan="2" |<small> Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14</small>
 
−
|}
 
  
−
====<big>EncompassingEncounter</big>====
+
The author participant (described above, see [[#author|author]]), can be ascribed to a CDA section where it overrides the value(s) propagated from the CDA header, or can be ascribed to a CDA entry, where it overrides the value(s) propagated from a CDA section and propagates to nested entries.
  
 +
====<big>consumable</big>====
  
−
[[Image:EncompassingEncounter.png|800px|border|center|EncompassingEncounter]]
+
The consumable participant is described above (see [[#Entry_Acts|Entry Acts]]).
  
−
This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.
+
====<big>informant</big>====
 +
 
 +
The informant participant (described above, see [[#informant|informant]]), can be ascribed to a CDA section where it overrides the value(s) propagated from the CDA header, or can be ascribed to a CDA entry, where it overrides the value(s) propagated from a CDA section and propagates to nested entries.
  
−
=====componentOf=====
+
====<big>participant</big>====
  
−
The optional componentOf class is used to associate the ClinicalDocument to an EncompassingEncounter.  
+
Can be used to represent any other participant that cannot be represented with one of the more specific participants. The participant can be ascribed to a CDA entry, and propagates to nested CDA entries, unless overridden.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: componentOf Attributes
+
|+Table {{AUTOTABLENUM}}: informant
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#INF INF]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Participation-functionCode-att  functionCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ParticipationFunction D:ParticipationFunction]|| Open
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMP COMP]||Fixed
+
|[http://cda/infrastructure/rim/rim.htm#Participation-contextControlCode-att contextControlCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||Fixed
−
|}
 
−
 
 
−
'''componentOf.typeCode'''
 
−
 
 
−
The componentOf.typeCode is fixed to "COMP", which indicates that the ClinicalDocument was created within the context of an encounter (encompassingEncounter).
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed componentOf.typeCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMP COMP]||component
+
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]|| ||
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
+
|[http://cda/infrastructure/rim/rim.htm#Participation-awarenessCode-att awarenessCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://ceb/infrastructure/vocabulary/voc_ConceptDomains.htm#TargetAwareness D:TargetAwareness]||Open
 
|}
 
|}
  
−
=====EncompassingEncounter=====
+
'''participant.typeCode'''
  
−
The EncompassingEncounter represents an interaction between a patient and care provider(s) for the purpose of providing healthcare-related service(s).  
+
The participant.typeCode is bound to the v:ParticipationType value set.  This enables a wide range of participation types to be selected.  '''Note''': Where an existing participation exists, it should be used in preference to the generic participation, failure to do so, will result in needlessly additional complexity for implementations.
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: EncompassingEncounter Attributes
+
|+Table {{AUTOTABLENUM}}: Value set for participant.typeCode
−
!Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
! style="text-align:left;"  colspan="5" | v:ParticipationType <small>[2.16.840.1.113883.1.11.10901] (CLOSED)</small>
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#ENC ENC]||Fixed
+
!Code!!Display Name!! !!Code!!Display Name
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att    moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PART PART]||Participation||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ADM ADM]||admitter
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[0..*]||||
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#ATND ATND]||attender||
−
|- 
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ADM ADM]||admitter
−
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActEncounterCode.htm#ActCode V:ActEncounterCode]||Open
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Act-effectiveTime-att effectiveTime]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]||||
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CALLBCK CALLBCK]|| callback contact ||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#CON CON]||consultant
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#PatientEncounter-admissionReferralSourceCode-att admissionReferralSourceCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EncounterReferralSource D:EncounterReferralSourceCode]||Open
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#DIS DIS]||discharger||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ESC ESC]||escort
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#PatientEncounter-dischargeDispositionCode-att dischargeDispositionCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EncounterDischargeDisposition D:EncounterDischargeDisposition]||Open
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#REF REF]||referrer||
−
|}
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#TRANS TRANS]||Transcriber
−
 
+
|-
−
'''EncompassingEncounter.classCode'''
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#ENT ENT]||data entry person||
−
 
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#WIT WIT]||witness
−
The EncompassingEncounter.classCode is fixed to "ENC" to represent a encounter. The encounter class is used to represent an interaction between a patient and healthcare participant(s) for the purpose of providing patient service(s) or assessing the health status of a patient.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed EncompassingEncounter.classCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActClass.htm#ENC ENC]||encounter
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CST CST]||custodian||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#DIR DIR]||direct target
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#BBY BBY]||baby||
−
|}
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#DEV DEV]||device
−
 
 
−
'''EncompassingEncounter.moodCode'''
 
−
 
 
−
The EncompassingEncounter.moodCode is fixed to "EVN" (event) which indicates that the encounter is on-going or completed.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed EncompassingEncounter.moodCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#NRD NRD]||non-reuseable device||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#RDV RDV]||reusable device
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#EXPAGNT EXPAGNT]||ExposureAgent||
−
|}
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#EXPART EXPART]||ExposureParticipation
−
 
+
|-
−
'''EncompassingEncounter.id'''
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#EXPTRGT EXPTRGT]||ExposureTarget||
−
 
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#EXSRC EXSRC]||ExposureSource
−
The optional EncompassingEncounter.id can be used to uniquely identify the encounter.
 
−
 
 
−
'''EncompassingEncounter.code'''
 
−
 
 
−
The optional EncompassingEncounter.code is bound to the ActEncounterCode value set.  
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Value set for EncompassingEncounter.code
 
−
! style="text-align:left;"  colspan="5" | V:ActEncounterCode <small> [2.16.840.1.113883.1.11.13955] (OPEN)</small>
 
 
|-
 
|-
−
!Code!!Display Name!!  !!Code!!Display Name
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#IND IND]||indirect target||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#BEN BEN]||beneficiary
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActCode.htm#AMB AMB]||ambulatory|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#EMER EMER]||emergency
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CAGNT CAGNT]||causative agent||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#COV COV]||coverage target
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActCode.htm#FLD FLD]||field|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#HH HH]||home health
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#GUAR GUAR]||guarantor party||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#HLD HLD]||holder
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActCode.htm#IMP IMP]||inpatient encounter|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#ACUTE ACUTE]||inpatient acute
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#DON DON]||donor||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#RCV RCV]||receiver
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActCode.htm#NONAC NONAC]||virtual|| ||[http://cda/infrastructure/vocabulary/ActCode.htm#SS SS]||short stay
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#IRCP IRCP]||information recipient||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#NOT NOT]||ugent notification contact
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ActCode.htm#VR VR]||inpatient non-acute|| || ||
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRCP PRCP]||primary information recipient||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#REFB REFB]||Referred By
 
|-
 
|-
−
!style="text-align:left;"  colspan="5" | <small> Code System: ActCode (HL7) Code System OID: 2.16.840.1.113883.5.4</small>
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#REFT REFT]||Referred to||
−
|}
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#TRC TRC]||tracker
−
 
 
−
'''EncompassingEncounter.effectiveTime'''
 
−
 
 
−
For Encounters, the effectiveTime is the "administrative" time, i.e., the encounter start and end date as established by business rules. <span class="change-highlight">    For inpatient encounters, the effectiveTime/low value is the admission date and time and the effectiveTime/high value is the discharge date and time.  Note: If the encounter is still active at the time of document creation, the effectiveTime/high element can be omitted to indicate the encounter is on-going.</span>
 
−
 
 
−
'''EncompassingEncounter.admissionReferralSourceCode'''
 
−
 
 
−
The optional EncompassingEncounter.admissionReferralSourceCode can be use to depict the type of place or organization responsible for the patient's care immediately prior to a patient encounter.
 
−
 
 
−
'''EncompassingEncounter.dischargeDispositionCode'''
 
−
 
 
−
The optional EncompassingEncounter.dischargeDispositionCode can be used to depict the disposition of the patient at the time of hospital discharge (e.g., discharged to home, expired, against medical advice, etc.).
 
−
 
 
−
=====location=====
 
−
 
 
−
The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. 
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: location
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#LOC LOC]||Fixed
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#LOC LOC]||location||
−
|}
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#DST DST]||destination
−
 
 
−
'''location.typeCode'''
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: Fixed participant.typeCode
 
−
!Code!!Display Name
 
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#LOC LOC]||location
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#ELOC ELOC]||entry location||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ORG ORG]||origin
 
|-
 
|-
−
!style="text-align:left;"  colspan="2" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#RML RML]||remote||
−
|}
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#VIA VIA]||via
−
 
 
−
=====HealthCareFacility=====
 
−
 
 
−
The HealthCareFacility class supports the identification of the service delivery location. The location may be the setting (place) with an optional organizational reference, or a reference to the healthcare organization.
 
−
 
 
−
{| class='wikitable' 
 
−
|+Table {{AUTOTABLENUM}}: HealthCareFacility
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
 
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#SDLOC SDLOC]||Fixed
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#RESP RESP]||responsible party||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#VRF VRF]||verifier
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-id-att  id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||  
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUTHEN AUTHEN]||authenticator||
 +
|| ||
 
|-
 
|-
−
|[http://cda/infrastructure/rim/rim.htm#Role-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/vs_RoleCode.htm#ServiceDeliveryLocationRoleType V:ServiceDeliveryLocation]|| Open
+
!colspan="5" |Use the following participations, only if the other participations provided in CDA will not work
−
|}
+
|-
−
 
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#RCT RCT]||record target||
−
'''HealthCareFacility.classCode'''
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#AUT AUT]||author (originator)
−
 
+
|-
−
The HealthCareFacility.classCode is bound to the ServiceDeliveryLocation value set and defaulted to the "SDLOC" to indicate the service delivery location.
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#INF INF]||informant||
−
 
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#CSM CSM]||consumable
−
{| class='wikitable' 
+
|-
−
|+Table {{AUTOTABLENUM}}: Value set for  HealthCareFacility.classCode
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRD PRD]||product||
−
! style="text-align:left;"  colspan="5" | v:RoleClassServiceDeliveryLocation <small>[2.16.840.1.113883.1.11.16927] (CLOSED) </small>
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#SBJ SBJ]||subject
 
|-
 
|-
−
!Code!!Display Name!! !!Code!!Display Name
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#SPC SPC]||specimen||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRF PRF]||performer
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SDLOC SDLOC] ('''Default''')||service delivery location||
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#DIST DIST]||distributor||
−
||[http://cda/infrastructure/vocabulary/RoleClass.htm#DSDLOC DSDLOC]||dedicated service delivery location, health care facility
+
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#PPRF PPRF]||primary performer
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ISDLOC ISDLOC] ||incidental service delivery location|| || ||
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#SPRF SPRF]||secondary performer||
 +
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#LA LA]||legal authenticator
 
|-
 
|-
−
!style="text-align:left;"  colspan="5" |<small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
+
!style="text-align:left;"  colspan="5" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 
|}
 
|}
  
−
'''HealthCareFacility.id'''
+
'''participant.functionCode'''
  
−
An optional HealthCareFacility.id can be sent to uniquely identify the health care facility.
+
The participant.functionCode is bound to the concept domain ParticipationFunction, which is used to specify the exact function an actor had in a service in all necessary detail. This domain may include local extensions (Open).  
  
−
'''HealthCareFacility.code'''
+
'''participant.contextControlCode'''
  
−
The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. A value set ServiceDeliveryLocationRoleType is provided for the this field.
+
The participant.contextControlCode is fixed to "OP". Any participant(s) defined in a clinical entry, will override the participants with the same typeCode propagating from ancestor elements, in the header, body or sections.  
  
−
'''Note:''' In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "Diabetes Clinic Progress Note". The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply "Clinic Progress Note" and the value of HealthCareFacility.code is "cardiology clinic"), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.
+
{| class='wikitable'
 +
|+Table {{AUTOTABLENUM}}: Fixed participant.contextControlCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ContextControl.htm#OP OP]||overriding, propagating
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System:  ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057</small>
 +
|}
  
−
=====Place=====
+
'''participant.time'''
  
−
The entity playing the role of HealthCareFacility is a place ([[#div-Place|Place]] class).
+
The time during which the participant is involved in the act through this Participation.
  
−
The setting (place) and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the setting for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow.
+
'''participant.awarenessCode'''
  
−
=====Organization=====
+
The extent to which the Entity playing the participating Role is aware of the associated Act. For diagnostic observations, the patient, family member or other participant may not be aware of the patient's terminal illness. Because this attribute typically indicates that awareness is in question, it normally describes a target Participation (e.g., that of a patient). If the awareness, denial, unconsciousness, etc. is the subject of medical considerations (e.g., part of the problem list), explicit observations should be employed: this simple attribute in the Participation cannot represent information sufficient to support medical decision-making.  
−
 
 
−
The entity scoping the HealthCareFacility role is an organization ([[#div-Organization|Organization]] class).
 
−
When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place.
 
−
 
 
−
=====responsibleParty=====
 
−
 
 
−
The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.
 
  
−
'''responsibleParty.typeCode'''
+
=====ParticipantRole=====
  
−
The responsibleParty.typeCode is fixed to "RESP" to indicate the responsible party i.e. The person or organization that has primary responsibility for the encounter. The responsible party is not necessarily present in an action, but is accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. This responsibility may be ethical, legal, contractual, fiscal, or fiduciary in nature.
+
A participant is an entity playing one of several possible roles (ParticipantRole class). The entity playing the role is a device (Device class) or other entity (PlayingEntity class).  
  
 
{| class='wikitable'   
 
{| class='wikitable'   
−
|+Table {{AUTOTABLENUM}}: Fixed responsibleParty.typeCode
+
|+Table {{AUTOTABLENUM}}: ParticipantRole
−
!Code!!Display Name
+
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_RoleClass.htm#RoleClassRoot V:RoleClassRoot]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Role-id-att  id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Role-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#RoleCode D:RoleCode]|| Open
 
|-
 
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#RESP RESP]||responsible party
+
|[http://cda/infrastructure/rim/rim.htm#Role-addr-att  addr ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-AD AD]>||[0..*]|| ||
 
|-
 
|-
−
!style="text-align:left;" colspan="2" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
+
|[http://cda/infrastructure/rim/rim.htm#Role-telecom-att telecom ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TEL TEL]>||[0..*]|| ||
 
|}
 
|}
  
−
A responsibleParty is a person or organization in the role of an assigned entity (AssignedEntity class). An assigned entity is a person assigned to the role by the scoping organization. The entity playing the role is a person (Person class). The entity scoping the role is an organization (Organization class).
+
'''ParticipantRole.classCode'''
  
−
When the responsible party is an organization, the value for AssignedEntity.classCode is "ASSIGNED", and the responsible party is reflected by the presence of a scoping Organization, without a playing entity.
+
The ParticipantRole.classCode can be any role defined in the V:RoleClassRoot value set, not already provided for the Clinical Statement choice pattern.  
  
−
=====AssignedEntity=====
+
{| class='wikitable' 
−
 
+
|+Table {{AUTOTABLENUM}}: Value set for ParticipantRole.classCode 
−
A performer is an entity in the role of assigned entity ([[#div-AssignedEntity|AssignedEntity]] class).  
+
! style="text-align:left;"  colspan="5" |  V:RoleClassRoot <small>[2.16.840.1.113883.1.11.13940] (CLOSED) </small>
−
 
+
|-
−
=====Person=====
+
!Code!!Display Name!! !!Code!!Display Name
−
 
+
|-
−
An assigned entity is a person assigned to the role by the scoping organization.  
+
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ROL ROL] ('''Default''')||role||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#AFFL AFFL]||affiliate
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#AGNT AGNT]||agent||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ASSIGNED ASSIGNED]||assigned entity
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#COMPAR COMPAR]||commissioning party||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#SGNOFF SGNOFF]||signing authority or officer
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CON CON]||contact||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ECON ECON]||emergency contact
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#NOK NOK]||next of kin||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#GUARD GUARD]||guardian
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CIT CIT]||citizen||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#COVPTY COVPTY]||covered party
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CLAIM CLAIM]||claimant||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#NAMED NAMED]||named insured
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#DEPEN DEPEN]||dependent||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#INDIV INDIV]||individual
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SUBSCR SUBSCR]||subscriber||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PROG PROG]||program eligible
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CRINV CRINV]||clinical research investigator||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CRSPNSR CRSPNSR]||clinical research sponsor
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#EMP EMP]||employee||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#MIL MIL]||military person
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#GUAR GUAR]||guarantor||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#INVSBJ INVSBJ]||Investigation Subject
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#CASEBJ CASEBJ]||Case Subject||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#RESBJ RESBJ]||research subject
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#LIC LIC]||licensed entity||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#NOT NOT]||notary public
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PROV PROV]||healthcare provider||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PAT PAT]||patient
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PAYEE PAYEE]||payee||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PAYOR PAYOR]||invoice payor
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#POLHOLD POLHOLD]||policy holder||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#QUAL QUAL]||qualified entity
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SPNSR SPNSR]||underwriter||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#STD STD]||student
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#UNDWRT UNDWRT]||coverage sponsor||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CAREGIVER CAREGIVER]||caregiver
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PRS PRS]||personal relationship||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ACCESS ACCESS]||access
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ADMM ADMM]||Administerable Material||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#BIRTHPL BIRTHPL]||birthplace
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#DEATHPLC DEATHPLC]||place of death||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#DST DST]||distributed material
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#RET RET]||retailed material||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#EXPR EXPR]||exposed entity
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#HLD HLD]||held entity||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#HLTHCHRT HLTHCHRT]||health chart
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#IDENT IDENT]||identified entity||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#MANU MANU]||manufactured product
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#THER THER]||therapeutic agent||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#MNT MNT]||maintained entity
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#OWN OWN]||owned entity||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#RGPR RGPR]||regulated product
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SDLOC SDLOC]||service delivery location||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#DSDLOC DSDLOC]||dedicated service delivery location, health care facility
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ISDLOC ISDLOC]||incidental service delivery location||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#TERR TERR]||territory of authority
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#USED USED]||used entity||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#WRTE WRTE]||warranted product
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#EQUIV EQUIV]||equivalent entity||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#SAME SAME]||same
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SUBY SUBY]||subsumed by||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#GEN GEN]||has generalization
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#GRIC GRIC]||has generic||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#INST INST]||instance
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SUBS SUBS]||subsumer||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#CONT CONT]||content
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#EXPAGTCAR EXPAGTCAR]||exposure agent carrier||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#EXPVECTOR EXPVECTOR]||exposure vector
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#FOMITE FOMITE]||fomite||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#INGR INGR]||ingredient
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ACTI ACTI]||active ingredient||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ACTIB ACTIB]||active ingredient - basis of strength
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ACTIM ACTIM]||active ingredient - moiety is basis of strength||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ACTIR ACTIR]||active ingredient - reference substance is basis of strength
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ADTV ADTV]||additive||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#BASE BASE]||base
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#IACT IACT]||inactive ingredient||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#COLR COLR]||color additive, color
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#FLVR FLVR]||flavor additive, flavor ||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#PRSV PRSV]||preservative
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#STBL STBL]||stabilizer||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#LOCE LOCE]||located entity
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#STOR STOR]||stored entity||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#MBR MBR]||member
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#PART PART]||part||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ACTM ACTM]||active moiety
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SPEC SPEC]||specimen||
 +
||[http://cda/infrastructure/vocabulary/RoleClass.htm#ALQT ALQT]||aliquot
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#ISLT ISLT]||isolate||
 +
|| ||
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
 +
|}
 +
 
 +
'''ParticipantRole.id'''
 +
 
 +
The optional participantRole.id is a unique identifier for the player Entity in this Role.
 +
 
 +
'''ParticipantRole.code'''
 +
 
 +
The optional ParticipantRole.code is bound the the EntityCode concept domain.
 +
 
 +
'''ParticipantRole.addr'''
 +
 
 +
The optional ParticipantRole.addr is the postal address for the Entity while in the Role.
 +
 
 +
'''ParticipantRole.telecom'''
 +
 
 +
The optional ParticipantRole.telecom is the telecommunication address (phone number) for the Entity while in the Role.
 +
 
 +
=====Device=====
 +
 
 +
Scoping the ParticipantRole is an entity (Entity class).
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Device
 +
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#DEV DEV]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE  INSTANCE]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EntityCode D:EntityCode] ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-manufacturerModelName-att  manufacturerModelName ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SC SC]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ManufacturerModelName  D:ManufacturerModelName ] ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#softwareName-desc-att  softwareName ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SC SC]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#SoftwareName  D:SoftwareName ] ||
 +
|}
 +
 
 +
'''Device.classCode'''
 +
 
 +
The Device.classCode is defaulted to "DEV", but can take on any value defined in the EntityClassDevice value set.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Device.classCode 
 +
! style="text-align:left;"  colspan="5" |  V:EntityClassDevice <small>[2.16.840.1.113883.1.11.11623] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!! !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#DEV DEV] ('''Default''')||role||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#CER CER]||certificate representation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#MODDV MODDV]||imaging modality, ImagingModalityEntity||
 +
|| ||
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
 +
|}
 +
 
 +
'''Device.determinerCode'''
 +
 
 +
The determinerCode is fixed to "INSTANCE", which indicates we are referencing a specific device.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Device.determinerCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System:  EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
 +
|}
 +
 
 +
'''Device.code'''
 +
 
 +
The optional Device.code is bound to the EntityCode domain.
 +
 
 +
'''Device.manufacturerModelName'''
 +
 
 +
The optional Device.manufacturerModelName is used to convey a coded name for the device.
 +
 
 +
'''Device.softwareName'''
 +
 
 +
The optional Device.softwareName is used to convey a coded name for the software used to author content.
 +
 
 +
<div id="div-PlayingEntity"></div>
 +
 
 +
=====PlayingEntity=====
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: PlayingEntity
 +
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#DEV DEV]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE  INSTANCE]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EntityCode D:EntityCode] ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-quantity-att  quantity]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PQ PQ]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-name-att  name]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-PN PN]>||[0..1]||  ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#softwareName-desc-att  desc]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||  ||
 +
|}
 +
 
 +
'''PlayingEntity.classCode'''
 +
 
 +
The PlayingEntity.classCode is bound to the V:EntityClassRoot value set.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for PlayingEntity.classCode 
 +
! style="text-align:left;"  colspan="5" |  V:EntityClassRoot <small>[2.16.840.1.113883.1.11.13922] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!! !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#ENT ENT] ('''Default''')||entity||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#HCE HCE]||health chart entity
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#LIV LIV]||living subject||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#NLIV NLIV]||non-person living subject
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#ANM ANM]||animal||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#MIC MIC]||microorganism
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#PLNT PLNT]||plant||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#PSN PSN]||person
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#MAT MAT]||material||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#CHEM CHEM]||chemical substance
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#FOOD FOOD]||food||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#MMAT MMAT]||manufactured material
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#CONT CONT]||container||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#HOLD HOLD]||holder
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#DEV DEV]||device||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#CER CER]||certificate representation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#MODDV MODDV]||imaging modality, ImagingModalityEntity||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#ORG ORG]||organization
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#PUB PUB]||public institution||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#STATE STATE]||state
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#NAT NAT]||Nation||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#PLC PLC]||place
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#CITY CITY]||city or town||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#COUNTRY COUNTRY]||country
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#COUNTY COUNTY]||county or parish||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#PROVINCE PROVINCE]||state or province
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#RGRP RGRP]||group||
 +
|| ||
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
 +
|}
 +
 
 +
'''PlayingEntity.determinerCode'''
 +
 
 +
The determinerCode is fixed to "INSTANCE", which indicates we are referencing a specific entity.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed PlayingEntity.determinerCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System:  EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
 +
|}
 +
 
 +
'''PlayingEntity.code'''
 +
 
 +
The optional PlayingEntity.code is bound to the EntityCode domain. For each Entity, the value for this attribute is drawn from one of several coding systems as suggested by the Entity.classCode, such as living subject (animal and plant taxonomies), chemical substance (e.g., IUPAC code), organization (e.g., CMS provider number), etc. It is possible that Entity.code may be so fine grained that it represents a single instance. An example is the CDC vaccine manufacturer code, modeled as a concept vocabulary, when in fact each concept refers to a single instance. The boundary cases distinguishing codes and identifiers are controversial: this specification allows a certain amount of flexibility.
 +
 
 +
'''PlayingEntity.quantity'''
 +
 
 +
The optional PlayingEntity.quantity defines the a physical quantity specifying the amount of the physical thing represented by the Entity object, either as a count of the members of a group, or as some other physical quantity. In order to explicitly identify a group of like entities, a static model design should constrain the PQ data type of this attribute to INT, thus providing a count of the entities in the group.
 +
 
 +
'''PlayingEntity.name'''
 +
 
 +
Most entities have a commonly used name that can be used to differentiate them from other Entities, but that does not provide a necessarily unique identifier.
 +
 
 +
'''PlayingEntity.desc'''
 +
 
 +
A textual or multimedia depiction of the Entity.
 +
 
 +
=====Entity=====
 +
 
 +
A physical thing, group of physical things or an organization capable of participating in Acts while in a role.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Entity
 +
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityClass.htm#ENT ENT||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-determinerCode-att determinerCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE  INSTANCE]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-id-att  id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Entity-code-att  code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#EntityCode D:EntityCode] ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#softwareName-desc-att  desc]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||  ||
 +
|}
 +
 
 +
'''Entity.classCode'''
 +
 
 +
The Entity.classCode is bound to the V:EntityClassRoot value set.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Entity.classCode 
 +
! style="text-align:left;"  colspan="5" |  V:EntityClassRoot <small>[2.16.840.1.113883.1.11.13922] (CLOSED) </small>
 +
|-
 +
!Code!!Display Name!! !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#ENT ENT] ('''Default''')||entity||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#HCE HCE]||health chart entity
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#LIV LIV]||living subject||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#NLIV NLIV]||non-person living subject
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#ANM ANM]||animal||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#MIC MIC]||microorganism
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#PLNT PLNT]||plant||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#PSN PSN]||person
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#MAT MAT]||material||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#CHEM CHEM]||chemical substance
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#FOOD FOOD]||food||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#MMAT MMAT]||manufactured material
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#CONT CONT]||container||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#HOLD HOLD]||holder
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#DEV DEV]||device||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#CER CER]||certificate representation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#MODDV MODDV]||imaging modality, ImagingModalityEntity||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#ORG ORG]||organization
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#PUB PUB]||public institution||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#STATE STATE]||state
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#NAT NAT]||Nation||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#PLC PLC]||place
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#CITY CITY]||city or town||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#COUNTRY COUNTRY]||country
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#COUNTY COUNTY]||county or parish||
 +
||[http://cda/infrastructure/vocabulary/EntityClass.htm#PROVINCE PROVINCE]||state or province
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityClass.htm#RGRP RGRP]||group||
 +
|| ||
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41</small>
 +
|}
 +
 
 +
'''Entity.determinerCode'''
 +
 
 +
The determinerCode is fixed to "INSTANCE", which indicates we are referencing a specific entity.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Entity.determinerCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/EntityDeterminer.htm#INSTANCE INSTANCE]||specific
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System:  EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30</small>
 +
|}
 +
 
 +
'''Entity.id'''
 +
 
 +
The optional Entity.id is used to uniquely identify the Entity.
 +
 
 +
'''Entity.code'''
 +
 
 +
The optional Entity.code is bound to the EntityCode domain.
 +
 
 +
'''Entity.desc'''
 +
 
 +
The optional Entity.desc is a textual or multimedia depiction of the Entity.
 +
 
 +
====<big>performer</big>====
 +
 
 +
The performer is a person who carries out or will carry out a particular act. The performer need not be the principal responsible participant, e.g. a surgery resident operating under supervision of attending surgeon is a performer.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: performer
 +
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRF PRF]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Participation-functionCode-att  functionCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ParticipationFunction D:ParticipationFunction]|| Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att  time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-IVL IVL]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS]>||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Participation-modeCode-att  modeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ParticipationMode.htm#ParticipationMode D:ParticipationMode ]||Fixed
 +
|}
 +
 
 +
'''performer.typeCode'''
 +
 
 +
The performer.typeCode is fixed to "PRF" which indicates a person, or organization that actually and principally carries out the action. Need not be the principal responsible actor.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed performer.typeCode
 +
|-
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#PRF PRF]||performer
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
 +
|}
 +
 
 +
'''performer.functionCode'''
 +
 
 +
The performer.functionCode is bound to the concept domain ParticipationFunction, which is used to specify the exact function an actor had in a service in all necessary detail. This domain may include local extensions (Open).
 +
 
 +
 
 +
'''performer.time'''
 +
 
 +
An optional interval of time which indicating the performer's participation in the associated Act.
 +
 
 +
'''performer.modeCode'''
 +
 
 +
The modality by which the Entity playing the Role is participating in the Act.
 +
 
 +
=====AssignedEntity=====
 +
 
 +
A performer is an entity in the role of assigned entity ([[#div-AssignedEntity|AssignedEntity]] class).  
 +
 
 +
=====Person=====
 +
 
 +
An assigned entity is a person assigned to the role by the scoping organization.  
 
The entity playing the role is a [[#div-person|Person]] class.
 
The entity playing the role is a [[#div-person|Person]] class.
−
 
+
 
−
=====Organization=====
+
=====Organization=====
−
 
+
 
−
The entity scoping the role is an organization ([[#div-Organization|Organization]] class).
+
The entity scoping the role is an organization ([[#div-Organization|Organization]] class).
−
 
+
 
−
=====encounterParticipant=====
+
====<big>product</big>====
−
 
+
 
−
The encounterParticipant participant represents clinicians directly associated with the encounter (e.g. by initiating, terminating, or overseeing it).
+
The product participant is described above (see [[#Entry_Acts|Entry Acts]]).
−
 
+
 
−
{| class='wikitable' 
+
====<big>specimen</big>====
−
|+Table {{AUTOTABLENUM}}: performer
+
 
−
!style="text-align:left;"|Attribute Name!!Data Type!!Wire Cardinality!!Code Binding!!Binding Type
+
A specimen is a part of some entity, typically the subject, that is the target of focused laboratory, radiology or other observations. In many clinical observations, such as physical examination of a patient, the patient is the subject of the observation, and there is no specimen. The specimen participant is only used when observations are made against some substance or object that is taken or derived from the subject.
−
|-
+
 
−
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[1..1]||[http://cda/infrastructure/vocabulary/vs_ParticipationType.htm#x_EncounterParticipant V:x_EncounterParticipant]||Closed
+
{| class='wikitable' 
−
|-
+
|+Table {{AUTOTABLENUM}}: informant
−
|[http://cda/infrastructure/rim/rim.htm#Participation-time-att time]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-TS TS] ||[0..1]||||
+
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
−
|}
+
|-
−
 
+
|[http://cda/infrastructure/rim/rim.htm#Participation-typeCode-att  typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ParticipationType.htm#SPC SPC]||Fixed
−
'''encounterParticipant.typeCode'''
+
|}
−
 
+
 
−
The encounterParticipant typeCode is bound to the x_EncounterParticipant value set. It supports for the following participation: admitter, attender, consultant, discharger, and referrer.  
+
'''specimen.typeCode'''
−
 
+
 
−
{| class='wikitable'   
+
The specimen.typeCode is fixed to "SPC" to indicate the subject of non-clinical (e.g. laboratory) observation services is a specimen.
−
|+Table {{AUTOTABLENUM}}: Value set for encounterParticipant.typeCode
+
 
−
! style="text-align:left;"  colspan="5" | V:x_EncounterParticipant <small>[2.16.840.1.113883.1.11.19600] (CLOSED) </small>
+
{| class='wikitable' 
−
|-
+
|+Table {{AUTOTABLENUM}}: Fixed specimen.typeCode
−
!Code!!Display Name!! !!Code!!Display Name
+
!Code!!Display Name!!
−
|-
+
|-
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#ADM ADM]||admitter||
+
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#SPC SPC]||specimen
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#ATND ATND]||attender
+
|-
−
|-
+
!style="text-align:left;"  colspan="2" | <small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#CON CON]||consultant||
+
|}
−
||[http://cda/infrastructure/vocabulary/ParticipationType.htm#DIS DIS]||discharger
+
 
−
|-
+
=====SpecimenRole=====
−
|[http://cda/infrastructure/vocabulary/ParticipationType.htm#REF REF]||referrer| || ||
+
 
−
|-
+
A role played by a material entity that is a specimen for an act.
−
!style="text-align:left;"  colspan="5" |<small> Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90</small>
+
 
 +
{| class='wikitable'   
 +
|+Table {{AUTOTABLENUM}}: AssignedAuthor
 +
!style="text-align:left;"|Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Role-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/RoleClass.htm#SPEC SPEC]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Role-id-att  id ]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]>||[0..*]|| ||
 +
|}
 +
 
 +
'''SpecimenRole.classCode'''
 +
 
 +
The SpecimenRole.classCode is fixed to "SPEC". 
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed SpecimenRole.classCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/RoleClass.htm#SPEC SPEC]||specimen
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110</small>
 +
|}
 +
 
 +
'''SpecimenRole.id'''
 +
 
 +
An optional SpecimenRole.id can be used to uniquely identify the specimen.
 +
 
 +
=====PlayingEntity=====
 +
 
 +
A specimen is an PlayingEntity in the role of SpecimenRole ([[#div-PlayingEntity|PlayingEntity]] class).
 +
 
 +
====<big>subject</big>====
 +
 
 +
The subject participant (described above, see [[#subject|subject]]), can be ascribed to a CDA section, or it can be ascribed to a CDA entry, where it overrides the value(s) propagated from a CDA section and propagates to nested entries.
 +
 
 +
===Entry Relationships===
 +
 
 +
====<big>component</big>====
 +
 
 +
The component relationship has a source of Organizer (see [[#Organizer|Organizer]], and a target that is another CDA entry, and is used to create groupings of CDA entries within an Organizer.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: documentationOf Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMP COMP]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-contextConductionInd-att contextConductionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-sequenceNumber-att sequenceNumber]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-INT INT]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-seperatableInd-att seperatableInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|}
 +
 
 +
'''component.typeCode'''
 +
 
 +
The component.typeCode is fixed to "COMP", which indicates that the associated Clinical Statement choice is a component part of the Organizer.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed component.typeCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMP COMP] ('''FIXED''')||has component
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 +
|}
 +
 
 +
'''component.contextConductionInd'''
 +
 
 +
The component.contextConductionInd indicator is fixed to "true". Ancestor elements () which propagate, will conduct through this component class to the associated child element.
 +
 
 +
'''component.sequenceNumber'''
 +
 
 +
The optional component.sequenceNumber is an integer specifying the relative sequential ordering of this relationship among other like-types relationships having the same source Act.
 +
 
 +
'''component.seperatableInd'''
 +
 
 +
The optional component.seperatableInd is an indication that the source Act is intended to be interpreted independently of the target Act.  The default value is true.
 +
 
 +
====<big>precondition</big>====
 +
 
 +
The precondition class, derived from the ActRelationship class, is used along with the Criterion class to express a condition that must hold true before some over activity occurs.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: precondition Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActRelationshipType.htm#PRCN PRCN]||Fixed
 +
|}
 +
 
 +
'''precondition.typeCode'''
 +
 
 +
The precondition.typeCode is fixed to PRCN which indicates a requirement to be true before a service is performed. The target can be any service in criterion mood. For multiple pre-conditions a conjunction attribute (AND, OR, XOR) is applicable.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed precondition.typeCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#PRCN PRCN]||has pre-condition
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 +
|}
 +
 
 +
=====Criterion=====
 +
 
 +
Criterion class is used to express a condition that must hold true before some over activity occurs.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Criterion Attributes
 +
!RIM Attribute(s)!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||  <= OBS  is [http://cda/infrastructure/vocabulary/vs_ActClass.htm#ActClassObservation V:ActClassObservation]||Closed w/ Default
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS] ||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN.CRT ENV.CRT] ||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[1..1]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActCode D:ActCode]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.htm#Act-actionNegationInd-att  actonNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.html#Act-isCriterionInd-att isCriterionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.html#Observation-value-att value]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ANY ANY]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ObservationValue D:ObservationValue]||Open
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/rim/rim.html#Observation-valueNegationInd-att valueNegationInd]</span>||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.html#Observation-interpretationCode-att interpretationCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-SET SET]<[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]>||[0..*]||[http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ObservationInterpretation D:ObservationInterpretation]||Open
 +
|}
 +
 
 +
'''Criterion.classCode'''
 +
 
 +
The Criterion.classCode is defaulted to "OBS" which represents an observation, but can take only any value defined in the ActClassObservation value set.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for Criterion.classCode
 +
! style="text-align:left;"  colspan="5" | V:ActClassObservation <small> [2.16.840.1.113883.1.11.11529] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBS OBS] ('''Default''')||Observation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ALRT ALRT]||detected issue
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLNTRL CLNTRL]||clinical trial
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONC CONC]||concern||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#COND COND]||Condition
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CASE CASE]||public health case||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OUTB OUTB]||outbreak
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DGIMG DGIMG]||diagnostic image||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#GEN GEN]||genomic observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DETPOL DETPOL]||determinant peptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#EXP EXP]||expression level
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#LOC LOC]||locus||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#PHN PHN]||phenotype
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POL POL]||polypeptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SEQ SEQ]||bio sequence
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SEQVAR SEQVAR]||bio sequence variation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#INVSTG INVSTG]||investigation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBSSER OBSSER]||observation series||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OBSCOR OBSCOR]||correlated observation sequences
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POS POS]||position||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#POSACC POSACC]||position accuracy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POSCOORD POSCOORD]||position coordinate||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SPCOBS SPCOBS]||specimen observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#VERIF VERIF]||Verification||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ROIBND ROIBND]||bounded ROI
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#LLD LLD] ('''Deprecated''')||left lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PRN PRN] ('''Deprecated''')||prone ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#RLD RLD] ('''Deprecated''')||right lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SFWL SFWL] ('''Deprecated''')||Semi-Fowler's ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SIT SIT] ('''Deprecated''')||sitting
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#STN STN] ('''Deprecated''')||standing ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SUP SUP] ('''Deprecated''')||supine
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#RTRD RTRD] ('''Deprecated''')|| reverse trendelenburg ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRD TRD] ('''Deprecated''')||trendelenburg
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CNOD CNOD] ('''Deprecated''')||Condition Node ||  ||  || 
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
 +
 
 +
'''Criterion.moodCode'''
 +
 
 +
The Criterion.moodCode is fixed to "EVN.CRT" which indicates a criterion or condition over service events that must apply for an associated service to be considered.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed Criterion.moodCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN.CRT EVN.CRT]||event criterion
 +
|-
 +
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 +
|}
 +
 
 +
'''Criterion.code'''
 +
 
 +
The particular kind of Criterion that the Criterion-instance represents. Criterion.code, if used, SHALL be a specialization of the Criterion.classCode. This attribute defines a specific sub-type of a given Criterion type. It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the Criterion.  The Criterion.code is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActCode ActCode] concept domain.
 +
 
 +
'''<span class="change-highlight">Criterion.actionNegationInd</span>'''
 +
 
 +
<span class="change-highlight">The Criterion.actionNegationInd indicates that the condition is based on the non-occurrence of the event. 
 +
 
 +
The actionNegationInd negates the Criterion as described by the descriptive properties which are:  classCode, code, isCriterionInd, value, valueNegationInd, interpretationCode and any of their components.
 +
 
 +
The remaining properties represent the document characteristics, E.g. Criterion.moodCode, Criterion.text are not negated.  Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.</span>
 +
 
 +
'''Criterion.text'''
 +
 
 +
A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Criterion.  The Criterion.text attribute can reference  the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.
 +
 
 +
'''Criterion.isCriterionInd'''
 +
 
 +
Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.
 +
 
 +
 
 +
'''Criterion.value'''
 +
 
 +
The result of the observation action. Extensive usage notes are available in the RIM, reference [http://cda/infrastructure/rim/rim.htm#Observation-value-att Value UsageNotes]
 +
 
 +
'''<span class="change-highlight">Criterion.valueNegationInd</span>'''
 +
 
 +
<span class="change-highlight">Criterion.valueNegationInd, indicates that the Criterion, as defined in in this Criterion class is NOT true. Note: This attribute should only be used when the terminology used for Criterion.value is not itself capable of expressing negated findings. (E.g. ICD9).</span>
 +
 
 +
'''Criterion.interpretationCode'''
 +
 
 +
A qualitative interpretation of the Criterion. These interpretation codes are sometimes called "abnormal flags," however, the judgment of normalcy is just one of the interpretations, and is often not relevant. For example, the susceptibility interpretations are not about "normalcy," and for any observation of a pathologic condition, it does not make sense to state the normalcy, since pathologic conditions are never considered "normal."
 +
 
 +
====<big>referenceRange</big>====
 +
 
 +
The referenceRange relationship (described above, see [[#Observation|Observation]]), has a source of Observation, and a target of ObservationRange.
 +
 
 +
====<big>entryRelationship</big>====
 +
 
 +
CDA has identified and modeled various link and reference scenarios. These scenarios enable CDA entries to be semantically linked to entries that exist within the same document (by traversing the entryRelationship class) or to objects external to it (by traversing the reference class).
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: entryRelationship Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm V:ActRelationshipType]||Closed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-inversionInd-att inversionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-contextConductionInd-att contextConductionInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-sequenceNumber-att sequenceNumber]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-INT INT]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-negationInd-att negationInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-seperatableInd-att seperatableInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|}
 +
 
 +
 
 +
In CDA R2.0, the following entryRelationships scenarios were provided as informative content: 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Examples of typical entryRelationships
 +
!ActRelationship Type!!Reasonable Source and Target entries!!Comments
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#CAUS CAUS] <br/>(is etiology for)|||(Act | Observation | Procedure | SubstanceAdministration) '''CAUS''' (Observation)||Used to show that the source caused the target observation (for instance, source "diabetes mellitus" is the cause of target "kidney disease").
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMP COMP] <br/>(has component)|||(Act | Observation | Procedure | SubstanceAdministration | Supply) '''COMP''' (Act | Observation | Procedure | SubstanceAdministration | Suppply)||Used to show that the target is a component of the source (for instance "hemoglobin measurement" is a component of a "complete blood count").
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#GEVL GEVL] <br/>(evaluates (goal))|||(Observation) '''GEVL''' (Observation)||Used to link an observation (intent or actual) to a goal to indicate that the observation evaluates the goal (for instance, a source observation of "walking distance" evaluates a target goal of "adequate walking distance").
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#MFST MFST] <br/>(is manifestation of)|||(Observation) '''MFST''' (Observation)||Used to say that the source is a manifestation of the target (for instance, source "hives" is a manifestation of target "penicillin allergy").
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#REFR REFR] <br/>(refers to)|||(Act | Observation | Procedure | SubstanceAdministration | Supply) '''REFR''' (Act | Observation | ObservationMedia | Procedure | RegionOfInterest | SubstanceAdministration | Supply)||Used to show a general relationship between the source and the target, when the more specific semantics of the relationship isn't known.
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RSON RSON] <br/>(has reason)|||(Act | Encounter | Observation | Procedure | SubstanceAdministration | Supply) '''RSON''' (Act | Encounter | Observation | Procedure | SubstanceAdministration | Supply)||Used to show the reason or rational for a service (for instance source "treadmill test" has reason "chest pain").
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SAS SAS] <br/>(starts after start)|||(Act | Encounter | Observation | Procedure | SubstanceAdministration | Supply) '''SAS''' (Act | Encounter | Observation | Procedure | SubstanceAdministration | Supply)||The source Act starts after the start of the target Act (for instance source "diaphoresis" starts after the start of target "chest pain").
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SPRT SPRT] <br/>(has support)|||(Observation) '''SPRT''' (Observation | ObservationMedia | RegionOfInterest)||Used to show that the target provides supporting evidence for the source (for instance source "possible lung tumor" has support target "mass seen on chest-x-ray").
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SUBJ SUBJ] <br/>(has subject)|||(Observation | RegionOfInterest) '''SUBJ''' (Observation | ObservationMedia)||Used to relate a source region of interest to a target image, or to relate an observation to its subject observation (for instance, source "moderate severity" has subject target "chest pain").
 +
|}
 +
:'''NOTE:''' The preceding table provides examples of reasonable relationships between CDA entries, but does not represent a conformance constraint.
 +
 
 +
The ActRelationshipType "has subject" is similar to the ParticipationType "subject". Entries that primarily operate on physical subjects use the Participation, whereas entries that primarily operate on other entries use the ActRelationship.
 +
 
 +
XCRPT (is excerpt of) (Act | Observation) XCRPT (Act | Observation | Procedure | SubstanceAdministration | Supply) Used to show that the source is excerpted from the target (for instance source "hemoglobin value of 12" is an excerpt of target "complete blood count").
 +
 
 +
The distinction between an excerpt and an informant participant can be blurry — such as in the case of recording a patient's medication history where the clinician may obtain the information from an informant or may excerpt the information from another computer system. An informant (or source of information) is a person who provides relevant information. An informant class is in the header, and can be overridden in the body. An excerpt is a sub portion of some other act.
 +
 
 +
'''entryRelationship.typeCode'''
 +
 
 +
<span class="change-highlight">In CDA R2.1 any entry (excluding Organizer), may be related to another entry, using the entryRelationship class. In the entryRelationship class, the typeCode attribute is used to define the semantic relationship that exists between the source or parent entry and the destination or child entry. The value set binding on typeCode was been significantly enhanced in CDA R2.1, and now any code present in the HL7 entryRelationship code system (RIM 2.35) may be used.
 +
</span>
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for entryRelationship.typeCode
 +
! style="text-align:left;"  colspan="5" | V:ActRelationshipType <small> [2.16.840.1.113883.1.11.10317] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#CIND CIND]</span>||has contra-indication|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#PRCN PRCN]</span>||has pre-condition
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RSON RSON]||has reason|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#BLOCK BLOCK]</span>||Blocks
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#CURE CURE]</span>||curative indication|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#CURE.ADJ CURE.ADJ]</span>||adjunct curative indication
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#DIAG DIAG]</span>||diagnosis|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#MITGT MITGT]</span>||mitigates
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RCVY RCVY]</span>||Recovery|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#MTGT.ADJ MTGT.ADJ</span>||adjunct mitigation
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SYMP SYMP]</span>||symptomatic relief|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#TRIG TRIG]</span>||has trigger
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMP COMP]||has component|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#ARR ARR]</span>||arrival
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#CTRLV CTRLV]</span>||has control variable|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#DEP DEP]</span>||departure
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#OUTC OUTC]</span>||has outcome|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#OBJC OBJC]</span>||has continuing objective
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#OBJF OBJF]</span>||has final objective|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#GOAL GOAL]</span>||has goal
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RISK RISK]</span>||has risk|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#PERT PERT]</span>||has pertinent information
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SAE SAE]</span>||starts after end of|| ||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SAS SAS]||starts after start of
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#CHRG CHRG]</span>||has charge|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COST COST]</span>||has cost
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#CREDIT CREDIT]</span>||has credit|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#DEBIT DEBIT]</span>||has debit
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#AUTH AUTH]</span>||authorized by|| ||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#CAUS CAUS]||is etiology for
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COVBY COVBY]</span>||covered by|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#DRIV DRIV]</span>||is derived from
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#ELNK ELNK]</span>||episodeLink|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#EVID EVID]</span>||provides evidence for
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#EXACBY EXACBY]</span>||exacerbated by|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#EXPL EXPL]</span>||has explanation
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#ITEMSLOC ITEMSLOC]</span>||items located|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#LIMIT LIMIT]</span>||limited by
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#MFST MFST]||is manifestation of|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#NAME NAME]</span>||assigns name
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#PREV PREV]</span>||has previous instance|| ||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#REFR REFR]||refers to
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#REFV REFV]</span>||has reference values|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RELVBY RELVBY]</span>||relieved by
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SPRT SPRT]||has support|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SPRTBND SPRTBND]</span>||has bounded support
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SUBJ SUBJ]||has subject|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SUMM SUMM]</span>||summarized by
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SEQL SEQL]</span>||is sequel|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#APND APND]</span>||is appendage
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#COMPLY COMPLY]</span>||Update|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#DOC DOC]</span>||documents
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#FLFS FLFS]</span>||fulfills|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#OCCR OCCR]</span>||occurrence
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#OREF OREF]</span>||references order|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SCH SCH]</span>||schedules request
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#GEN GEN]</span>||has generalization|| ||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#GEVL GEVL]||evaluates (goal)
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#INST INST]</span>||instantiates (master)|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#MOD MOD]</span>||modifies
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#MTCH MTCH]</span>||matches (trigger)|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#OPTN OPTN]</span>||has option
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RCHAL RCHAL]</span>||re-challenge|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#REV REV]</span>||reverses
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RPLC RPLC]</span>||replaces|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SUCC SUCC]</span>||succeeds
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#UPDT UPDT]</span>||updates (condition)|| ||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#XCRPT XCRPT]||Excerpts
 +
|-
 +
|<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#VRXCRPT VRXCRPT]</span>||Excerpt verbatim|| ||<span class="change-highlight">[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#XFRM XFRM]</span>||transformation
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 +
|}
 +
:'''Note:''' Implementation Guide ("IG") authors will need to exercise caution and ensure they fully understand the semantics of the relationship defined by the term they have selected. In addition, IG authors will need to understand the impact of both inversionInd and negationInd flags, as these attributes can materially impact those semantics when machine processing. </span>
 +
 
 +
'''entryRelationship.inversionInd'''
 +
 
 +
The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. As in the example provided in CDA R2.0, "treadmill test" RSON (has reason) "chest pain". Inverted, this would have "chest pain" as the source and "treadmill test" as the target: "chest pain" RSON (inverted) "treadmill test". Inversion can be useful when the current context is describing the target of an act relationship that needs to be related back to the source.
 +
 
 +
The entryRelationship.negationInd can be set to "true" to indicate that the meaning of the link is negated. Examples where this might be useful:
 +
* If the relationship without negation specifies that Act A has Act B as a component, then the negation indicator specifies that Act A does not have Act B as a component.
 +
* If B is a reason for A, then negation means that B is not a reason for A.
 +
* If B is a pre-condition for A, then negation means that B is not a precondition for A.
 +
 
 +
'''entryRelationship.contextConductionInd'''
 +
 
 +
The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute (see [[#CDA_Context|CDA Context]]) in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
 +
 
 +
'''entryRelationship.sequenceNumber'''
 +
 
 +
An integer specifying the relative sequential ordering of this relationship among other like-types relationships having the same source Act.
 +
 
 +
'''entryRelationship.negationInd'''
 +
 
 +
An indicator that asserts that the meaning of the link is negated.
 +
 
 +
'''entryRelationship.seperatableInd'''
 +
 
 +
An indication that the source Act is intended to be interpreted independently of the target Act. The value is defaulted to true.
 +
 
 +
====<big>reference</big>====
 +
 
 +
CDA entries can reference external objects such as external images and prior reports. These external objects are not part of the authenticated document content. They contain sufficient attributes to enable an explicit reference rather than duplicating the entire referenced object. The CDA entry that wraps the external reference can be used to encode the specific portions of the external reference that are addressed in the narrative block.
 +
 
 +
Each object allows for an identifier and a code, and contains the RIM Act.text attribute, which can be used to store the URL and MIME type of the object. External objects always have a fixed moodCode of "EVN".
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: reference Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-typeCode-att typeCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActRelationshipType.htm#x_ActRelationshipExternalReference V:ActRelationshipExternalReference]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#ActRelationship-seperatableInd-att seperatableInd]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-BL BL]||[0..1]|| ||
 +
|}
 +
 
 +
 
 +
'''reference.typeCode'''
 +
 
 +
A description of allowable reference.typeCode values are shown in the following table.
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for reference.typeCode
 +
! style="text-align:left;"  colspan="5" | V:ActRelationshipType <small> [2.16.840.1.113883.1.11.10317] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#ELNK ELNK]||episodeLink||
 +
||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#REFR REFR]||refers to
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SPRT SPRT]||has support||
 +
||[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RPLC RPLC]||replaces
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#XCRPT XCRPT]||Excerpts||
 +
|| ||
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002</small>
 +
|}
 +
 
 +
'''reference.seperatableInd'''
 +
 
 +
The reference class contains the attribute reference.seperatableInd, which indicates whether or not the source is intended to be interpreted independently of the target. The indicator cannot prevent an individual or application from separating the source and target, but indicates the author's desire and willingness to attest to the content of the source if separated from the target. Typically, where seperatableInd is "false", the exchanged package should include the target of the reference so that the recipient can render it.
 +
 
 +
 
 +
As in the table above (CDA entryRelationship Types), the following table is a guideline for reasonable relationships between CDA entries and external objects, and is not a conformance constraint.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: EXAMPLE entryRelationship Types
 +
!ActRelationship Type!!Reasonable Source and Target classes!!Comments
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#ELNK ELNK] <br/>(episode link)|||(Observation) '''ELNK''' (ExternalObservation)||Used to show that the source and the target are part of the same episode (for instance, a diagnosis of "pneumonia" can be linked to an external problem list entry of "pneumonia" to show that the current diagnosis is part of the ongoing episode of pneumonia).
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#REFR REFR]<br/>(refers to)|||(Act | Observation | Procedure | SubstanceAdministration | Supply) '''REFR''' (ExternalAct | ExternalDocument | ExternalObservation | ExternalProcedure)||Used to show a general relationship between the source and the target, when the more specific semantics of the relationship isn't known.
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#RPLC RPLC]<br/>(replace)|||(Act | Encounter | Observation | ObservationMedia | Organizer | Procedure | SubstanceAdministration | Supply) '''RPLC''' (ExternalAct | ExternalDocument | ExternalObservation | ExternalProcedure)||Used to indicate that the source entry is a replacement for the target external act.
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SPRT SPRT]<br/>(has support)|||(Observation) '''SPRT''' (ExternalDocument | ExternalObservation)||Used to show that the target provides supporting evidence for the source.
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#SUBJ SUBJ]<br/>(has subject)|||(Observation | RegionOfInterest) '''SUBJ''' (ExternalObservation)||Used to relate a source region of interest to a target image, or to relate an observation to its subject observation.
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActRelationshipType.htm#XCRPT XCRPT]<br/>(is excerpt of)|||(Act | Observation) '''XCRPT''' (ExternalAct | ExternalDocument | ExternalObservation | ExternalProcedure)||Used to show that the source is excerpted from the target (for instance "the hemoglobin is 10.7" is an excerpt of an externally referenced "complete blood count").
 +
|}
 +
 
 +
Target classes of the reference relationship include ExternalAct, ExternalDocument, ExternalObservation, and External Procedure.
 +
 
 +
 
 +
=====ExternalAct=====
 +
 
 +
The ExternalAct is a derivative of the RIM Act class, to be used when the other more specific classes are not appropriate.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: ExternalAct  Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]|| <= ACT is [http://cda/infrastructure/vocabulary/ActClass.htm V:ActClassRoot]||Closed w/ Default
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..*]||||
 +
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]|| ||
 +
|}
 +
 
 +
'''ExternalAct.classCode'''
 +
 
 +
The ExternalAct.classCode is bound to the ActClassRoot value set.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for ExternalAct.classCode
 +
! style="text-align:left;"  colspan="5" | V:ActClassRoot <small> [2.16.840.1.113883.1.11.13856] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACT ACT] ('''Default''')||act||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#COMPOSITION COMPOSITION]||composition, Attestable unit
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOC DOC]||document||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||clinical document
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CDALVLONE CDALVLONE]||CDA Level One clinical document||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#CONTAINER CONTAINER]||record container
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CATEGORY CATEGORY]||category||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#DOCBODY DOCBODY]||document body
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOCSECT CATEGORY]||document section, Section||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#TOPIC TOPIC]||topic
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#EXTRACT EXTRACT]||extract||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#EHR EHR]||electronic health record
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#FOLDER FOLDER]||folder||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#GROUPER GROUPER]||grouper
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CLUSTER CLUSTER]||Cluster||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#ACCM ACCM]||accommodation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACCT ACCT]||account||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#ACSN ACSN]||accession
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ADJUD ADJUD]||financial adjudication, financial adjudication results ||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#CACT CACT]||control act
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ACTN ACTN]||action||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#INFO INFO]||information
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#STC STC]||state transition control||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#CNTRCT CNTRCT]||contract
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#FCNTRCT FCNTRCT]||financial contract||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#COV COV]||coverage
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONS CONS]||consent||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#CONTREG CONTREG]||container registration
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CTTEVENT CTTEVENT]||clinical trial timepoint event||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#DISPACT DISPACT]||disciplinary action
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#EXPOS EXPOS]||exposure||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#AEXPOS AEXPOS]||acquisition exposure
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#TEXPOS TEXPOS]||transmission exposure||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#INC INC]||incident
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#INFRM INFRM]||inform||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#INVE INVE]||invoice element
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#LIST LIST]||working list||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#MPROT MPROT]||monitoring program
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBS OBS]||Observation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ALRT ALRT]||detected issue
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLNTRL CLNTRL]||clinical trial
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONC CONC]||concern||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#COND COND]||Condition
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CASE CASE]||public health case||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OUTB OUTB]||outbreak
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DGIMG DGIMG]||diagnostic image||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#GEN GEN]||genomic observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DETPOL DETPOL]||determinant peptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#EXP EXP]||expression level
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#LOC LOC]||locus||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#PHN PHN]||phenotype
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POL POL]||polypeptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SEQ SEQ]||bio sequence
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SEQVAR SEQVAR]||bio sequence variation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#INVSTG INVSTG]||investigation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBSSER OBSSER]||observation series||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OBSCOR OBSCOR]||correlated observation sequences
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POS POS]||position||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#POSACC POSACC]||position accuracy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POSCOORD POSCOORD]||position coordinate||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SPCOBS SPCOBS]||specimen observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#VERIF VERIF]||Verification||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ROIBND ROIBND]||bounded ROI
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI|| 
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#PCPR PCPR]||care provision
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ENC ENC]||encounter|| 
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#POLICY POLICY]||policy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#JURISPOL JURISPOL]||jurisdictional policy|| 
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#ORGPOL ORGPOL]||organizational policy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SCOPOL SCOPOL]||scope of practice policy|| 
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#STDPOL STDPOL]||standard of practice policy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PROC PROC]||procedure||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#SBEXT SBEXT]||Substance Extraction
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPECCOLLECT SPECCOLLECT]||Specimen Collection||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#SBADM SBADM]||substance administration
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#REG REG]||registration||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#REV REV]||review
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SPCTRT SPCTRT]||specimen treatment||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#SPLY SPLY]||supply
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DIET DIET]||diet||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#STORE STORE]||storage
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SUBST SUBST]||Substitution||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#TRFR TRFR]||transfer
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#TRNS TRNS]||transportation||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#XACT XACT]|| financial transaction
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CNOD CNOD] ('''Deprecated''')||Condition Node||
 +
||[http://cda/infrastructure/vocabulary/ActClass.htm#LLD LLD] ('''Deprecated''')||left lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PRN PRN] ('''Deprecated''')||prone ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#RLD RLD] ('''Deprecated''')||right lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SFWL SFWL] ('''Deprecated''')||Semi-Fowler's ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SIT SIT] ('''Deprecated''')||sitting
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#STN STN] ('''Deprecated''')||standing ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SUP SUP] ('''Deprecated''')||supine
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#RTRD RTRD] ('''Deprecated''')|| reverse trendelenburg ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRD TRD] ('''Deprecated''')||trendelenburg
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
 +
 
 +
'''ExternalAct.moodCode'''
 +
 
 +
The ExternalAct.moodCode is fixed to "EVN" which represents the event mood. Indicating that the act has taken place and this is information about that act.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed ExternalAct.moodCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
 +
|-
 +
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 +
|}
 +
 
 +
'''ExternalAct.id'''
 +
 
 +
The unique instance identifier for the ExternalAct.
 +
 
 +
'''ExternalAct.code'''
 +
 
 +
The particular kind of Act that the Act-instance represents within its class. ExternalAct.code, if used, SHALL be a specialization of the ExternalAct.classCode. This attribute defines a specific sub-type of a given Act type (determined by the "classCode" attribute). It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the limited set of Act types defined by "classCode." The ExternalAct.code is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActCode ActCode] concept domain.
 +
 
 +
'''ExternalAct.text'''
 +
 
 +
A reference to a renderable textual or multimedia description of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the ExternalAct.
 +
 
 +
=====ExternalDocument=====
 +
 
 +
The ExternalDocument is a derivative of the RIM Document class, used for representing external documents. ExternalDocument.text is modeled as an ED data type - allowing for the expression of the MIME type of the external document.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: ExternalDocument  Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att    classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]|| <=DOC is [http://cda/infrastructure/vocabulary/vs_ActClass.html#ActClassDocument V:ActClassDocument]||Closed w/ Default
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att    moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#InfrastructureRoot-typeId-att  typeId]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..1]|| ||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..*]||||
 +
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CE CE]||[1..1]||[http://cda/infrastructure/vocabulary/vs_LN.htm#DocumentType D:DocumentType]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-setId-att setId]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[0..1]||||
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-versionNumber-att versionNumber]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ST.SIMPLE ST.SIMPLE]||[0..1]||||
 +
|}
 +
 
 +
'''ExternalDocument.classCode'''
 +
 
 +
The ExternalDocument.classCode is fixed to "DOCCLIN"
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed ExternalDocument.classCode
 +
! style="text-align:left;"  colspan="5" | V:ActClassDocument <small> [2.16.840.1.113883.1.11.18938] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DOC DOC]'''(Default)'''||document|| ||
 +
[http://cda/infrastructure/vocabulary/ActClass.htm#DOCCLIN DOCCLIN]||clinical document
 +
|- 
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CDALVLONE CDALVLONE]||CDA Level One clinical document|| ||  ||
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
 +
 
 +
'''ExternalDocument..moodCode'''
 +
 
 +
The ExternalDocument.moodCode is fixed to "EVN" which represents the event mood. Indicating that the document has been created and is available. 
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed ExternalDocument.moodCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
 +
|-
 +
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 +
|}
 +
 
 +
'''ExternalDocument.id'''
 +
 
 +
The unique instance identifier for the ExternalDocument.
 +
 
 +
'''ExternalDocument.code'''
 +
 
 +
The ExternalDocument.code is bound to the DocumentType concept domain.
 +
 
 +
'''ExternalDocument.text'''
 +
 
 +
A reference to the external document.
 +
 
 +
'''ExternalDocument.setId'''
 +
 
 +
The ExternalDocument.setId is an optional identifier that does not change with revisions to a document.
 +
 
 +
'''ExternalDocument.versionNumber'''
 +
 
 +
The ExternalDocument.setId is an optional version number, that must be used with the setId to identify a given document.
 +
 
 +
=====ExternalObservation=====
 +
 
 +
The ExternalObservation is a derivative of the RIM Observation class, used for representing external coded and other observations.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: ExternalObservation Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]|| <= OBS is [http://cda/infrastructure/vocabulary/vs_ActClass.htm#ActClassObservation V:ActClassObservation]||Closed w/ Default
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..*]||||
 +
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]|| ||
 +
|}
 +
 
 +
'''ExternalObservation.classCode'''
 +
 
 +
The ExternalObservation.classCode is defaulted to "OBS" in indicate an observation, but be be set to any code in the ActCode concept domain.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Value set for ExternalObservation.classCode
 +
! style="text-align:left;"  colspan="5" | V:ActClassObservation <small> [2.16.840.1.113883.1.11.11529] (CLOSED)</small>
 +
|-
 +
!Code!!Display Name!!  !!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBS OBS] ('''Default''')||Observation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ALRT ALRT]||detected issue
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#BATTERY BATTERY]||battery||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#CLNTRL CLNTRL]||clinical trial
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CONC CONC]||concern||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#COND COND]||Condition
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CASE CASE]||public health case||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OUTB OUTB]||outbreak
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DGIMG DGIMG]||diagnostic image||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#GEN GEN]||genomic observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#DETPOL DETPOL]||determinant peptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#EXP EXP]||expression level
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#LOC LOC]||locus||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#PHN PHN]||phenotype
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POL POL]||polypeptide||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SEQ SEQ]||bio sequence
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SEQVAR SEQVAR]||bio sequence variation||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#INVSTG INVSTG]||investigation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#OBSSER OBSSER]||observation series||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#OBSCOR OBSCOR]||correlated observation sequences
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POS POS]||position||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#POSACC POSACC]||position accuracy
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#POSCOORD POSCOORD]||position coordinate||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SPCOBS SPCOBS]||specimen observation
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#VERIF VERIF]||Verification||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#ROIBND ROIBND]||bounded ROI
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#ROIOVL ROIOVL]||overlay ROI||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#LLD LLD] ('''Deprecated''')||left lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PRN PRN] ('''Deprecated''')||prone ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#RLD RLD] ('''Deprecated''')||right lateral decubitus
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#SFWL SFWL] ('''Deprecated''')||Semi-Fowler's ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SIT SIT] ('''Deprecated''')||sitting
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#STN STN] ('''Deprecated''')||standing ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#SUP SUP] ('''Deprecated''')||supine
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#RTRD RTRD] ('''Deprecated''')|| reverse trendelenburg ||  ||[http://cda/infrastructure/vocabulary/ActClass.htm#TRD TRD] ('''Deprecated''')||trendelenburg
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#CNOD CNOD] ('''Deprecated''')||Condition Node ||  ||  || 
 +
|-
 +
!style="text-align:left;"  colspan="5" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
 +
 
 +
'''ExternalObservation.moodCode'''
 +
 
 +
The ExternalObservation.moodCode is fixed to "EVN" which represents the event mood. Indicating that the observation has taken place and this is information about that observation.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed ExternalObservation.moodCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
 +
|-
 +
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 +
|}
 +
 
 +
'''ExternalObservation.id'''
 +
 
 +
The unique instance identifier for the ExternalObservation.
 +
 
 +
'''ExternalObservation.code'''
 +
 
 +
The particular kind of observation that the observation-instance represents within its class. ExternalObservation.code, if used, SHALL be a specialization of the ExternalObservation.classCode. This attribute defines a specific sub-type of a given Observation type (determined by the "classCode" attribute). It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the limited set of observation types defined by "classCode." The ExternalObservation.code is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActCode ActCode] concept domain.
 +
 
 +
'''ExternalObservation.text'''
 +
 
 +
A reference to a renderable textual or multimedia description of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the ExternalObservation.
 +
 
 +
=====ExternalProcedure=====
 +
 
 +
The ExternalProcedure is a derivative of the RIM Procedure class, used for representing external procedures.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: ExternalProcedure Attributes
 +
!Attribute Name!!Data Type!!Cardinality!!Code Binding!!Binding Type
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-classCode-att classCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActClass.htm#PROC PROC]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-moodCode-att moodCode]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CS CS]||[0..1]||[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||Fixed
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-id-att id]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-II II]||[1..*]||||
 +
|- 
 +
|[http://cda/infrastructure/rim/rim.htm#Act-code-att code]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-CD CD]||[0..1]||[http://cda/infrastructure/vocabulary/vs_ActCode.htm#ActCode D:ActCode]||Open
 +
|-
 +
|[http://cda/infrastructure/rim/rim.htm#Act-text-att text]||[http://cda/infrastructure/itsxml/datatypes-its-xml.htm#dtimpl-ED ED]||[0..1]|| ||
 +
|}
 +
 
 +
'''ExternalProcedure.classCode'''
 +
 
 +
The ExternalProcedure.classCode is fixed to "PROC".
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed ExternalProcedure.classCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActClass.htm#PROC PROC]||procedure
 +
|-
 +
!style="text-align:left;"  colspan="2" | <small> Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6</small>
 +
|}
 +
 
 +
'''ExternalProcedure.moodCode'''
 +
 
 +
The ExternalProcedure.moodCode is fixed to "EVN" which represents the event mood. Indicating that the procedure has taken place and this is information about that procedure.
 +
 
 +
{| class='wikitable' 
 +
|+Table {{AUTOTABLENUM}}: Fixed ExternalProcedure.moodCode
 +
!Code!!Display Name
 +
|-
 +
|[http://cda/infrastructure/vocabulary/ActMood.htm#EVN EVN]||event
 +
|-
 +
!style="text-align:left;"  colspan="2" |<small> Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001</small>
 
|}
 
|}
  
−
'''encounterParticipant.time'''
+
'''ExternalProcedure.id'''
−
 
 
−
An encounterParticipant is an entity in the role of assigned entity (AssignedEntity class). An assigned entity is a person assigned to the role by the scoping organization. The entity playing the role is a person (Person class). The entity scoping the role is an organization (Organization class).
 
−
 
 
−
=====AssignedEntity=====
 
−
 
 
−
A performer is an entity in the role of assigned entity ([[#div-AssignedEntity|AssignedEntity]] class).
 
  
−
=====Person=====
+
The unique instance identifier for the ExternalProcedure.
  
−
An assigned entity is a person assigned to the role by the scoping organization.
+
'''ExternalProcedure.code'''
−
The entity playing the role is a [[#div-person|Person]] class.
 
  
−
=====Organization=====
+
The particular kind of procedure that the procedure-instance represents within its class. ExternalProcedure.code, if used, SHALL be a specialization of the ExternalProcedure.classCode. This attribute defines a specific sub-type of a given Procedure type (determined by the "classCode" attribute). It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the limited set of Procedure types defined by "classCode." The ExternalProcedure.code is bound to the [http://cda/infrastructure/vocabulary/voc_ConceptDomains.htm#ActCode ActCode] concept domain.
  
−
The entity scoping the role is an organization ([[#div-Organization|Organization]] class).
+
'''ExternalProcedure.text'''
  
−
==[[Body]]==
+
A reference to a renderable textual or multimedia description of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the ExternalProcedure.
−
(content on separate page)
 
  
 
==CDA Context==
 
==CDA Context==

Latest revision as of 14:17, 11 July 2017

Contents

1 CDA Overview

(content on separate page)

2 Introduction to CDA Technical Artifacts

(content on separate page)

3 CDA Document Exchange in HL7 Messages

(content on separate page)

4 CDA Templating

(content on separate page)

5 CDA Design

NOTE: The definitive description of HL7 V3 model refinement, R-MIM development and interpretation can be found here.

The CDA R-MIM POCD_RM000040 can be found here: Link to wide graphic (opens in a new window)

A CDA document is comprised of a header and a body. The header identifies and classifies the document; provides information on authentication, the encounter, the patient, and the provider; and sets the context for the document as a whole. The body contains the clinical report, and is conceptually divided up into nested sections, each containing a narrative block to be rendered along with structured entries and external references.

5.1 Clinical Document

The ClinicalDocument class is the entry point into the CDA R-MIM, and corresponds to the <ClinicalDocument> XML element that is the root element of a CDA document instance. This section will outline the CDA Document's physical design, first in the header and then the body.

A CDA document is logically broken up into a CDA Header and a CDA Body. The CDA Header is comprised of ClinicalDocument attributes, participants, and act relationships. The CDA Body is the target of the ClinicalDocument component act relationship.

5.2 Header

5.3 Body

5.3.1 Body Choice

Body Choice

The CDA body choice can be either a document body in a format other than XML, or the CDA structured body. Every CDA document has exactly one body, associated with the ClinicalDocument class through the component relationship.

5.3.1.1 component

The component class relates the ClinicalDocument header to the body choice; NonXMLBody or StructuredBody.

Table X: documentationOf Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] DOC Fixed
contextConductionInd BL [0..1]

component.typeCode

The component.typeCode is fixed to "COMP", which indicates that the body is a component part of the StructuredDocument.

Table X: Fixed component.typeCode
Code Display Name
COMP has component
Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002

component.contextConductionInd

The component.contextConductionInd indicator is fixed to "true". Ancestor elements () which propagate, will conduct through this component class to the associated child element.

5.3.1.2 NonXMLBody

The NonXMLBody class represents a document body that is in some format other than XML. The NonXMLBody can be used to represent scanned document(s) or legacy document(s) needing to be transferred using the CDA standard.

Table X: NonXMLBody Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] DOCCLIN Fixed
moodCode CS [0..1] EVN Fixed
text ED [1..1]
confidentialityCode SET<CE> [0..*] V:x_BasicConfidentialityKind Open
languageCode CE [0..1] D:HumanLanguage Closed

NonXMLBody.typeCode

The ClinicalDocument.classCode in the CDA model is fixed to "DOCCLIN".

Table X: Fixed NonXMLBody.classCode
Code Display Name
DOCBODY document body
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

NonXMLBody.moodCode

The NonXMLBody.moodCode is fixed to "EVN" or event mood to indicate that this is documentation of a past service.

Table X: Fixed NonXMLBody.moodCode
Code Display Name
EVN event
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

NonXMLBody.text

NonXMLBody.text is used to reference data that is stored externally to the CDA document or to encode the data directly inline. Rendering a referenced non-XML body requires a software tool that recognizes the particular MIME media type for this type of body.

NonXMLBody.confidentialityCode

Confidentiality is a required contextual component of CDA, where the value expressed in the ClinicalDocument can be overridden for the NonXMLBody of the document.

Table X: Value set for NonXMLBody.confidentialityCode
X_BasicConfidentialityKind [2.16.840.1.113883.1.11.16926] (OPEN)
Code Display Name Code Display Name
N normal R restricted
V very restricted
Code System: Confidentiality (HL7) Code System OID: 2.16.840.1.113883.5.25

* The codeSystem value is included here because confidentialityCode is of type CE, and therefore must carry both a code and a codeSystem.

NonXMLBody.languageCode

Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF (Internet Engineering Task Force) RFC 3066 for the Identification of Languages, ed. H. Alvestrand. 1995, which obsoletes RFC 1766. The HL7 code system for these values is "2.16.840.1.113883.6.121". Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by the NonXMLBody (as further described in CDA Context).

5.3.1.3 StructuredBody

The StructuredBody class represents a CDA document body that is comprised of one or more document sections.

Table X: StructuredBody Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] DOCCLIN Fixed
moodCode CS [0..1] EVN Fixed
confidentialityCode SET<CE> [0..*] V:x_BasicConfidentialityKind Open
languageCode CE [0..1] D:HumanLanguage Closed

StructuredBody.classCode

Table X: Fixed StructuredBody.classCode
Code Display Name
DOCBODY document body
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

StructuredBody.moodCode

Table X: Fixed StructuredBody.moodCode
Code Display Name
EVN event
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

StructuredBody.confidentialityCode

Table X: Value set for StructuredBody.confidentialityCode
X_BasicConfidentialityKind [2.16.840.1.113883.1.11.16926] (OPEN)
Code Display Name Code Display Name
N normal R restricted
V very restricted
Code System: Confidentiality (HL7) Code System OID: 2.16.840.1.113883.5.25

* The codeSystem value is included here because confidentialityCode is of type CE, and therefore must carry both a code and a codeSystem.

confidentialityCode.HumanLanguage

5.3.1.3.1 component

A component class is used to relate the body choice (NonXMLBody, StructuredBody) to it's component Section(s). See component for its attributes.

5.3.2 Section Attributes

Section

Document sections can nest, can override context propagated from the header (see CDA Context, and can contain narrative and CDA entries.

Table X: Section Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] DOCSECT Fixed
moodCode CS [0..1] EVN Fixed
id ii [0..1]
code CE [1..1] D:DocumentSectionType Open
title ST [0..1]
text ED.STRUCTURED_TEXT [0..1]
confidentialityCode SET<CE> [0..*] V:x_BasicConfidentialityKind Open
languageCode CE [0..1] D:HumanLanguage Closed

An XML attribute "ID" of type XML ID, is added to Section within the CDA Schema. This attribute serves as the target of a reference (see reference). All values of attributes of type XML ID must be unique within the document (per the W3C XML specification).

Section.classCode

The Section.classCode is fixed to "DOCSECT", which represents a context that subdivides the body of a document. Document sections are typically used for human navigation, to give a reader a clue as to the expected content. Document sections are used to organize and provide consistency to the contents of a document body. Document sections can contain document sections and can contain entries.

Table X: Fixed Section.classCode
Code Display Name
DOCSECT document section
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

Section.moodCode

The Section.moodCode is fixed to "EVN" (event) which indicates the section is about a service that actually happens, may be an ongoing service or a documentation of a past service.

Table X: Fixed Section.moodCode
Code Display Name
EVN event
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

Section.id

The unique instance identifier of a particular document section.

Section.code

The code specifying the particular kind of section (e.g. Chief Complaint, Review of Systems, Assessment). The value set is drawn from LOINC, and has a CWE coding strength.

Section.title

Represents the label of a section. If valued, it is to be rendered as part of the narrative content of the clinical document body.

Section.text

Used to store narrative to be rendered. Also referred to as the CDA Narrative Block. See Section Narrative Block for details.

Section.confidentialityCode

A value for Section.confidentialityCode overrides the value propagated from StructuredBody. See CDA Context for more details.

Table X: Value set for Section.confidentialityCode
X_BasicConfidentialityKind [2.16.840.1.113883.1.11.16926] (OPEN)
Code Display Name Code Display Name
N normal R restricted
V very restricted
Code System: Confidentiality (HL7) Code System OID: 2.16.840.1.113883.5.25

* The codeSystem value is included here because confidentialityCode is of type CE, and therefore must carry both a code and a codeSystem.

Section.languageCode

Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF (Internet Engineering Task Force) RFC 3066: Tags for the Identification of Languages, ed. H. Alvestrand. 1995 , which obsoletes RFC 1766. The HL7 code system for these values is "2.16.840.1.113883.6.121".

A value for Section.languageCode overrides the value propagated from StructuredBody. See CDA Context for more details.

5.3.3 Section Participants

5.3.3.1 author

The author participant (described above, see author), can be ascribed to a CDA section, where it overrides the value(s) propagated from the CDA header.

5.3.3.2 informant

The informant participant (described above, see informant), can be ascribed to a CDA section where it overrides the value(s) propagated from the CDA header.

5.3.3.3 subject

The subject participant represents the primary target of the entries recorded in the document. Most of the time the subject is the same as the recordTarget (see recordTarget), but need not be, for instance when the subject is a fetus observed in an obstetrical ultrasound.

The subject participant can be ascribed to a CDA section or a CDA entry. It propagates to nested components, unless overridden. The subject of a document is presumed to be the patient.

Table X: informant
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] INF Fixed
contextControlCode CS [0..1] OP Fixed
awarenessCode CE [0..1] D:TargetAwareness Open

subject.typeCode

The subject.typeCode is fixed to "SBJ" to indicate that a participant that is the principle target (subject) of the service acts documented.

Table X: Fixed subject.typeCode
Code Display Name
SBJ subject
Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90

subject.contextControlCode

The subject.contextControlCode is fixed to "OP". Any subject(s) defined for a section will override the the Patient in recordTarget (an implicit subject) and propagate to the sub-sections and entries this section contains.

Table X: Fixed subject.contextControlCode
Code Display Name
OP overriding, propagating
Code System: ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057
5.3.3.3.1 RelatedSubject

A subject is a person playing one of several possible roles (RelatedSubject class).

Table X: RelatedSubject
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] x_DocumentSubject Closed
code CE [0..1] D:PersonalRelationshipRoleType Open
addr SET<AD> [0..*]
telecom SET<TEL> [0..*]

RelatedSubject.classCode

The RelatedSubject.classCode can take two codes; "PAT" a Role of a LivingSubject (player) as a recipient of health care services from a healthcare provider (scoper) and "PRS" which links two people in a personal relationship. The character of the relationship must be defined by a PersonalRelationshipRoleType code.

Table X: Value set for RelatedSubject.classCode
v:x_DocumentSubject [2.16.840.1.113883.1.11.19368] (CLOSED)
Code Display Name Code Display Name
PAT (Default) patient PRS personal relationship
Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110

RelatedSubject.code

The RelatedSubject.code is bound to the PersonalRelationshipRoleType concept domain

RelatedSubject.addr

An optional postal address for the subject.

RelatedSubject.telecom

An optional phone number for the subject.

5.3.3.3.2 SubjectPerson

The entity playing in the role RelatedSubject, is a person (SubjectPerson class).

Table X: SubjectPerson
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] PSN Fixed
determinerCode CS [0..1] INSTANCE Fixed
id SET<II> [0..*]
name SET<PN> [0..*]
desc ED [0..1]
administrativeGenderCode CE [0..1] D:administrativeGender Open
birthTime TS [0..1]
deceasedInd BL [0..1]
deceasedTime TS [0..1]
multipleBirthInd BL [0..1]
multipleBirthOrderNumber INT [0..1]
maritalStatusCode CE [0..1] D:MaritalStatus Open
religiousAffiliationCode CE [0..1] D:ReligousAffiliation Open
raceCode SET<CE> [0..*] D:Race Open
ethnicGroupCode SET<CE> [0..*] D:Ethnicity Open

SubjectPerson.classCode

The SubjectPerson.classCode is fixed to "PSN", indicating that the entity is a person.

Table X: Fixed SubjectPerson.classCode
Code Display Name
PSN person
Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41

SubjectPerson.determinerCode

The determinerCode is fixed to "INSTANCE", which indicates a specific person is a SubjectPerson.

Table X: Fixed SubjectPerson.determinerCode
Code Display Name
INSTANCE specific
Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30

SubjectPerson.id

Optional identifier for the SubjectPerson.

SubjectPerson.name

The subject's name.

Note: The person name data type "PN" supports current, and historical names using validTime, and the specification of different use codes can indicate legal name, tribal name, stage name and others.

SubjectPerson.desc

A textual or multimedia depiction of the subject.

SubjectPerson.administrativeGenderCode

The gender (i.e., the behavioral, cultural, or psychological traits typically associated with one sex) of a living subject as defined for administrative purposes.

SubjectPerson.birthTime

The date and time of the subject's birth.

SubjectPerson.deceasedInd

An indication that the subject is dead.

SubjectPerson.deceasedTime

The date and time that the Subject's death occurred.

SubjectPerson.multipleBirthInd

An indication as to whether the subject was part of a multiple birth.

SubjectPerson.multipleBirthOrderNumber

The order within a multiple birth in which this subject was born.

SubjectPerson.maritalStatusCode

The domestic partnership status of the subject.

SubjectPerson.religiousAffiliationCode

The primary religious preference of the subject.

SubjectPerson.raceCode

The race of the subject.

Note: More than one race code is now supported in CDA R2.1.

SubjectPerson.ethnicGroupCode

The ethnic group of the subject.

Note: More than one ethnic group is now supported in CDA R2.1.

Note: See 2.7 Backwards and Forwards Compatibility, for discussion on sdtc: extensions defined for CDA R2.0 and CDA R2.1.

5.3.4 Section Relationships

5.3.4.1 component

The "component" Act Relationship is used to nest a Section within a Section. Context propagates to nested sections (see CDA Context). Refer to component above for more information.

5.3.4.2 entry

The relationship between a section and its entries is encoded in the intervening "entry" Act Relationship.

The narrative of each Section, together with the multimedia content referenced in the narrative, comprises the complete authenticated content of the Section. This multimedia content consists of ObservationMedia and RegionOfInterest entries referenced by tags in the Section.text. This is the only case where the entries contain authenticated content that must be rendered with the narrative.

NOTE: See Referencing in and out of the narrative block for a discussion of referencing in and out of a section's narrative block.
Table X: entry Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] V:x_ActRelationshipEntry Fixed
contextConductionInd BL [0..1]

entry.typeCode

In terms of the relationship between a section and its entries, CDA defines a default general case, and a more specific case that can be used when applicable.

The entry relationship is defaulted to "COMP" (component), for the general case where the only assertion is that the related entries are contained within the source section and no other semantics are implied. In this case, the narrative is the original authenticated content. The CDA entries are created by various techniques (e.g., natural language processing, a human coder, a structured data entry tool that outputs both entries and a text report). The method of entry creation may be indicated by the entry participants (e.g., by identifying the algorithm or person that generated them). Relationships between various entries (such as two Observations or an Observation and an ObservationMedia) are encoded using the relationship types defined in entryRelationship.

A section may also have no narrative content in the case where the entries represent information that is not part of the clinical content of the document. A report may embed information referencing evidence data, reagents, calibration or other information that may be used for later processing but is not part of the clinical content. Such entries are also linked to the Section with ActRelationships possessing typeCode="COMP".

The entry relationship "DRIV" (is derived from) can be used in the special case where the narrative is fully derived from CDA Entries. When a report consisting entirely of structured entries is transformed into CDA, the encoding application must ensure that the authenticated content (narrative plus multimedia) is a faithful and complete rendering of the clinical content of the structured source data. This ensures that the narrative plus multimedia represents, as in all CDA documents, the complete authenticated content of the Section. In this case, narrative plus multimedia does not contain any clinical content that is not present in the Entries. An example of this case is a DICOM Structured Reporting document of obstetrical measurements made by ultrasound, rendered into a tabular report by a program converting it to CDA narrative block. If the typeCode of the ActRelationship linking these Entries to the Section was "DRIV", it would indicate to a receiving application: 1) the source of the narrative block is the Entries; 2) the contents of the two are equivalent.

The entries sourced from a Section may have a mix of ActRelationship typeCodes. In such a case, the union of the targets with a "DRIV" relationship are those used to generate the narrative block, and are those that, taken in total, are equivalent to the narrative block. Additional entries with "COMP" relationships are contained within the same section, with no implied semantics.

Table X: Value set for entry.typeCode
V:x_ActRelationshipEntry [2.16.840.1.113883.1.11.19446] (CLOSED)
Code Display Name Code Display Name
COMP (Default) has component DRIV is derived from
Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002

entry.contextConductionInd

The component.contextConductionInd indicator is fixed to "true". Ancestor elements () which propagate, will conduct through this component class to the associated child element.

5.3.5 Section Narrative Block

The Section.text field is used to store narrative to be rendered, as described above in CDA Conformance, and is therefore referred to as the CDA Narrative Block.

The CDA Narrative Block schema can be found here.

The content model of the CDA Narrative Block schema is specially hand crafted to meet the requirements outlined above (see Human Readability and Rendering CDA Documents). The schema is registered as a MIME type (text/x-hl7-text+xml), which is the fixed media type for Section.text. Components of the schema are described in the sections that follow.

5.3.5.1 <content>

The CDA <content> element is used to wrap a string of text so that it can be explicitly referenced, or so that it can suggest rendering characteristics. The <content> element can nest recursively, which enables wrapping a string of plain text down to as small a chunk as desired.

The <content> element contains an optional identifier, that can serve as the target of a reference. All values of attributes of type XML ID must be unique within the document (per the W3C XML specification). The originalText component of a RIM attribute present in any CDA entry can make explicit reference to the identifier, thereby indicating the original text associated with the attribute in the CDA entry.

Note: The <content> element is not the only element which can serve as the target of a reference. All narrative elements (including <text>) contain an ID element which can be referenced by the originalText component in a CDA entry. <content> is simply a tool which can be used to reference only a portion of a longer string contained in another narrative element.

Example X
<section>
   <code code="10153-2" 
    codeSystem="2.16.840.1.113883.6.1" 
    codeSystemName="LOINC"/>
   <title>Past Medical History</title>
   <text>
    There is a history of <content ID="a1">Asthma</content>
   </text>
   <entry>
      <observation classCode="OBS" moodCode="EVN">
         <code code="195967001" 
          codeSystem="2.16.840.1.113883.6.96" 
          codeSystemName="SNOMED CT" 
          displayName="Asthma">
            <originalText>
               <reference value="#a1"/>
            </originalText>
         </code>
         <statusCode code="completed"/>
      </observation>
   </entry>
</section>

There is no requirement that CDA entries must reference into the CDA Narrative Block. The referencing mechanism can be used where it is important to represent the original text component of a coded CDA entry.

The <content> element contains an optional "revised" attribute that can be valued with "insert" or "delete", which can be used to indicate narrative changes from the last version of a CDA document. The attribute is limited to a single generation, in that it only reflects the changes from the preceding version of a document. If applied, it needs to be used in conjunction with standard CDA revision tracking. Changes to a CDA document that has been released for patient care still require a formal versioning and revision, and the revised document can optionally carry the "revised" attribute to show the delta in the narrative. Receivers are required to interpret the "revised" attribute when rendering by visually distinguishing or suppressing deleted narrative.

5.3.5.2 <linkHtml>

The CDA <linkHtml> is a generic referencing mechanism, similar, but not identical, to the HTML anchor tag. It can be used to reference identifiers that are either internal or external to the document.

Multimedia that is integral to a document, and part of the attestable content of the document requires the use of the ObservationMedia CDA entry, which is referenced by the <renderMultiMedia> element (see <renderMultiMedia>). Multimedia that is simply referenced by the document and not an integral part of the document can use <linkHtml>.

The source of a link uses the linkHtml.href attribute. The target of an internal reference is an identifier of type XML ID, which can exist on other elements in the same or a different narrative block, or XML ID attributes that have been added to the <section>, <ObservationMedia>, or <renderMultiMedia> elements of the CDA Schema. The linkHtml.name attribute is deprecated, because attributes of type XML ID provide an alternative and more consistent target for referencing. Following the conventions of HTML, an internal link is prefaced with the pound sign, as shown in the following example.

Example X
<section ID="SECT001">
   <code code="10164-2" codeSystem="2.16.840.1.113883.6.1" 
    codeSystemName="LOINC"/>
   <title>History of Present Illness</title>
   <text>Mr. Smith is a 57 year old male presenting with 
    chest pain. He sustained a myocardial infarction 3 years 
    ago, ...
   </text>
</section>

 ...

<section ID="SECT003">
   <code code="10153-2" codeSystem="2.16.840.1.113883.6.1" 
    codeSystemName="LOINC"/>
   <title>Past Medical History</title>
   <text>History of coronary artery disease, as noted
    <linkHtml href="#SECT001">above</linkHtml>.</text>
</section>

CDA links do not convey shareable meaning. Shareable semantics are only achieved by the inclusion of CDA entries and their associated formalized relationships. There is no requirement that a receiver render an internal or external link, or the target of an external link.

5.3.5.3 <sub> and <sup>

The CDA <sub> and <sup> elements are used to indicate subscripts and superscripts, respectively.

Receivers are required to interpret these elements when rendering by visually distinguishing subscripted and superscripted characters.

5.3.5.4 <br>

The CDA <br/> element is used to indicate a hard line break. It differs from the CDA <paragraph> element in that the <br/> element has no content. Receivers are required to interpret this element when rendering so as to represent a line break.

5.3.5.5 <footnote> and <footnoteRef>

The CDA <footnote> element is used to indicate a footnote. The element contains the footnote, inline with the flow of text to which it is applied.

The <footnoteRef> element can reference an existing footnote in the same or different CDA Narrative Block of the same document. It can be used when the same footnote is being used multiple times. The value of the footnoteRef.IDREF must be an footnote.ID value in the same document.

Receivers are required to interpret these elements when rendering by visually distinguishing footnoted text. The exact rendition is at the discretion of the recipient, and might include a mark at the location of the footnote with a hyperlink to the footnoted text, a simple demarcation (such as "This is the text [this is the footnote] that is being footnoted"), etc.

5.3.5.6 <renderMultiMedia>

The CDA <renderMultiMedia> element references external multimedia that is integral to a document, and part of the attestable content of the document, and serves to show where the referenced multimedia is to be rendered.

The <renderMultiMedia> element has an optional <caption>, and contains a required referencedObject attribute (of type XML IDREFS), the values of which must equal the XML ID value(s) of ObservationMedia or RegionOfInterest CDA entries within the same document.

Example X
<section>
   <code code="8709-8" codeSystem="2.16.840.1.113883.6.1" 
    codeSystemName="LOINC"/>
   <title>Skin exam</title>
   <text>Erythematous rash, palmar surface, left index 
    finger.<renderMultiMedia referencedObject="MM1"/>
   </text>
   <entry>
      <observationMedia classCode="OBS" moodCode="EVN" ID="MM1">
         <id root="2.16.840.1.113883.19.2.1"/>
         <value xsi:type="ED" mediaType="image/jpeg">
            <reference value="left_hand_image.jpeg"/>
         </value>
      </observationMedia>
   </entry>
</section>

Multimedia that is simply referenced by the document and not an integral part of the document must use <linkHtml>.

The expected behavior is that the referenced multimedia should be rendered or referenced at the point of reference. Where a caption is present, it must also be rendered. <renderMultiMedia> can either reference a single ObservationMedia, or one or more RegionOfInterest. If <renderMultiMedia> references a single ObservationMedia, that ObservationMedia should be rendered or referenced at the point of reference. If <renderMultiMedia> references one or more RegionOfInterest, all RegionOfInterests should be rendered or referenced at the point of reference, atop the multimedia they are regions of. If <renderMultiMedia> references more than one RegionOfInterest, each RegionOfInterest must be a region on the same multimedia.

5.3.5.7 <paragraph>

A CDA <paragraph> is similar to the HTML paragraph, which allows blocks of narrative to be broken up into logically consistent structures. A CDA <paragraph> element contains an optional caption, which if present must come first before any other character data.

5.3.5.8 <list>

A CDA <list> is similar to the HTML list. A CDA <list> has an optional caption, and contains one or more <item> elements. A CDA <item> element contains an optional caption, which if present must come first before any other character data. The required listType attribute specifies whether the <list> is ordered or unordered (with unordered being the default). Unordered lists are typically rendered with bullets, whereas ordered lists are typically rendered with numbers, although this is not a requirement.

5.3.5.9 <table>

The CDA <table> is similar to the HTML table. The table markup is for presentation purposes only and, unlike a database table, does not possess meaningful field names. Remember to access the discrete data conveyed in a CDA document, process the RIM models contained within the <entry> element.

CDA modifies the strict XHTML table model by removing formatting tags and by setting the content model of cells to be similar to the contents of other elements in the CDA Narrative Block. A notable enhancement to the CDA R2.1 standard is the support of the <table> element within <td> & <th> elements. The support of tables within tables was not supported in CDA R2.0, but has been added for those implementation requiring complex table layouts.

The table.border, table.cellspacing, and table.cellpadding attributes are deprecated, because the styleCode attribute (see styleCode attribute) provides a more consistent way for senders to suggest rendering characteristics.

5.3.5.10 <caption>

The CDA <caption> is a label for a paragraph, list, list item, table, or table cell. It can also be used within the <renderMultiMedia> element to indicate a label for referenced ObservationMedia and RegionOfInterest entries. A <caption> contains plain text and may contain links and footnotes.

5.3.5.11 styleCode attribute

The styleCode attribute is used within the CDA Narrative Block to give the instance author the ability to suggest rendering characteristics of the nested character data. Receivers are not required to render documents using the style hints provided and can present stylized text in accordance with their local style conventions.

The value set is drawn from the HL7 styleType vocabulary domain, and has a CWE coding strength.

Table X: Value set for styleCode (CWE)
Code Definition
Font style (Defines font rendering characteristics.)
Bold Render with a bold font.
Underline Render with an underlines font.
Italics Render italicized.
Emphasis Render with some type of emphasis.
Table rule style (Defines table cell rendering characteristics.
Lrule Render cell with left-sided rule.
Rrule Render cell with right-sided rule.
Toprule Render cell with rule on top.
Botrule Render cell with rule on bottom.
Ordered list style (Defines rendering characteristics for ordered lists.)
Arabic List is ordered using Arabic numerals: 1, 2, 3.
LittleRoman List is ordered using little Roman numerals: i, ii, iii.
BigRoman List is ordered using big Roman numerals: I, II, III.
LittleAlpha List is ordered using little alpha characters: a, b, c.
BigAlpha List is ordered using big alpha characters: A, B, C.
Unordered list style (Defines rendering characteristics for unordered lists.)
Disc List bullets are simple solid discs.
Circle List bullets are hollow discs.
Square List bullets are solid squares.

Local extensions to the styleType vocabulary domain must follow the following convention: [x][A-Za-z][A-Za-z0-9]* (first character is "x", second character is an upper or lower case A-Z, remaining characters are any combination of upper and lower case letters or numbers).

The styleCode attribute can contain multiple values, separated by white space. Where an element containing a styleCode attribute is nested within another element containing a styleCode attribute, the style effects are additive, as in the following example:

Example X
<section>
   <text><content styleCode="Bold">This is rendered bold, 
    <content styleCode="Italics">this is rendered bold and 
    italicized,</content> this is rendered bold. </content>
    <content styleCode="Bold Italics">This is also rendered 
    bold and italicized.</content>
   </text>
</section>

5.3.5.12 Referencing in and out of the narrative block

NOTE: See entry for a discussion of the relationships between a section and its contained entries.

To summarize the mechanisms for referencing in and out of the CDA Narrative Block:

CDA entries can point in to the <content> element of the CDA Narrative Block (see <content>).

The <linkHtml> element of the CDA Narrative Block can reference targets that are either internal or external to the document (see <linkHtml>).

The <footnoteRef> element of the CDA Narrative Block can reference a <footnote> element in the same or different CDA Narrative Block of the same document (see <footnote> and <footnoteRef>).

The <renderMultiMedia> element of the CDA Narrative Block can point out to CDA ObservationMedia and RegionOfInterest entries of the same document (see <renderMultiMedia>).

5.3.6 Entry Acts

CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries.

Clinical documents contain a wide breadth of content, requiring much of the RIM to enable a full and complete encoding. The current set of CDA entries have been developed in response to identified requirements and scenarios that are in CDA's scope. Rather than creating specific entries for each scenario, similar requirements are merged to create broader entries, which can then be constrained within a particular realm or implementation. This approach is consistent with the approach taken by CEN, DICOM, and OpenEHR.

The model for CDA entries is derived from the shared HL7 Clinical Statement model, which is a collaborative project between several committees striving to provide a consistent representation of clinical observations and acts across various V3 specifications.

5.3.6.1 Act

Act

A derivative of the RIM Act class, to be used when the other classes present in the CDA Clinical Statement choice pattern are not appropriate.

Table X: Act Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] V:x_ActClassDocumentEntryAct Closed
moodCode CS [1..1] V:x_DocumentActMood Closed
id SET <II> [0..*]
code CD [1..1] D:ActCode Open
actonNegationInd BL [0..1]
negationInd (Deprecated) BL [0..1]
text ED [0..1]
statusCode CS [0..1] V:ActStatus Closed
effectiveTime IVL<TS> [0..1]
activityTime GTS [0..1]
availabilityTime TS [0..1]
priorityCode CE [0..1] D:ActPriority Open
confidentialityCode SET<CE> [0..*] D:Confidentiality Open
uncertaintyCode CE [0..1] D:ActUncertainty Open
reasonCode SET<CE> [0..*] D:ActReason Open
languageCode CE [0..1] D:HumanLanguage Closed

Act.classCode

The major class of Acts to which an Act-instance belongs.

Table X: Value set for Act.classCode
x_ActClassDocumentEntryAct [2.16.840.1.113883.1.11.19599] (CLOSED)
Code Display Name Code Display Name
ACT Act ACCM accommodation
CONS consent CTTEVENT clinical trial timepoint event
INC incident INFRM inform
PCPR care provision REG registration
SPCTRT specimen treatment TRNS transportation
ACSN accession CONTREG container registration
DISPACT disciplinary action EXPOS exposure
AEXPOS acquisition exposure TEXPOS transmission exposure
LIST working list MPROT monitoring program
REV review STORE storage
TRFR transfer
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

Act.moodCode

The intended use of the Act statement: as a report of fact, a command, a possibility, a goal, etc. Since the mood code is a determining factor for the meaning of an entire Act object, the mood must always be known. This means that whenever an act object is instantiated, the mood attribute SHALL be assigned to a valid code, and the mood assignment SHALL NOT change throughout the lifetime of the act object.

Table X: Value set for Act.moodCode
V:x_DocumentActMood [2.16.840.1.113883.1.11.19458] (CLOSED)
Code Display Name Code Display Name
APT appointment ARQ appointment request
EVN event DEF definition
RQO request INT intent
PRMS promise PRP proposal
RSK risk
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

Act.id

A unique identifier for the Act.

Act.code

The particular kind of Act that the Act-instance represents within its class. Act.code, if used, SHALL be a specialization of the Act.classCode. This attribute defines a specific sub-type of a given Act type (determined by the "classCode" attribute). It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the limited set of Act types defined by "classCode." The Act.code is bound to the ActCode concept domain.

Act.actionNegationInd

The Act.actionNegationInd works as a negative existence quantifier on the actual, intended or described Act event. In Event mood, it indicates the defined act did not occur. In Intent mood, it indicates the defined act is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.

The actionNegationInd negates the Act as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, reasonCode and any of their components.

The remaining properties represent the document characteristics, E.g. Act.id, Act.moodCode, Act.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.

Act.negationInd

Act.negationInd, is deprecated in RIM 2.35, and CDA R2.1 retains it for backwards compatibility. CDA R2.1 compliant implementation guides should use actionNegationInd moving forward.

Act.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Act. The Act.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.

Act.statusCode

The status reflects the state of the activity. The RIM based state machine diagram depicts the allowable state transitions that an Act.StatusCodes can take on.

Table X: Value set for Act.statusCode
V:ActStatus [2.16.840.1.113883.1.11.15933] (CLOSED)
Code Display Name Code Display Name
normal normal aborted aborted
active active cancelled cancelled
completed completed held held
new new suspended suspended
nullified nullified obsolete obsolete
Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14

Act.effectiveTime

Act.effectiveTime is used to indicate the clinically or operationally relevant time of an act, exclusive of administrative activity.

Act.activityTime

Act.activityTime is a time expression specifying when an act occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the act occurred, is supposed to occur, is scheduled to occur, etc.

Act.availabilityTime

Act.availabilityTime is the point in time at which information about an act instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the act itself.

Act.priorityCode

The urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Act.priorityCode is bound to the ActPriority concept domain.

Act.confidentialityCode

Constraints around appropriate disclosure of information about this Act, regardless of mood. The Act.confidentialityCode is bound to the Confidentiality concept domain.

Act.uncertaintyCode

An indication that the Act statement as a whole, with its subordinate components has been asserted to be uncertain in some way. The use of the uncertaintyCode is appropriate only if the entirety of the Act and its dependent Acts is questioned. The Act.uncertaintyCode is bound to the ActUncertainty concept domain.

Act.reasonCode

The motivation, cause, or rationale of an Act, when such rationale is not reasonably represented as an ActRelationship of type "has reason" linking to another Act. The Act.reasonCode is bound to the ActReason concept domain.

Most reasons for acts can be clearly expressed by linking the new Act to another prior Act record using an ActRelationship of type "has reason." This simply states that the prior Act is a reason for the new Act (see ActRelationship). The prior act can then be a specific existing act or a textual explanation. This works for most cases, and the more specific the reason data is, the more should this reason ActRelationship be used instead of the reasonCode.

The reasonCode remains as a place for common reasons that are not related to a prior Act or any other condition expressed in Acts. Indicators that something was required by law or was on the request of a patient may qualify. However, if that piece of legislation, regulation, or the contract or the patient request can be represented as an Act (and they usually can), such a representation is preferable to the reasonCode.

Act.languageCode

The primary language in which this Act statement is specified, particularly the language of the Act.text. The Act.languageCode is bound to the HumanLanguage concept domain.

5.3.6.2 Encounter

A derivative of the RIM PatientEncounter class, used to represent related encounters, such as follow-up visits or referenced past encounters.

NOTE: The EncompassingEncounter class in the CDA Header (see Header Relationships) represents the setting of the clinical encounter during which the documented act occurred. The Encounter class in the CDA Body is used to represent other related encounters.
Table X: Encounter Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] ENC Fixed
moodCode CS [1..1] V:x_DocumentEncounterMood Closed
id SET <II> [0..*]
code CD [0..1] D:ActCode Open
actonNegationInd BL [0..1]
negationInd (Deprecated) BL [0..1]
text ED [0..1]
statusCode CS [0..1] V:ActStatus Closed
effectiveTime IVL<TS> [0..1]
activityTime GTS [0..1]
availabilityTime TS [0..1]
priorityCode CE [0..1] D:ActPriority Open
confidentialityCode SET<CE> [0..*] D:Confidentiality Open
uncertaintyCode CE [0..1] D:ActUncertainty Open
reasonCode SET<CE> [0..*] D:ActReason Open
languageCode CE [0..1] D:HumanLanguage Closed
admissionReferralSourceCode <CE> [0..1] D:EncounterReferralSource Open
lengthOfStayQuantity <PQ>.TIME [0..1]
dischargeDispositionCode <CE> [0..1] D:EncounterDischargeDisposition Open
preAdmitTestInd BL [0..1]
specialCourtesiesCode SET<CE> [0..*] D:EncounterSpecialCourtesy Open
specialArrangementCode SET<CE> [0..*] D:SpecialArrangement Open

Encounter.classCode

The Encounter.classCode is fixed to "ENC" to represent an encounter. The encounter class is used to represent an interaction between a patient and healthcare participant(s) for the purpose of providing patient service(s) or assessing the health status of a patient.

Table X: Fixed Encounter.classCode
Code Display Name
ENC (Fixed) encounter
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

Encounter.moodCode

The Encounter.moodCode is bound to the x_DocumentEncounterMood value set. This enables to the modeling of both past, present and planned future encounters.

Table X: Value set for Encounter.moodCode
V:x_DocumentEncounterMood [2.16.840.1.113883.1.11.19459] (CLOSED)
Code Display Name Code Display Name
APT appointment ARQ appointment request
EVN event DEF definition
RQO request INT intent
PRMS promise PRP proposal
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

Encounter.id

The optional Encounter.id can be used to uniquely identify the encounter.

Encounter.code

The optional Encounter.code is bound to the ActEncounterCode value set.

Table X: Value set for EncompassingEncounter.code
V:ActEncounterCode [2.16.840.1.113883.1.11.13955] (OPEN)
Code Display Name Code Display Name
AMB ambulatory EMER emergency
FLD field HH home health
IMP inpatient encounter ACUTE inpatient acute
NONAC virtual SS short stay
VR inpatient non-acute
Code System: ActCode (HL7) Code System OID: 2.16.840.1.113883.5.4

Encounter.actionNegationInd

The Encounter.actionNegationInd works as a negative existence quantifier on the actual, intended or described Encounter event. In Event mood, it indicates the defined encounter did not occur. In Intent mood, it indicates the defined encounter is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.

The actionNegationInd negates the Encounter as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, reasonCode, admissionReferralSourceCode, lengthOfStayQuantity, dischargeDispositionCode, preAdmitTestInd, specialCourtesiesCode, specialArrangementCode and any of their components.

The remaining properties represent the document characteristics, E.g. Encounter.id, Encounter.moodCode, Encounter.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative encounter. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.

Encounter.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Encounter. The Encounter.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.

Encounter.statusCode

The status reflects the state of the Encounter. The RIM based state machine diagram depicts the allowable state transitions that an Encounter.statusCode can take on.

Encounter.effectiveTime

For Encounters, the effectiveTime is the "administrative" time, i.e., the encounter start and end date as established by business rules. For inpatient encounters, the effectiveTime/low value is the admission date and time and the effectiveTime/high value is the discharge date and time. Note: If the encounter is still active at the time of document creation, the effectiveTime/high element can be omitted to indicate the encounter is on-going.

Encounter.activityTime

Encounter.activityTime is a time expression specifying when an Encounter occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the Encounter occurred, is supposed to occur, is scheduled to occur, etc.

Encounter.availabilityTime

Encounter.availabilityTime is the point in time at which information about an Encounter instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the Encounter itself.

Encounter.priorityCode

The urgency under which the Encounter happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Encounter.priorityCode is bound to the ActPriority concept domain.

Encounter.confidentialityCode

Constraints around appropriate disclosure of information about this Encounter, regardless of mood. The Encounter.confidentialityCode is bound to the Confidentiality concept domain.

Encounter.reasonCode

The motivation, cause, or rationale of an Encounter, when such rationale is not reasonably represented as an ActRelationship of type "has reason" linking to another Act. The Encounter.reasonCode is bound to the ActReason concept domain.

Encounter.languageCode

The primary language in which this Encounter statement is specified, particularly the language of the Encounter.text. The Encounter.languageCode is bound to the HumanLanguage concept domain.

Encounter.admissionReferralSourceCode

The optional EncompassingEncounter.admissionReferralSourceCode can be use to depict the type of place or organization responsible for the patient's care immediately prior to a patient encounter.

Encounter.lengthOfStayQuantity

The total quantity of time when the subject is expected to be or was resident at a facility as part of an encounter. Note, the actual days quantity cannot be simply calculated from the admission and discharge dates because of possible leaves of absence.

Encounter.dischargeDispositionCode

The optional EncompassingEncounter.dischargeDispositionCode can be used to depict the disposition of the patient at the time of hospital discharge (e.g., discharged to home, expired, against medical advice, etc.).

Encounter.preAdmitTestInd

An indication that pre-admission tests are required for this patient encounter.

Encounter.specialCourtesiesCode

Extraordinary considerations or services provided within the context of the Patient Encounter. Examples include: Professional courtesy, VIP courtesies, no courtesies

Encounter.specialArrangementCode

Extraordinary provisions required in the context of the patient encounter. For encounters in intention moods, this information can be used to identify special arrangements that will need to be made for the incoming patient.

5.3.6.3 Observation

A derivative of the Observation(§ RIM 5.36) class, it is intended to result in new information about a subject. The main difference between Observations and other Acts is that Observations have a value attribute. The code attribute of Observation and the value attribute of Observation must be considered in combination to determine the semantics of the observation.

Table X: Observation Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] <= OBS" is V:ActClassObservation Closed
moodCode CS [1..1] V:x_ActMoodDocumentObservation Closed
id SET <II> [0..*]
code CD [1..1] D:ObservationType Open
actionNegationInd BL [0..1]
negationInd (Deprecated) BL [0..1]
derivationExpr ST [0..1]
title ED [0..1]
text ED [0..1]
statusCode CS [0..1] V:ActStatus Closed
effectiveTime IVL<TS> [0..1]
activityTime GTS [0..1]
availabilityTime TS [0..1]
priorityCode CE [0..1] D:ActPriority Open
confidentialityCode SET<CE> [0..*] D:Confidentiality Open
repeatNumber IVL<INT> [0..1]
uncertaintyCode CE [0..1] D:ActUncertainty Open
languageCode CE [0..1] D:HumanLanguage Closed
isCriterionInd BL [0..1]
value SET<ANY> [0..*] D:ObservationValue Open
valueNegationInd BL [0..1]
interpretationCode SET<CE> [0..*] D:ObservationInterpretation Open
methodCode SET<CE> [0..*] D:ObservationMethod Open
targetSiteCode SET<CD> [0..*] D:ActSite Open

Observation.classCode

The defines a specific sub-type of a given Observation type.

Table X: Value set for Observation.classCode
V:ActClassObservation [2.16.840.1.113883.1.11.11529] (CLOSED)
Code Display Name Code Display Name
OBS Observation ALRT detected issue
BATTERY battery CLNTRL clinical trial
CONC concern COND Condition
CASE public health case OUTB outbreak
DGIMG diagnostic image GEN genomic observation
DETPOL determinant peptide EXP expression level
LOC locus PHN phenotype
POL polypeptide SEQ bio sequence
SEQVAR bio sequence variation INVSTG investigation
OBSSER observation series OBSCOR correlated observation sequences
POS position POSACC position accuracy
POSCOORD position coordinate SPCOBS specimen observation
VERIF Verification ROIBND bounded ROI
ROIOVL overlay ROI LLD (Deprecated) left lateral decubitus
PRN (Deprecated) prone RLD (Deprecated) right lateral decubitus
SFWL (Deprecated) Semi-Fowler's SIT (Deprecated) sitting
STN (Deprecated) standing SUP (Deprecated) supine
RTRD (Deprecated) reverse trendelenburg TRD (Deprecated) trendelenburg
CNOD (Deprecated) Condition Node
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

Observation.moodCode

The intended use of the Observation statement: as a report of fact, a command, a possibility, a goal, etc. Since the mood code is a determining factor for the meaning of an entire Observation object, the mood must always be known. This means that whenever an Observation is instantiated, the mood attribute SHALL be assigned to a valid code, and the mood assignment SHALL NOT change throughout the lifetime of the Observation.

Table X: Value set for Observation.moodCode
V:x_ActMoodDocumentObservation [2.16.840.1.113883.1.11.19644] (CLOSED)
Code Display Name Code Display Name
APT appointment ARQ appointment request
EVN event DEF definition
GOL goal INT intent
PRMS promise PRP proposal
RSK risk RQO request
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

Observation.id

A unique identifier for the Observation.

Observation.code

The particular kind of Observation that the Observation-instance represents within its class. Observation.code, if used, SHALL be a specialization of the Observation.classCode. This attribute defines a specific sub-type of a given Observation type (determined by the "classCode" attribute). The Observation.code is bound to the ActCode concept domain.

Observation.actionNegationInd

The Observation.actionNegationInd works as a negative existence quantifier on the actual, intended or described observation event. In Event mood, it indicates the defined observation did not occur. In Intent mood, it indicates the defined observation is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.

The actionNegationInd negates the Observation as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, derivationExpr, repeatNumber, isCriterionInd, value, valueNegationInd, interpretationCode, methodCode, targetSiteCode, and any of their components.

The remaining properties represent the document characteristics, E.g. Observatoin.id, Observation.moodCode, Observation.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.

Observation.negationInd

Observation.negationInd, is deprecated in RIM 2.35, and CDA R2.1 retains it for backwards compatibility. It was deprecated as the type of negation required knowledge of template documentation to determine the actual type of negation I.e. value or action negation. CDA R2.1 compliant implementation guides should use actionNegationInd or valueNegationInd moving forward.

Observation.derivationExpr

A character string containing a formal language expression that specifies how the Observation's attributes are, should be, or have been derived from input parameters associated with derivation relationships. Derived observations can be defined through association with other observations using ActRelationships of type "derivation." For example, to define a derived observation for Mean Corpuscular Hemoglobin (MCH) one will associate the MCH observation with a Hemoglobin (HGB) observation and a Red Blood cell Count (RBC) observation: the derivation expression value encodes the formula: MCH = HGB / RBC.

Observation.title

A word or phrase by which a specific Observation may be known among people. This is not a formal identifier but rather a human-recognizable common name. However it is similar to the id attribute in that it refers to a specific Observation rather than a 'kind' of Observation. (For definition mood, the title refers to that specific definition, rather than to a broad category that might be conveyed with Observation.code.)

Observation.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Observation. The Observation.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.

Observation.statusCode

The status reflects the state of the activity. In the case of an Observation, this is the status of the activity of observing (e.g., "new," "complete," "cancelled"), not the status of what is being observed (e.g., disease status, "Active" allergy to penicillin). To convey the status of the subject being observed, consider coordinating it into the code or value attribute of the Observation or using a related Observation. The RIM based state machine diagram depicts the allowable state transitions that an Observation.StatusCode can take on.

Table X: Value set for Observation.statusCode
V:ActStatus [2.16.840.1.113883.1.11.15933] (CLOSED)
Code Display Name Code Display Name
normal normal aborted aborted
active active cancelled cancelled
completed completed held held
new new suspended suspended
nullified nullified obsolete obsolete
Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14

Observation.effectiveTime

Observation.effectiveTime is used to indicate the clinically or operationally relevant time of an observation, exclusive of administrative activity. For example, in a Blood Gas Analysis (BGA), a result might not be available for several minutes after the specimen was taken. The effectiveTime is the time the specimen was taken, the availabilityTime would be the time the result was available for review. For clinical Observations, the effectiveTime represents the time at which the observation holds (is effective) for the patient. In V2 the effectiveTime was known as the biologically relevant time.

Observation.activityTime

Observation.activityTime is a time expression specifying when an Observation occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the observation occurred, is supposed to occur, is scheduled to occur, etc. When an observation of a prior symptom is made, the activityTime describes the time the observation is made, as opposed to effectiveTime which is the time the symptom is reported to have occurred. Thus the activityTime may be entirely different from the effectiveTime for the same observation instance.

Observation.availabilityTime

Observation.availabilityTime is the point in time at which information about an observation instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the Observation itself. For CDA documents, the availabilityTime reported for its contents, would represent the time the observation first became available to a source system generating the CDA document.

Observation.priorityCode

The urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Act.priorityCode is bound to the ActPriority concept domain.

Observation.confidentialityCode

Constraints around appropriate disclosure of information about this Observation, regardless of mood. The Observation.confidentialityCode is bound to the Confidentiality concept domain.

Observation.repeatNumber

An interval of integer numbers stating the minimal and maximal number of repetitions of the Observation.

Observation.uncertaintyCode

An indication that the Observation statement as a whole, with its subordinate components has been asserted to be uncertain in some way. The use of the uncertaintyCode is appropriate only if the entirety of the Observation and its dependent Acts is questioned. The Observation.uncertaintyCode is bound to the ActUncertainty concept domain.

Observation.languageCode

The primary language in which this Observation statement is specified, particularly the language of the Observation.text. The Observation.languageCode is bound to the HumanLanguage concept domain.

Observation.isCriterionInd

Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.

Observation.value

The result of the observation action. Extensive usage notes are available in the RIM, reference Value UsageNotes

Observation.valueNegationInd

Observation.valueNegationInd, indicates that when the observation event occurred, the finding communicated by the value attribute was NOT found. So, when we want to indicate the patient does not have asthma, we can negate a finding of asthma, using this indicator. Note: The RIM indicates that this attribute should only be used when the terminology used for Observation.value is not itself capable of expressing negated findings. (E.g. ICD9). Implementation experience may override the RIM definition and it's important to review template definitions and Value Set content and binding for consistent negation implementation. Existing CDA R2.0 implementations use negationInd in many C-CDA templates.

Observation.interpretationCode

A qualitative interpretation of the observation. These interpretation codes are sometimes called "abnormal flags," however, the judgment of normalcy is just one of the interpretations, and is often not relevant. For example, the susceptibility interpretations are not about "normalcy," and for any observation of a pathologic condition, it does not make sense to state the normalcy, since pathologic conditions are never considered "normal."

Observation.methodCode

The means or technique used to ascertain the observation. In all observations the method is already partially specified by the Observation.code. In this case, the methodCode NEED NOT be used at all. The methodCode MAY still be used to identify this method more clearly in addition to what is implied from the Observation.code. However, an information consumer system or process SHOULD NOT depend on this methodCode information for method detail that is implied by the Observation.code.

Observation.targetSiteCode

The anatomical site or system that is the focus of the observation. Most observation target sites are implied by the observation definition and Observation.code, or Observation.value. For example, "heart murmur" always has the heart as target. This attribute is used only when the observation target site needs to be refined, to distinguish right from left, etc. If the subject of the Observation is something other than a human patient or animal, the attribute is used analogously to specify a structural landmark of the thing where the Observation focuses. For example, if the subject is a lake, the site could be inflow and outflow, etc. If the subject is a lymphatic node, "hilus," "periphery," or other node sites would be valid target sites.

5.3.6.3.1 Reference Range

An Observation can have zero to many referenceRange relationships, which relate an Observation to the ObservationRange class.

referenceRange.typeCode

The referenceRange.typeCode has been fixed to "REFV", which indicates an association to a reference range.

Table X: Fixed referenceRange.typeCode
Code Display Name
REFV has reference values
Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002
5.3.6.3.2 ObservationRange

ObservationRange or reference ranges are essentially descriptors of a class of result values assumed to be "normal", "abnormal", or "critical." Those can vary by sex, age, or any other criterion.

Table X: ObservationRange Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] <= OBS is V:ActClassObservation Closed w/ Default
moodCode CS [0..1] ENV.CRT Fixed
code CD [1..1] D:ActCode Open
text ED [0..1]
isCriterionInd BL [0..1]
value SET<ANY> [0..*] D:ObservationValue Open
valueNegationInd BL [0..1]
interpretationCode SET<CE> [0..*] D:ObservationInterpretation Open

ObservationRange.classCode

Table X: Value set for ObservationRange.classCode
V:ActClassObservation [2.16.840.1.113883.1.11.11529] (CLOSED)
Code Display Name Code Display Name
OBS (Default) Observation ALRT detected issue
BATTERY battery CLNTRL clinical trial
CONC concern COND Condition
CASE public health case OUTB outbreak
DGIMG diagnostic image GEN genomic observation
DETPOL determinant peptide EXP expression level
LOC locus PHN phenotype
POL polypeptide SEQ bio sequence
SEQVAR bio sequence variation INVSTG investigation
OBSSER observation series OBSCOR correlated observation sequences
POS position POSACC position accuracy
POSCOORD position coordinate SPCOBS specimen observation
VERIF Verification ROIBND bounded ROI
ROIOVL overlay ROI LLD (Deprecated) left lateral decubitus
PRN (Deprecated) prone RLD (Deprecated) right lateral decubitus
SFWL (Deprecated) Semi-Fowler's SIT (Deprecated) sitting
STN (Deprecated) standing SUP (Deprecated) supine
RTRD (Deprecated) reverse trendelenburg TRD (Deprecated) trendelenburg
CNOD (Deprecated) Condition Node
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

ObservationRange.moodCode

The ObservationRange.moodCode is fixed to the "EVN.CRT" (event criterion). The "EVN.CRT" is a criterion or condition over service events that must apply for an associated service to be considered.

Table X: Fixed ObservationRange.moodCode
Code Display Name
EVN.CRT event criterion
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

ObservationRange.code

The particular kind of Observation that the ObservationRange-instance represents within its class. ObservationRange.code, if used, SHALL be a specialization of the ObservationRange.classCode. This attribute defines a specific sub-type of a given Observation type (determined by the "classCode" attribute). The ObservationRange.code is bound to the ActCode concept domain.

ObservationRange.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the ObservationRange. The ObservationRange.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.

ObservationRange.isCriterionInd

Is set to true to indicate that the data conveyed by the ObservationRange, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.

ObservationRange.value

The result of the ObservationRange action. Extensive usage notes are available in the RIM, reference Value UsageNotes

ObservationRange.valueNegationInd

ObservationRange.valueNegationInd, indicates that when the ObservationRange event occurred, the finding communicated by the value attribute was NOT found. Note: This attribute should only be used when the terminology used for ObservationRange.value is not itself capable of expressing negated findings. (E.g. ICD9).

ObservationRange.interprerationCode

A qualitative interpretation of the ObservationRange. These interpretation codes are sometimes called "abnormal flags," however, the judgment of normalcy is just one of the interpretations, and is often not relevant. For example, the susceptibility interpretations are not about "normalcy," and for any observation of a pathologic condition, it does not make sense to state the normalcy, since pathologic conditions are never considered "normal."

5.3.6.4 ObservationMedia

A derivative of the RIM Observation class that represents multimedia that is logically part of the current document. This class is only for multimedia that is logically part of the attested content of the document. Rendering a referenced ObservationMedia requires a software tool that recognizes the particular MIME media type. The distinction between ObservationMedia and ExternalObservation is that ObservationMedia entries are part of the attested content of the document whereas ExternalObservations are not. For instance, when a clinician draws a picture as part of a progress note, that picture is represented as a CDA ObservationMedia. If that clinician is also describing a finding seen on a chest-x-ray, the referenced chest-x-ray is represented as a CDA ExternalObservation.

Table X: ObservationMedia Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] <= OBS is V:ActClassObservation Closed
moodCode CS [1..1] EVN Fixed
id SET <II> [0..*]
languageCode CE [0..1] D:HumanLanguage Closed
value ED [1..1]

NOTE: XML ID Attribute added

An XML attribute "ID" of type XML ID, is added to ObservationMedia within the CDA Schema. This attribute serves as the target of a <renderMultiMedia> reference (see <renderMultiMedia>). All values of attributes of type XML ID must be unique within the document (per the W3C XML specification).

ObservationMedia.classCode

The ObservationMedia.classCode is defaulted to "OBS" for Observation, but can be set to any sub-type of Observation that may more accurately characterize the multi-media referenced via the ObservationMedia class.

Table X: Value set for ObservationMedia.classCode
V:ActClassObservation [2.16.840.1.113883.1.11.11529] (CLOSED)
Code Display Name Code Display Name
OBS (Default) Observation ALRT detected issue
BATTERY battery CLNTRL clinical trial
CONC concern COND Condition
CASE public health case OUTB outbreak
DGIMG diagnostic image GEN genomic observation
DETPOL determinant peptide EXP expression level
LOC locus PHN phenotype
POL polypeptide SEQ bio sequence
SEQVAR bio sequence variation INVSTG investigation
OBSSER observation series OBSCOR correlated observation sequences
POS position POSACC position accuracy
POSCOORD position coordinate SPCOBS specimen observation
VERIF Verification ROIBND bounded ROI
ROIOVL overlay ROI LLD (Deprecated) left lateral decubitus
PRN (Deprecated) prone RLD (Deprecated) right lateral decubitus
SFWL (Deprecated) Semi-Fowler's SIT (Deprecated) sitting
STN (Deprecated) standing SUP (Deprecated) supine
RTRD (Deprecated) reverse trendelenburg TRD (Deprecated) trendelenburg
CNOD (Deprecated) Condition Node
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

ObservationMedia.moodCode

The ObservationMedia.moodCode is fixed to "EVN" or event mood to indicate that this is ObservationMedia is from a past service.

Table X: Fixed ObservationMedia.moodCode
Code Display Name
EVN event (occurrence)
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

ObservationMedia.id

An optional identifier for the ObservationMedia instance.

ObservationMedia.languageCode

Specifies the human language of character data (whether they be in contents or attribute values).

ObservationMedia.value

The ObservationMedia.value is set to the xsi:type="ED" which enables the referencing of the multi-media object. Review the ED data type for more information about linking to files.

5.3.6.5 Organizer

A derivative of the RIM Act class, which can be used to create arbitrary groupings of other CDA entries that share a common context. An Organizer can contain other Organizers and/or other CDA entries, by traversing the component relationship. An Organizer can refer to external acts by traversing the reference relationship. An Organizer cannot be the source of an entryRelationship relationship.

NOTE: CDA entries such as Observation can also contain other CDA entries by traversing the entryRelationship class. There is no requirement that the Organizer entry be used in order to group CDA entries.
Table X: Organizer Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] V:x_ActClassDocumentEntryOrganizer Closed
moodCode CS [1..1] EVN Fixed
id SET <II> [0..*]
code CD [0..1] D:ActCode Open
text ED [0..1]
statusCode CS [0..1] V:ActStatus Closed
effectiveTime IVL<TS> [0..1]
activityTime GTS [0..1]
availabilityTime TS [0..1]
priorityCode CE [0..1] D:ActPriority Open
confidentialityCode SET<CE> [0..*] D:Confidentiality Open

Organizer.classCode

The Organizer.classCode can take on one of two values, BATTERY or CLUSTER.

  1. CLUSTER is an ACT that organizes a set of component acts into a semantic grouping that have a shared subject. The subject may be either a subject participation (SBJ), subject act relationship (SUBJ), or child participation/act relationship types.
  2. The BATTERY is an observation that is composed of a set of observations. These observations typically have a logical or practical grouping for generally accepted clinical or functional purposes, such as observations that are run together because of automation. A battery can define required and optional component observations and, in some cases, will define complex rules that determine whether or not a particular observation is made. BATTERY is a constraint on the Observation class in that it is understood to always be composed of component observations.
Table X: Value set for Organizer.classCode
V:x_ActClassDocumentEntryOrganizer [2.16.840.1.113883.1.11.19598] (CLOSED)
Code Display Name Code Display Name
BATTERY battery CLUSTER Cluster
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

Organizer.moodCode

The Organizer.moodCode is fixed to the "EVN" or event mood to indicate that the Organizer has been created with the contents specified.


Table X: Fixed Organizer.moodCode
Code Display Name
EVN event (occurrence)
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

Organizer.id

An optional identifier for the Organizer instance.

Organizer.code

The particular kind of Organizer that the Organizer-instance represents within its class. Organizer.code, if used, SHALL be a specialization of the Organizer.classCode. This attribute defines a specific sub-type of a given Organizer type (BATTERY or CLUSTER). The Organizer.code is bound to the ActCode concept domain.

Organizer.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Organizer. The Organizer.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.

Organizer.statusCode

The status reflects the state of the activity. The RIM based state machine diagram depicts the allowable state transitions that an Organizer.StatusCode can take on.

Table X: Value set for Organizer.statusCode
V:ActStatus [2.16.840.1.113883.1.11.15933] (CLOSED)
Code Display Name Code Display Name
normal normal aborted aborted
active active cancelled cancelled
completed completed held held
new new suspended suspended
nullified nullified obsolete obsolete
Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14

Organizer.effectiveTime

The optional Organizer.effectiveTime is used to indicate the clinically or operationally relevant time of an Organizer's component items, exclusive of administrative activity. For example, in a Blood Gas Analysis (BGA), a result might not be available for several minutes after the specimen was taken. The effectiveTime is the time the specimen was taken, the availabilityTime would be the time the result was available for review.

Organizer.activityTime

The optional Organizer.activityTime is a time expression specifying when the activityTime of the Organizer's component items occurred, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the component Acts occurred, is supposed to occur, is scheduled to occur, etc.

Organizer.availabilityTime

The optional Observation.availabilityTime is the point in time at which information about the component Acts regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the Organizer's component activities themselves.

Organizer.priorityCode

The optional priorityCode identifies the urgency under which the component Act's happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Organizer.priorityCode is bound to the ActPriority concept domain.

Organizer.confidentialityCode

The optional confidentialityCode identifies any constraints around appropriate disclosure of information about this Organizer and it's component Acts, regardless of mood. The Organizer.confidentialityCode is bound to the Confidentiality concept domain.

5.3.6.6 Procedure

A derivative of the RIM Procedure class, is represents an act whose immediate and primary outcome (post-condition) is the alteration of the physical condition of the subject.

Table X: Procedure Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] <= PROC is V:ActClassProcedure Closed
moodCode CS [1..1] V:x_DocumentProcedureMood Closed
id SET <II> [0..*]
code CD [0..1] D:ActProcedureCode Open
actonNegationInd BL [0..1]
negationInd (Deprecated) BL [0..1]
text ED [0..1]
statusCode CS [0..1] V:ActStatus Closed
effectiveTime IVL<TS> [0..1]
activityTime GTS [0..1]
availabilityTime TS [0..1]
priorityCode CE [0..1] D:ActPriority Open
confidentialityCode SET<CE> [0..*] D:Confidentiality Open
uncertaintyCode CE [0..1] D:ActUncertainty Open
languageCode CE [0..1] D:HumanLanguage Closed
isCriterionInd BL [0..1]
methodCode CE [0..*] D:ProcedureMethod Open
approachSiteCode CE [0..*] D:ActSite Open
targetSiteCode CE [0..*] D:ActSite Open

Procedure.classCode

The defines a specific sub-type of a given Procedure type. The Procedure.classCode is bound to the V:ActClassProcedure value set.

Table X: Value set for Procedure.classCode
V:ActClassProcedure [2.16.840.1.113883.1.11.19665] (CLOSED)
Code Display Name Code Display Name
PROC (Default) procedure SBEXT Substance Extraction
SPECCOLLECT Specimen Collection
Note: Although SBADM is technically allowed, is best used with the SubstanceAdministration Entry Class
SBADM substance administration
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

Procedure.moodCode

The intended use of the Procedure statement: as a procedure report, a command, a possibility, a goal, etc. Since the mood code is a determining factor for the meaning of an entire Procedure object, the mood must always be known. This means that whenever an Procedure is instantiated, the mood attribute SHALL be assigned to a valid code, and the mood assignment SHALL NOT change throughout the lifetime of the Procedure.

Table X: Value set for Procedure.moodCode
V:x_DocumentProcedureMood [2.16.840.1.113883.1.11.19460] (CLOSED)
Code Display Name Code Display Name
APT appointment ARQ appointment request
EVN event DEF definition
RQO request INT intent
PRMS promise PRP proposal
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

Procedure.id

A unique identifier for the Procedure.

Procedure.code

The particular kind of Procedure that the Procedure-instance represents within its class. Procedure.code, if used, SHALL be a specialization of the Procedure.classCode. This attribute defines a specific sub-type of a given Procedure type (determined by the "classCode" attribute). The Procedure.code is bound to the ActProcedureCode concept domain.

Procedure.actionNegationInd

The Procedure.actionNegationInd works as a negative existence quantifier on the actual, intended or described Procedure event. In Event mood, it indicates the defined procedure did not occur. In Intent mood, it indicates the defined procedure is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.

The actionNegationInd negates the Act as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, isCriterionInd, methodCode, approachSiteCode, targetSiteCode and any of their components.

The remaining properties represent the document characteristics, E.g. Procedure.id, Procedure.moodCode, Procedure.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.

Procedure.negationInd

Procedure.negationInd, is deprecated in RIM 2.35, and CDA R2.1 retains it for backwards compatibility. CDA R2.1 compliant implementation guides should use actionNegationInd moving forward.

Procedure.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Procedure. The Procedure.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.

Procedure.statusCode

The status reflects the state of the activity. The RIM based state machine diagram depicts the allowable state transitions that an Procedure.statusCode can take on.

Table X: Value set for Procedure.statusCode
V:ActStatus [2.16.840.1.113883.1.11.15933] (CLOSED)
Code Display Name Code Display Name
normal normal aborted aborted
active active cancelled cancelled
completed completed held held
new new suspended suspended
nullified nullified obsolete obsolete
Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14


Procedure.effectiveTime

Procedure.effectiveTime is used to indicate the clinically or operationally relevant time of a procedure, exclusive of administrative activity. For a surgical procedure (operation), the effectiveTime is the time relevant for the patient, i.e., between incision and last suture. For transportation acts, the effective time is the time the transported payload is en route.

Procedure.activityTime

Procedure.activityTime is a time expression specifying when a procedure occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the procedure occurred, is supposed to occur, is scheduled to occur, etc. For Procedures the activityTime can provide a needed administrative function by providing a more inclusive time to be anticipated in scheduling.

Procedure.availabilityTime

Procedure.availabilityTime is the point in time at which information about a procedure instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the procedure itself.

Procedure.priorityCode

The urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Procedure.priorityCode is bound to the ActPriority concept domain.

Procedure.confidentialityCode

Constraints around appropriate disclosure of information about this Procedure, regardless of mood. The Procedure.confidentialityCode is bound to the Confidentiality concept domain.

Procedure.uncertaintyCode

An indication that the Procedure statement as a whole, with its subordinate components has been asserted to be uncertain in some way. The use of the uncertaintyCode is appropriate only if the entirety of the Procedure and its dependent Acts is questioned. The Procedure.uncertaintyCode is bound to the ActUncertainty concept domain.

Procedure.languageCode

The primary language in which this Procedure statement is specified, particularly the language of the Procedure.text. The Procedure.languageCode is bound to the HumanLanguage concept domain.

Procedure.isCriterionInd

Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.

Procedure.methodCode

The means or technique used to ascertain the observation. In some procedures the method is already partially specified by the Procedure.code. In this case, the methodCode NEED NOT be used at all. The methodCode MAY still be used to identify this method more clearly in addition to what is implied from the Procedure.code. However, an information consumer system or process SHOULD NOT depend on this methodCode information for method detail that is implied by the Procedure.code.

Procedure.approachSiteCode

The anatomical site or system through which the procedure reaches its target.

Procedure.targetSiteCode

The anatomical site or system that is the focus of the procedure. Most procedure target sites are implied by the procedure definition and Procedure.code, or Procedure.value. If the subject of the procedure is something other than a human patient or animal, the attribute is used analogously to specify a structural landmark of the thing where the Procedure occurred.

5.3.6.7 RegionOfInterest

A derivative of the RIM Observation class that represents a region of interest on an image, using an overlay shape. RegionOfInterest is used to make reference to specific regions in images, e.g., to specify the site of a physical finding by "circling" a region in a schematic picture of a human body. The relationship between a RegionOfInterest and its referenced ObservationMedia or ExternalObservation is specified by traversing the entryRelationship or reference class, respectively, where typeCode equals "SUBJ". A RegionOfInterest must reference exactly one ObservationMedia or one ExternalObservation. If the RegionOfInterest is the target of a <renderMultimedia> reference, then it shall only reference an ObservationMedia and not an ExternalObservation.

Table X: RegionOfInterest Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] ROIOVL Fixed
moodCode CS [1..1] EVN Fixed
id SET <II> [0..*]
code CE [0..1] V:ROIOverlayShape Closed
value LIST<INT> [1..*]

NOTE: XML ID Attribute added

An XML attribute "ID" of type XML ID, is added to RegionOfInterest within the CDA Schema. This attribute serves as the target of a <renderMultiMedia> reference (see <renderMultiMedia>). All values of attributes of type XML ID must be unique within the document (per the W3C XML specification).

RegionOfInterest.classCode

The RegionOfInterest.classCode is fixed to "ROIOVL" which is a Region of Interest (ROI) specified for an image using an overlay shape. Typically used to make reference to specific regions in images, e.g., to specify the location of a radiologic finding in an image or to specify the site of a physical finding by "circling" a region in a schematic picture of a human body. The units of the coordinate values are in pixels. The origin is in the upper left hand corner, with positive X values going to the right and positive Y values going down. The relationship between a ROI and its referenced Act is specified through an ActRelationship of type "subject" (SUBJ), which must always be present.

Table X: Fixed RegionOfInterest.classCode
Code Display Name
ROIOVL overlay ROI
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

RegionOfInterest.moodCode

The RegionOfInterest.moodCode is fixed to "EVN" or event mood to indicate that this is region of interest, was created.

Table X: Fixed RegionOfInterest.moodCode
Code Display Name
EVN (Fixed) event (occurrence)
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

RegionOfInterest.id

The optional RegionOfInterest.id allows for the unique identification of the region of interest.

RegionOfInterest.code

There are 4 types of regions that can be created, they are determined by the RegionOfInterest.code which can take on 1 of the following codes: circle, ellipse, point and polyline.

Table X: Value set for RegionOfInterest.code
V:ROIOverlayShape [2.16.840.1.113883.1.11.16117] (CLOSED)
Code Display Name Code Display Name
CIRCLE circle ELLIPSE ellipse
POINT point POLY polyline
Code System: ActCode (HL7) Code System OID: 2.16.840.1.113883.5.4

RegionOfInterest.value

The RegionOfInterest.value units are pixels, expressed as a list of integers. The origin is in the upper left hand corner, with positive X values going to the right and positive Y values going down.


EXAMPLE

The following example illustrates one sample use of RegionOfInterest. In this case, the clinician has identified a rash upon physical examination of the skin, and indicates this by creating a region of interest atop a hand image taken from an image library. The narrative block references the RegionOfInterest via the <renderMultiMedia> tag, and the referenced RegionOfInterest references the hand image.

Example X
<section>
   <code code="8709-8" codeSystem="2.16.840.1.113883.6.1" 
    codeSystemName="LOINC"/>
   <title>Skin Exam</title>
   <text>Erythematous rash, palmar surface, left index 
    finger.<renderMultiMedia referencedObject="MM2"/>
   </text>
   <entry>
      <observation classCode="OBS" moodCode="EVN">
         <code code="271807003" 
          codeSystem="2.16.840.1.113883.6.96" 
          codeSystemName="SNOMED CT" 
          displayName="Rash"/>
         <statusCode code="completed"/>
         <targetSiteCode code="48856004" 
          codeSystem="2.16.840.1.113883.6.96" 
          codeSystemName="SNOMED CT" 
          displayName="Skin of palmer surface of index finger">
            <qualifier>
               <name code="78615007" 
                codeSystem="2.16.840.1.113883.6.96" 
                displayName="with laterality"/>
               <value code="7771000" 
                codeSystem="2.16.840.1.113883.6.96" 
                displayName="left"/>
            </qualifier>
         </targetSiteCode>
         <entryRelationship typeCode="SPRT">
            <regionOfInterest classCode="ROIOVL" moodCode="EVN" ID="MM2">
               <id root="2.16.840.1.113883.19.3.1"/>
               <code code="ELLIPSE"/>
               <value value="3"/>
               <value value="1"/>
               <value value="3"/>
               <value value="7"/>
               <value value="2"/>
               <value value="4"/>
               <value value="4"/>
               <value value="4"/>
               <entryRelationship typeCode="SUBJ">
                  <observationMedia classCode="OBS" moodCode="EVN">
                     <id root="2.16.840.1.113883.19.2.1"/>
                     <value mediaType="image/jpeg">
                        <reference value="lefthand.jpeg"/>
                     </value>
                  </observationMedia>
               </entryRelationship>
            </regionOfInterest>
         </entryRelationship>
      </observation>
   </entry>
</section>

5.3.6.8 SubstanceAdministration

A derivative of the RIM SubstanceAdministration class, used for representing medication-related events such as medication history or planned medication administration orders.

Table X: SubstanceAdministration Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] SBADM Fixed
moodCode CS [1..1] V:x_DocumentSubstanceMood Closed
id SET <II> [0..*]
code CD [0..1] D:ActSubstanceAdministrationCode Open
actonNegationInd BL [0..1]
negationInd (Deprecated) BL [0..1]
text ED [0..1]
statusCode CS [0..1] V:ActStatus Closed
effectiveTime GTS [0..1]
activityTime GTS [0..1]
availabilityTime TS [0..1]
priorityCode CE [0..1] D:ActPriority Open
confidentialityCode SET<CE> [0..*] D:Confidentiality Open
repeatNumber IVL<INT> [0..1]
languageCode CE [0..1] D:HumanLanguage Closed
isCriterionInd BL [0..1]
routeCode CE [0..1] D:RouteOfAdministration Open
approachSiteCode SET<CD> [0..*] D:ActSite Open
doseQuantity IVL<PQ> [0..*]
rateQuantity IVL<PQ> [0..*]
doseCheckQuantity SET<RTO<PQ,PQ.TIME>> [0..*]
maxDoseQuantity SET<RTO<PQ,PQ.TIME>> [0..*]
administrationUnitCode CE [0..1] D:AdministrableDrugForm Open

SubstanceAdministration.classCode

The SubstanceAdministration.classCode is fixed to "SBADM" which indicates an act of introducing or otherwise applying a substance to the subject.

Table X: Fixed SubstanceAdministration.classCode
Code Display Name
SBADM substance administration
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

SubstanceAdministration.moodCode

SubstanceAdministration.moodCode has been bound to the x_DocumentSubstanceMood value set.

Table X: Fixed SubstanceAdministration.moodCode
V:x_DocumentSubstanceMood [2.16.840.1.113883.1.11.19461] (CLOSED)
Code Display Name Code Display Name
EVN event DEF definition
RQO request INT intent
PRMS promise PRP proposal
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

SubstanceAdministration.id

The optional SubstanceAdministration.id can be used to uniquely identify the substance administration.

SubstanceAdministration.code

The SubstanceAdministration.code has been bound to the ActSubstanceAdministrationCode concept domain.

SubstanceAdministration.actionNegationInd

The SubstanceAdministration.actionNegationInd works as a negative existence quantifier on the actual, intended or described substance administration event. In Event mood, it indicates the defined substance administration did not occur. In Intent mood, it indicates the defined substance administration is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.

The actionNegationInd negates the SubstanceAdministration as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, repeatNumber, isCriterionInd, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode and any of their components.

The remaining properties represent the document characteristics, E.g. SubstanceAdministration.id, SubstanceAdministration.moodCode, SubstanceAdministration.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.

SubstanceAdministration.negationInd

SubstanceAdministration.negationInd, is deprecated in RIM 2.35, and CDA R2.1 retains it for backwards compatibility. CDA R2.1 compliant implementation guides should use actionNegationInd moving forward.


SubstanceAdministration.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the SubstanceAdministration. The SubstanceAdministration.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.

SubstanceAdministration.statusCode

The status reflects the state of the activity. The RIM based state machine diagram depicts the allowable state transitions that an SubstanceAdministration.StatusCode can take on.

Table X: Value set for SubstanceAdministration.statusCode
V:ActStatus [2.16.840.1.113883.1.11.15933] (CLOSED)
Code Display Name Code Display Name
normal normal aborted aborted
active active cancelled cancelled
completed completed held held
new new suspended suspended
nullified nullified obsolete obsolete
Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14

SubstanceAdministration.effectiveTime

SubstanceAdministration.effectiveTime is the clinically relevant time of an substance administration act, exclusive of administrative activity. It is used to indicate the time over which the substance is to be administered, including the frequency of administration (e.g., TID for 10 days). SubstanceAdministration.effectiveTime is used to describe the timing of administration. It is modeled using the GTS data type to accommodate various dosing scenarios, as illustrated in the following example.

SubstanceAdministration.activityTime

SubstanceAdministration.activityTime is a time expression specifying when the substance administration activity occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. The substance administration activityTime can provide a needed administrative function, by providing a more inclusive time to be anticipated in scheduling.

SubstanceAdministration.availabilityTime

SubstanceAdministration.availabilityTime is the point in time at which information about a substance administration instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the substance administration itself.

SubstanceAdministration.priorityCode

The urgency under which the SubstanceAdministration happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The SubstanceAdministration.priorityCode is bound to the ActPriority concept domain.

SubstanceAdministration.confidentialityCode

Constraints around appropriate disclosure of information about this SubstanceAdministration, regardless of mood. The SubstanceAdministration.confidentialityCode is bound to the Confidentiality concept domain.


SubstanceAdministration.repeatNumber

An interval of integer numbers stating the minimal and maximal number of repetitions of the SubstanceAdministration.

SubstanceAdministration.languageCode

The primary language in which this SubstanceAdministrationstatement is specified, particularly the language of the SubstanceAdministration.text. The SubstanceAdministration.languageCode is bound to the HumanLanguage concept domain.

SubstanceAdministration.isCriterionInd

Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.

SubstanceAdministration.routeCode

The physiological path or route for introducing the therapeutic material into or onto the subject. Route, site of administration (administrationSiteCode), method of administration (methodCode) and the device used in administration are closely related. All four (if present) must be closely coordinated and in agreement. In some cases, the coding system used to specify one may pre-coordinate one or more of the others.

SubstanceAdministration.approachSiteCode

The anatomical site or system through which the procedure reaches its target.

SubstanceAdministration.doseQuantity

SubstanceAdministration.doseQuantity indicates how much medication is given per dose.

SubstanceAdministration.rateQuantity

SubstanceAdministration.rateQuantity can be used to indicate the rate at which the dose is to be administered (e.g., the flow rate for intravenous infusions).

SubstanceAdministration.doseCheckQuantity

The ratio of a quantity to be consumed over the period of time during which it expected to be consumed.

SubstanceAdministration.maxDoseQuantity

SubstanceAdministration.maxDoseQuantity is used to capture the maximum dose of the medication that can be given over a stated time interval (e.g., maximum daily dose of morphine, maximum lifetime dose of doxorubicin).

SubstanceAdministration.administrationUnitCode

A unit for the administered substance.

  1. This attribute SHOULD be used if and only if the material specified as the player of the Role attaching to the consumable participation is not in itself the finished dose form to be administered but a larger whole, pack, etc.
  2. If the material so specified is the proper administered dose form, such as a tablet, capsule, etc. then this attribute SHOULD be valued NULL (not applicable).
  3. If the material so specified is an amorphous substance (liquid, gas, powder, etc.) to be measured as a volume, mass, etc., then this attribute SHOULD remain NULL (not applicable).
  4. If the material so specified is a container, and the content is to be measured as a volume, mass, etc., then this attribute SHOULD be specified as "measured portion".


Example X
<section>
   <text>Take captopril 25mg PO every 12 hours, starting on 
    Jan 01, 2002, ending on Feb 01, 2002.
   </text>
   <entry>
      <substanceAdministration classCode="SBADM" moodCode="RQO">
         <effectiveTime xsi:type="IVL_TS">
            <low value="20020101"/>
            <high value="20020201"/>
         </effectiveTime>
         <effectiveTime xsi:type="PIVL_TS" operator="A">
            <period value="12" unit="h"/>
         </effectiveTime>
         <routeCode code="PO" 
          codeSystem="2.16.840.1.113883.5.112" 
          codeSystemName="RouteOfAdministration"/>
         <doseQuantity value="1"/>
         <consumable>
            <manufacturedProduct>
               <manufacturedLabeledDrug>
                  <code code="318821008" 
                   codeSystem="2.16.840.1.113883.6.96" 
                   codeSystemName="SNOMED CT" 
                   displayName="Captopril 25mg tablet"/>
               </manufacturedLabeledDrug>
            </manufacturedProduct>
         </consumable>
      </substanceAdministration>
   </entry>
</section>
5.3.6.8.1 consumable

The capture of medication-related information also involves the interrelationship of SubstanceAdministration with several other classes.

Table X: consumable
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] CSM consumable
contextControlCode CS [0..1] OP Fixed

consumable.typeCode

The consumable.typeCode is fixed to "CSM" to represent a consumable participation.

Table X: Fixed consumable.typeCode
Code Display Name
CSM consumable
Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90

consumable.contextControlCode

The consumable.contextControlCode is fixed to "OP". It means that the consumable identified will replace the set of consumables that have propagated from ancestor Acts, and will itself be the only consumable to propagate to any child Acts that allow context to be propagated.

5.3.6.8.2 ManufacturedProduct

The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance via the ManufacturedProduct role class.

ManufacturedProduct.classCode

The ManufacturedProduct.typeCode is fixed to "MANU" to represent the role of manufactured. The playing role is what was manufactured and the scoping role identifies the manufacturer.

Table X: Fixed ManufacturedProduct.classCode
Code Display Name
MANU manufactured
Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110

ManufacturedProduct.id

An optional unique identifier assigned by the manufacturer.

5.3.6.8.3 LabeledDrug

The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name.

LabeledDrug.classCode

The LabeledDrug.classCode is fixed to "MMAT" which indicates the substance administered was manufactured.

Table X: Fixed LabeledDrug.classCode
Code Display Name
MMAT A manufactured material.
Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41

LabeledDrug.determinerCode

The determinerCode is fixed to "KIND", which indicates that the LabeledDrug referenced, represents a kind or class of Labeled drug.

Table X: Fixed LabeledDrug.determinerCode
Code Display Name
KIND described
Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30

LabeledDrug.code

The LabeledDrug.code is bound to the DrugEntity concept domain, which identifies a substance whose therapeutic effect is produced by chemical action within the body.

LabeledDrug.name'

An optional non-unique textual identifier or moniker for the LabeledDrug.

5.3.6.8.4 Material

The Material entity can be used to identify non-drug administered substances such as vaccines and blood products and drugs.

Material.classCode

The Material.classCode is fixed to "MMAT" which indicates the material administered was manufactured.

Table X: Fixed Material.classCode
Code Display Name
MMAT A manufactured material.
Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41

Material.determinerCode

The determinerCode is fixed to "KIND", which indicates that the Material referenced, represents a kind or class of Material.

Table X: Fixed Material.determinerCode
Code Display Name
KIND described
Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30

Material.code

The Material.code is bound to the MaterialEntityClassType concept domain, which identifies types of materials.

Material.name

An optional non-unique textual identifier or moniker for the Material.

Material.desc

A textual or multimedia depiction of the Material.

Material.formCode

The physical state and nature of the material.

Material.lotNumberText

An identifier for a particular batch of manufactured material.

5.3.6.9 Supply

The Supply class represents dispensing, whereas the SubstanceAdministration class represents administration. Prescriptions are complex activities that involve both an administration request to the patient (e.g. take digoxin 0.125mg by mouth once per day) and a supply request to the pharmacy (e.g. dispense 30 tablets, with 5 refills). This should be represented in CDA by a SubstanceAdministration entry that has a component Supply entry. The nested Supply entry can have Supply.independentInd set to "false" to signal that the Supply cannot stand alone, without it's containing SubstanceAdministration. The following example illustrates a prescription representation in CDA.

Table X: Supply Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] SPLY Fixed
moodCode CS [1..1] V:x_DocumentSubstanceMood Closed
id SET <II> [0..*]
code CD [0..1] D:ActSupplyType Open
actonNegationInd BL [0..1]
text ED [0..1]
statusCode CS [0..1] V:ActStatus Closed
effectiveTime GTS [0..1]
activityTime GTS [0..1]
availabilityTime TS [0..1]
priorityCode CE [0..*] D:ActPriority Open
confidentialityCode SET<CE> [0..*] D:Confidentiality Open
repeatNumber IVL<INT> [0..1]
independentInd BL [0..1]
languageCode CE [0..1] D:HumanLanguage Closed
isCriterionInd BL [0..1]
quantity PQ [0..1]
expectedUseTime IVL<TS> [0..1]

Supply.classCode

The Supply.classCode is fixed to "SPLY" which is used to represent a Supply. Supply orders and deliveries are simple Acts that focus on the delivered product. The product is associated with the Supply Act via Participation.typeCode="product". With general Supply Acts, the precise identification of the Material (manufacturer, serial numbers, etc.) is important. Most of the detailed information about the Supply should be represented using the Material class.

Table X: Fixed Supply.classCode
Code Display Name
SPLY supply
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

Supply.moodCode

The Supply.moodCode is bound to the x_ClinicalStatementSubstanceMood value set.

Table X: Value set for Supply.moodCode
V:x_ClinicalStatementSubstanceMood [2.16.840.1.113883.1.11.19645] (CLOSED)
Code Display Name Code Display Name
EVN event DEF definition
RQO request INT intent
PRMS promise PRP proposal
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

Supply.id

The optional Supply.id is used to uniquely identify the supply activity.

Supply.code

The optional Supply.code is bound to the ActSupplyType concept domain, which is used to further define the type of supply for order or distribution. Examples:

  • central supply
  • materials management
  • nurse station supply

Supply.actionNegationInd

The Supply.actionNegationInd works as a negative existence quantifier on the actual, intended or described Supply event. In Event mood, it indicates the defined supply act did not occur. In Intent mood, it indicates the defined supply act is not intended/desired to occur. In Criterion mood, it indicates that the condition is based on the non-occurrence of the event. It is nonsensical to have a negationInd of true for acts with a mood of definition.

The actionNegationInd negates the Supply act as described by the descriptive properties which are: classCode, code, statusCode, effectiveTime, activityTime, priorityCode, repeatNumber, independentInd, isCriterionInd, quantity, expectedUseTime and any of their components.

The remaining properties represent the document characteristics, E.g. Supply.id, Supply.moodCode, Supply.confidentialityCode, and particularly the Author-Participation are not negated. These document characteristic properties always have the same meaning: i.e., the author remains to be the author of the negative observation. Also, most ActRelationships (except for components) are not included in the negation. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.

Supply.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Supply activity.

Supply.statusCode

The status reflects the state of the activity. The RIM based state machine diagram depicts the allowable state transitions that an Supply.StatusCodes can take on.

Table X: Value set for Supply.statusCode
V:ActStatus [2.16.840.1.113883.1.11.15933] (CLOSED)
Code Display Name Code Display Name
normal normal aborted aborted
active active cancelled cancelled
completed completed held held
new new suspended suspended
nullified nullified obsolete obsolete
Code System: ActStatus (HL7) Code System OID: 2.16.840.1.113883.5.14

Supply.effectiveTime

Supply.effectiveTime is used to indicate the clinically or operationally relevant time of a supply, exclusive of administrative activity.

Supply.activityTime

Supply.activityTime is a time expression specifying when a supply occurs, inclusive of administrative time E.g. times of component actions, such as preparation and clean-up. Depending on the mood code used, it represents the time the Supply activity occurred, is supposed to occur, is scheduled to occur, etc.

Supply.availabilityTime

Supply.availabilityTime is the point in time at which information about an Supply instance (regardless of mood) first became available to a system. The availabilityTime is metadata describing the recording of, not the Supply itself.

Supply.priorityCode

The urgency under which the Supply activity happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. The Supply.priorityCode is bound to the ActPriority concept domain.

Supply.confidentialityCode

Constraints around appropriate disclosure of information about this Supply activity, regardless of mood. The Supply.confidentialityCode is bound to the Confidentiality concept domain.

Supply.repeatNumber

An interval of integer numbers stating the minimal and maximal number of repetitions of the Supply activity.

Supply.independentInd

An indicator specifying whether the Act can be manipulated independently of other Acts or only through a super-ordinate composite Act that has this Act as a component. By default the independentInd should be true. An Act definition is sometimes marked with independentInd=false if the business rules would not allow this act to be ordered without ordering the containing act group.

Supply.languageCode

The primary language in which this Supply statement is specified, particularly the language of the Supply.text. The Supply.languageCode is bound to the HumanLanguage concept domain.


Supply.isCriterionInd

Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.

Supply.quantity

The optional Supply.quantity is used to represent the amount of material that was or is to be supplied.

Supply.expectedUseTime

Th optional Supply.expectedUseTime is used to identify the period time over which the supplied product is expected to be used.

5.3.6.9.1 Product

The dispensed product is associated with the Supply act via a product participant, which connects to the same ManufacturedProduct role used for SubstanceAdministration.

Product.typeCode

The Product.typeCode is fixed to "PRD" which represents a product participation.

Table X: Fixed product.typeCode
Code Display Name
PRD product
Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90
5.3.6.9.2 ManufacturedProduct

See ManufacturedProduct above.


Example X
<section>
   <text>Digoxin 0.125mg, 1 PO qDay, #30, 5 refills.</text>
   <entry>
      <substanceAdministration classCode="SBADM" moodCode="RQO">
         <effectiveTime xsi:type="PIVL_TS">
            <period value="24" unit="h"/>
         </effectiveTime>
         <routeCode code="PO" 
          codeSystem="2.16.840.1.113883.5.112" 
          codeSystemName="RouteOfAdministration"/>
         <doseQuantity value="1"/>
         <consumable>
            <manufacturedProduct>
               <manufacturedLabeledDrug>
                  <code code="317896006" 
                   codeSystem="2.16.840.1.113883.6.96" 
                   codeSystemName="SNOMED CT" 
                   displayName="Digoxin 125micrograms tablet"/>
               </manufacturedLabeledDrug>
            </manufacturedProduct>
         </consumable>
         <entryRelationship typeCode="COMP">
            <supply classCode="SPLY" moodCode="RQO">
               <repeatNumber>
                  <low value="0"/>
                  <high value="5"/>
               </repeatNumber>
               <independentInd value="false"/>
               <quantity value="30"/>
            </supply>
         </entryRelationship>
      </substanceAdministration>
   </entry>
</section>

5.3.7 Entry Participants

CDA structures and entries can have various participants, some of which are also defined in the CDA header. As described in the discussion of CDA context (see CDA Context), participants propagated from the header can be overridden within the body.

5.3.7.1 author

The author participant (described above, see author), can be ascribed to a CDA section where it overrides the value(s) propagated from the CDA header, or can be ascribed to a CDA entry, where it overrides the value(s) propagated from a CDA section and propagates to nested entries.

5.3.7.2 consumable

The consumable participant is described above (see Entry Acts).

5.3.7.3 informant

The informant participant (described above, see informant), can be ascribed to a CDA section where it overrides the value(s) propagated from the CDA header, or can be ascribed to a CDA entry, where it overrides the value(s) propagated from a CDA section and propagates to nested entries.

5.3.7.4 participant

Can be used to represent any other participant that cannot be represented with one of the more specific participants. The participant can be ascribed to a CDA entry, and propagates to nested CDA entries, unless overridden.

Table X: informant
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] INF Fixed
functionCode CE [0..1] D:ParticipationFunction Open
contextControlCode CS [0..1] OP Fixed
time IVL<TS> [0..1]
awarenessCode CE [0..1] D:TargetAwareness Open

participant.typeCode

The participant.typeCode is bound to the v:ParticipationType value set. This enables a wide range of participation types to be selected. Note: Where an existing participation exists, it should be used in preference to the generic participation, failure to do so, will result in needlessly additional complexity for implementations.

Table X: Value set for participant.typeCode
v:ParticipationType [2.16.840.1.113883.1.11.10901] (CLOSED)
Code Display Name Code Display Name
PART Participation ADM admitter
ATND attender ADM admitter
CALLBCK callback contact CON consultant
DIS discharger ESC escort
REF referrer TRANS Transcriber
ENT data entry person WIT witness
CST custodian DIR direct target
BBY baby DEV device
NRD non-reuseable device RDV reusable device
EXPAGNT ExposureAgent EXPART ExposureParticipation
EXPTRGT ExposureTarget EXSRC ExposureSource
IND indirect target BEN beneficiary
CAGNT causative agent COV coverage target
GUAR guarantor party HLD holder
DON donor RCV receiver
IRCP information recipient NOT ugent notification contact
PRCP primary information recipient REFB Referred By
REFT Referred to TRC tracker
LOC location DST destination
ELOC entry location ORG origin
RML remote VIA via
RESP responsible party VRF verifier
AUTHEN authenticator
Use the following participations, only if the other participations provided in CDA will not work
RCT record target AUT author (originator)
INF informant CSM consumable
PRD product SBJ subject
SPC specimen PRF performer
DIST distributor PPRF primary performer
SPRF secondary performer LA legal authenticator
Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90

participant.functionCode

The participant.functionCode is bound to the concept domain ParticipationFunction, which is used to specify the exact function an actor had in a service in all necessary detail. This domain may include local extensions (Open).

participant.contextControlCode

The participant.contextControlCode is fixed to "OP". Any participant(s) defined in a clinical entry, will override the participants with the same typeCode propagating from ancestor elements, in the header, body or sections.

Table X: Fixed participant.contextControlCode
Code Display Name
OP overriding, propagating
Code System: ContextControl (HL7) Code System OID: 2.16.840.1.113883.5.1057

participant.time

The time during which the participant is involved in the act through this Participation.

participant.awarenessCode

The extent to which the Entity playing the participating Role is aware of the associated Act. For diagnostic observations, the patient, family member or other participant may not be aware of the patient's terminal illness. Because this attribute typically indicates that awareness is in question, it normally describes a target Participation (e.g., that of a patient). If the awareness, denial, unconsciousness, etc. is the subject of medical considerations (e.g., part of the problem list), explicit observations should be employed: this simple attribute in the Participation cannot represent information sufficient to support medical decision-making.

5.3.7.4.1 ParticipantRole

A participant is an entity playing one of several possible roles (ParticipantRole class). The entity playing the role is a device (Device class) or other entity (PlayingEntity class).

Table X: ParticipantRole
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [1..1] V:RoleClassRoot Fixed
id SET<II> [0..*]
code CE [0..1] D:RoleCode Open
addr SET<AD> [0..*]
telecom SET<TEL> [0..*]

ParticipantRole.classCode

The ParticipantRole.classCode can be any role defined in the V:RoleClassRoot value set, not already provided for the Clinical Statement choice pattern.

Table X: Value set for ParticipantRole.classCode
V:RoleClassRoot [2.16.840.1.113883.1.11.13940] (CLOSED)
Code Display Name Code Display Name
ROL (Default) role AFFL affiliate
AGNT agent ASSIGNED assigned entity
COMPAR commissioning party SGNOFF signing authority or officer
CON contact ECON emergency contact
NOK next of kin GUARD guardian
CIT citizen COVPTY covered party
CLAIM claimant NAMED named insured
DEPEN dependent INDIV individual
SUBSCR subscriber PROG program eligible
CRINV clinical research investigator CRSPNSR clinical research sponsor
EMP employee MIL military person
GUAR guarantor INVSBJ Investigation Subject
CASEBJ Case Subject RESBJ research subject
LIC licensed entity NOT notary public
PROV healthcare provider PAT patient
PAYEE payee PAYOR invoice payor
POLHOLD policy holder QUAL qualified entity
SPNSR underwriter STD student
UNDWRT coverage sponsor CAREGIVER caregiver
PRS personal relationship ACCESS access
ADMM Administerable Material BIRTHPL birthplace
DEATHPLC place of death DST distributed material
RET retailed material EXPR exposed entity
HLD held entity HLTHCHRT health chart
IDENT identified entity MANU manufactured product
THER therapeutic agent MNT maintained entity
OWN owned entity RGPR regulated product
SDLOC service delivery location DSDLOC dedicated service delivery location, health care facility
ISDLOC incidental service delivery location TERR territory of authority
USED used entity WRTE warranted product
EQUIV equivalent entity SAME same
SUBY subsumed by GEN has generalization
GRIC has generic INST instance
SUBS subsumer CONT content
EXPAGTCAR exposure agent carrier EXPVECTOR exposure vector
FOMITE fomite INGR ingredient
ACTI active ingredient ACTIB active ingredient - basis of strength
ACTIM active ingredient - moiety is basis of strength ACTIR active ingredient - reference substance is basis of strength
ADTV additive BASE base
IACT inactive ingredient COLR color additive, color
FLVR flavor additive, flavor PRSV preservative
STBL stabilizer LOCE located entity
STOR stored entity MBR member
PART part ACTM active moiety
SPEC specimen ALQT aliquot
ISLT isolate
Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110

ParticipantRole.id

The optional participantRole.id is a unique identifier for the player Entity in this Role.

ParticipantRole.code

The optional ParticipantRole.code is bound the the EntityCode concept domain.

ParticipantRole.addr

The optional ParticipantRole.addr is the postal address for the Entity while in the Role.

ParticipantRole.telecom

The optional ParticipantRole.telecom is the telecommunication address (phone number) for the Entity while in the Role.

5.3.7.4.2 Device

Scoping the ParticipantRole is an entity (Entity class).

Table X: Device
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] DEV Fixed
determinerCode CS [0..1] INSTANCE Fixed
code CE [0..1] D:EntityCode
manufacturerModelName SC [0..1] D:ManufacturerModelName
softwareName SC [0..1] D:SoftwareName

Device.classCode

The Device.classCode is defaulted to "DEV", but can take on any value defined in the EntityClassDevice value set.

Table X: Value set for Device.classCode
V:EntityClassDevice [2.16.840.1.113883.1.11.11623] (CLOSED)
Code Display Name Code Display Name
DEV (Default) role CER certificate representation
MODDV imaging modality, ImagingModalityEntity
Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41

Device.determinerCode

The determinerCode is fixed to "INSTANCE", which indicates we are referencing a specific device.

Table X: Fixed Device.determinerCode
Code Display Name
INSTANCE specific
Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30

Device.code

The optional Device.code is bound to the EntityCode domain.

Device.manufacturerModelName

The optional Device.manufacturerModelName is used to convey a coded name for the device.

Device.softwareName

The optional Device.softwareName is used to convey a coded name for the software used to author content.

5.3.7.4.3 PlayingEntity
Table X: PlayingEntity
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] DEV Fixed
determinerCode CS [0..1] INSTANCE Fixed
code CE [0..1] D:EntityCode
quantity PQ [0..1]
name SET<PN> [0..1]
desc ED [0..1]

PlayingEntity.classCode

The PlayingEntity.classCode is bound to the V:EntityClassRoot value set.

Table X: Value set for PlayingEntity.classCode
V:EntityClassRoot [2.16.840.1.113883.1.11.13922] (CLOSED)
Code Display Name Code Display Name
ENT (Default) entity HCE health chart entity
LIV living subject NLIV non-person living subject
ANM animal MIC microorganism
PLNT plant PSN person
MAT material CHEM chemical substance
FOOD food MMAT manufactured material
CONT container HOLD holder
DEV device CER certificate representation
MODDV imaging modality, ImagingModalityEntity ORG organization
PUB public institution STATE state
NAT Nation PLC place
CITY city or town COUNTRY country
COUNTY county or parish PROVINCE state or province
RGRP group
Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41

PlayingEntity.determinerCode

The determinerCode is fixed to "INSTANCE", which indicates we are referencing a specific entity.

Table X: Fixed PlayingEntity.determinerCode
Code Display Name
INSTANCE specific
Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30

PlayingEntity.code

The optional PlayingEntity.code is bound to the EntityCode domain. For each Entity, the value for this attribute is drawn from one of several coding systems as suggested by the Entity.classCode, such as living subject (animal and plant taxonomies), chemical substance (e.g., IUPAC code), organization (e.g., CMS provider number), etc. It is possible that Entity.code may be so fine grained that it represents a single instance. An example is the CDC vaccine manufacturer code, modeled as a concept vocabulary, when in fact each concept refers to a single instance. The boundary cases distinguishing codes and identifiers are controversial: this specification allows a certain amount of flexibility.

PlayingEntity.quantity

The optional PlayingEntity.quantity defines the a physical quantity specifying the amount of the physical thing represented by the Entity object, either as a count of the members of a group, or as some other physical quantity. In order to explicitly identify a group of like entities, a static model design should constrain the PQ data type of this attribute to INT, thus providing a count of the entities in the group.

PlayingEntity.name

Most entities have a commonly used name that can be used to differentiate them from other Entities, but that does not provide a necessarily unique identifier.

PlayingEntity.desc

A textual or multimedia depiction of the Entity.

5.3.7.4.4 Entity

A physical thing, group of physical things or an organization capable of participating in Acts while in a role.

Table X: Entity
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] [http://cda/infrastructure/vocabulary/EntityClass.htm#ENT ENT Fixed
determinerCode CS [0..1] INSTANCE Fixed
id SET<II> [0..*]
code CE [0..1] D:EntityCode
desc ED [0..1]

Entity.classCode

The Entity.classCode is bound to the V:EntityClassRoot value set.

Table X: Value set for Entity.classCode
V:EntityClassRoot [2.16.840.1.113883.1.11.13922] (CLOSED)
Code Display Name Code Display Name
ENT (Default) entity HCE health chart entity
LIV living subject NLIV non-person living subject
ANM animal MIC microorganism
PLNT plant PSN person
MAT material CHEM chemical substance
FOOD food MMAT manufactured material
CONT container HOLD holder
DEV device CER certificate representation
MODDV imaging modality, ImagingModalityEntity ORG organization
PUB public institution STATE state
NAT Nation PLC place
CITY city or town COUNTRY country
COUNTY county or parish PROVINCE state or province
RGRP group
Code System: EntityClass (HL7) Code System OID: 2.16.840.1.113883.5.41

Entity.determinerCode

The determinerCode is fixed to "INSTANCE", which indicates we are referencing a specific entity.

Table X: Fixed Entity.determinerCode
Code Display Name
INSTANCE specific
Code System: EntityDeterminer (HL7) Code System OID: 2.16.840.1.113883.5.30

Entity.id

The optional Entity.id is used to uniquely identify the Entity.

Entity.code

The optional Entity.code is bound to the EntityCode domain.

Entity.desc

The optional Entity.desc is a textual or multimedia depiction of the Entity.

5.3.7.5 performer

The performer is a person who carries out or will carry out a particular act. The performer need not be the principal responsible participant, e.g. a surgery resident operating under supervision of attending surgeon is a performer.

Table X: performer
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] PRF Fixed
functionCode CE [0..1] D:ParticipationFunction Open
time IVL<TS> [0..1]
modeCode CE [0..1] D:ParticipationMode Fixed

performer.typeCode

The performer.typeCode is fixed to "PRF" which indicates a person, or organization that actually and principally carries out the action. Need not be the principal responsible actor.

Table X: Fixed performer.typeCode
Code Display Name
PRF performer
Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90

performer.functionCode

The performer.functionCode is bound to the concept domain ParticipationFunction, which is used to specify the exact function an actor had in a service in all necessary detail. This domain may include local extensions (Open).


performer.time

An optional interval of time which indicating the performer's participation in the associated Act.

performer.modeCode

The modality by which the Entity playing the Role is participating in the Act.

5.3.7.5.1 AssignedEntity

A performer is an entity in the role of assigned entity (AssignedEntity class).

5.3.7.5.2 Person

An assigned entity is a person assigned to the role by the scoping organization. The entity playing the role is a Person class.

5.3.7.5.3 Organization

The entity scoping the role is an organization (Organization class).

5.3.7.6 product

The product participant is described above (see Entry Acts).

5.3.7.7 specimen

A specimen is a part of some entity, typically the subject, that is the target of focused laboratory, radiology or other observations. In many clinical observations, such as physical examination of a patient, the patient is the subject of the observation, and there is no specimen. The specimen participant is only used when observations are made against some substance or object that is taken or derived from the subject.

Table X: informant
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] SPC Fixed

specimen.typeCode

The specimen.typeCode is fixed to "SPC" to indicate the subject of non-clinical (e.g. laboratory) observation services is a specimen.

Table X: Fixed specimen.typeCode
Code Display Name
SPC specimen
Code System: ParticipationType (HL7) Code System OID: 2.16.840.1.113883.5.90
5.3.7.7.1 SpecimenRole

A role played by a material entity that is a specimen for an act.

Table X: AssignedAuthor
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] SPEC Fixed
id SET<II> [0..*]

SpecimenRole.classCode

The SpecimenRole.classCode is fixed to "SPEC".

Table X: Fixed SpecimenRole.classCode
Code Display Name
SPEC specimen
Code System: RoleClass (HL7) Code System OID: 2.16.840.1.113883.5.110

SpecimenRole.id

An optional SpecimenRole.id can be used to uniquely identify the specimen.

5.3.7.7.2 PlayingEntity

A specimen is an PlayingEntity in the role of SpecimenRole (PlayingEntity class).

5.3.7.8 subject

The subject participant (described above, see subject), can be ascribed to a CDA section, or it can be ascribed to a CDA entry, where it overrides the value(s) propagated from a CDA section and propagates to nested entries.

5.3.8 Entry Relationships

5.3.8.1 component

The component relationship has a source of Organizer (see Organizer, and a target that is another CDA entry, and is used to create groupings of CDA entries within an Organizer.

Table X: documentationOf Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] COMP Fixed
contextConductionInd BL [0..1]
sequenceNumber INT [0..1]
seperatableInd BL [0..1]

component.typeCode

The component.typeCode is fixed to "COMP", which indicates that the associated Clinical Statement choice is a component part of the Organizer.

Table X: Fixed component.typeCode
Code Display Name
COMP (FIXED) has component
Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002

component.contextConductionInd

The component.contextConductionInd indicator is fixed to "true". Ancestor elements () which propagate, will conduct through this component class to the associated child element.

component.sequenceNumber

The optional component.sequenceNumber is an integer specifying the relative sequential ordering of this relationship among other like-types relationships having the same source Act.

component.seperatableInd

The optional component.seperatableInd is an indication that the source Act is intended to be interpreted independently of the target Act. The default value is true.

5.3.8.2 precondition

The precondition class, derived from the ActRelationship class, is used along with the Criterion class to express a condition that must hold true before some over activity occurs.

Table X: precondition Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] PRCN Fixed

precondition.typeCode

The precondition.typeCode is fixed to PRCN which indicates a requirement to be true before a service is performed. The target can be any service in criterion mood. For multiple pre-conditions a conjunction attribute (AND, OR, XOR) is applicable.

Table X: Fixed precondition.typeCode
Code Display Name
PRCN has pre-condition
Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002
5.3.8.2.1 Criterion

Criterion class is used to express a condition that must hold true before some over activity occurs.

Table X: Criterion Attributes
RIM Attribute(s) Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] <= OBS is V:ActClassObservation Closed w/ Default
moodCode CS [0..1] ENV.CRT Fixed
code CD [1..1] D:ActCode Open
actonNegationInd BL [0..1]
text ED [0..1]
isCriterionInd BL [0..1]
value SET<ANY> [0..*] D:ObservationValue Open
valueNegationInd BL [0..1]
interpretationCode SET<CE> [0..*] D:ObservationInterpretation Open

Criterion.classCode

The Criterion.classCode is defaulted to "OBS" which represents an observation, but can take only any value defined in the ActClassObservation value set.

Table X: Value set for Criterion.classCode
V:ActClassObservation [2.16.840.1.113883.1.11.11529] (CLOSED)
Code Display Name Code Display Name
OBS (Default) Observation ALRT detected issue
BATTERY battery CLNTRL clinical trial
CONC concern COND Condition
CASE public health case OUTB outbreak
DGIMG diagnostic image GEN genomic observation
DETPOL determinant peptide EXP expression level
LOC locus PHN phenotype
POL polypeptide SEQ bio sequence
SEQVAR bio sequence variation INVSTG investigation
OBSSER observation series OBSCOR correlated observation sequences
POS position POSACC position accuracy
POSCOORD position coordinate SPCOBS specimen observation
VERIF Verification ROIBND bounded ROI
ROIOVL overlay ROI LLD (Deprecated) left lateral decubitus
PRN (Deprecated) prone RLD (Deprecated) right lateral decubitus
SFWL (Deprecated) Semi-Fowler's SIT (Deprecated) sitting
STN (Deprecated) standing SUP (Deprecated) supine
RTRD (Deprecated) reverse trendelenburg TRD (Deprecated) trendelenburg
CNOD (Deprecated) Condition Node
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

Criterion.moodCode

The Criterion.moodCode is fixed to "EVN.CRT" which indicates a criterion or condition over service events that must apply for an associated service to be considered.

Table X: Fixed Criterion.moodCode
Code Display Name
EVN.CRT event criterion
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

Criterion.code

The particular kind of Criterion that the Criterion-instance represents. Criterion.code, if used, SHALL be a specialization of the Criterion.classCode. This attribute defines a specific sub-type of a given Criterion type. It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the Criterion. The Criterion.code is bound to the ActCode concept domain.

Criterion.actionNegationInd

The Criterion.actionNegationInd indicates that the condition is based on the non-occurrence of the event.

The actionNegationInd negates the Criterion as described by the descriptive properties which are: classCode, code, isCriterionInd, value, valueNegationInd, interpretationCode and any of their components.

The remaining properties represent the document characteristics, E.g. Criterion.moodCode, Criterion.text are not negated. Refer to the attribute isDocumentCharacteristic property and the ActRelationshipType and ParticipationType code system isDocumentCharacteristic properties for specific guidance.

Criterion.text

A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Criterion. The Criterion.text attribute can reference the associated narrative content in the section using the XML ID attribute added to the Narrative Text elements.

Criterion.isCriterionInd

Is defaulted to false, when set to true it indicates that the data conveyed by the act, including outbound associations, represent "criteria" for some other act, not a "real" act. I.e. If an Act exists with a classCode of ACT and a moodCode of RQO and isCriterionInd is true, it does not represent an order for an act. Rather, it represents a criteria that will match on all orders.


Criterion.value

The result of the observation action. Extensive usage notes are available in the RIM, reference Value UsageNotes

Criterion.valueNegationInd

Criterion.valueNegationInd, indicates that the Criterion, as defined in in this Criterion class is NOT true. Note: This attribute should only be used when the terminology used for Criterion.value is not itself capable of expressing negated findings. (E.g. ICD9).

Criterion.interpretationCode

A qualitative interpretation of the Criterion. These interpretation codes are sometimes called "abnormal flags," however, the judgment of normalcy is just one of the interpretations, and is often not relevant. For example, the susceptibility interpretations are not about "normalcy," and for any observation of a pathologic condition, it does not make sense to state the normalcy, since pathologic conditions are never considered "normal."

5.3.8.3 referenceRange

The referenceRange relationship (described above, see Observation), has a source of Observation, and a target of ObservationRange.

5.3.8.4 entryRelationship

CDA has identified and modeled various link and reference scenarios. These scenarios enable CDA entries to be semantically linked to entries that exist within the same document (by traversing the entryRelationship class) or to objects external to it (by traversing the reference class).

Table X: entryRelationship Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] V:ActRelationshipType Closed
inversionInd BL [0..1]
contextConductionInd BL [0..1]
sequenceNumber INT [0..1]
negationInd BL [0..1]
seperatableInd BL [0..1]


In CDA R2.0, the following entryRelationships scenarios were provided as informative content:

Table X: Examples of typical entryRelationships
ActRelationship Type Reasonable Source and Target entries Comments
CAUS
(is etiology for)		 (Act | Observation | Procedure | SubstanceAdministration) CAUS (Observation) Used to show that the source caused the target observation (for instance, source "diabetes mellitus" is the cause of target "kidney disease").
COMP
(has component)		 (Act | Observation | Procedure | SubstanceAdministration | Supply) COMP (Act | Observation | Procedure | SubstanceAdministration | Suppply) Used to show that the target is a component of the source (for instance "hemoglobin measurement" is a component of a "complete blood count").
GEVL
(evaluates (goal))		 (Observation) GEVL (Observation) Used to link an observation (intent or actual) to a goal to indicate that the observation evaluates the goal (for instance, a source observation of "walking distance" evaluates a target goal of "adequate walking distance").
MFST
(is manifestation of)		 (Observation) MFST (Observation) Used to say that the source is a manifestation of the target (for instance, source "hives" is a manifestation of target "penicillin allergy").
REFR
(refers to)		 (Act | Observation | Procedure | SubstanceAdministration | Supply) REFR (Act | Observation | ObservationMedia | Procedure | RegionOfInterest | SubstanceAdministration | Supply) Used to show a general relationship between the source and the target, when the more specific semantics of the relationship isn't known.
RSON
(has reason)		 (Act | Encounter | Observation | Procedure | SubstanceAdministration | Supply) RSON (Act | Encounter | Observation | Procedure | SubstanceAdministration | Supply) Used to show the reason or rational for a service (for instance source "treadmill test" has reason "chest pain").
SAS
(starts after start)		 (Act | Encounter | Observation | Procedure | SubstanceAdministration | Supply) SAS (Act | Encounter | Observation | Procedure | SubstanceAdministration | Supply) The source Act starts after the start of the target Act (for instance source "diaphoresis" starts after the start of target "chest pain").
SPRT
(has support)		 (Observation) SPRT (Observation | ObservationMedia | RegionOfInterest) Used to show that the target provides supporting evidence for the source (for instance source "possible lung tumor" has support target "mass seen on chest-x-ray").
SUBJ
(has subject)		 (Observation | RegionOfInterest) SUBJ (Observation | ObservationMedia) Used to relate a source region of interest to a target image, or to relate an observation to its subject observation (for instance, source "moderate severity" has subject target "chest pain").
NOTE: The preceding table provides examples of reasonable relationships between CDA entries, but does not represent a conformance constraint.

The ActRelationshipType "has subject" is similar to the ParticipationType "subject". Entries that primarily operate on physical subjects use the Participation, whereas entries that primarily operate on other entries use the ActRelationship.

XCRPT (is excerpt of) (Act | Observation) XCRPT (Act | Observation | Procedure | SubstanceAdministration | Supply) Used to show that the source is excerpted from the target (for instance source "hemoglobin value of 12" is an excerpt of target "complete blood count").

The distinction between an excerpt and an informant participant can be blurry — such as in the case of recording a patient's medication history where the clinician may obtain the information from an informant or may excerpt the information from another computer system. An informant (or source of information) is a person who provides relevant information. An informant class is in the header, and can be overridden in the body. An excerpt is a sub portion of some other act.

entryRelationship.typeCode

In CDA R2.1 any entry (excluding Organizer), may be related to another entry, using the entryRelationship class. In the entryRelationship class, the typeCode attribute is used to define the semantic relationship that exists between the source or parent entry and the destination or child entry. The value set binding on typeCode was been significantly enhanced in CDA R2.1, and now any code present in the HL7 entryRelationship code system (RIM 2.35) may be used.

Table X: Value set for entryRelationship.typeCode
V:ActRelationshipType [2.16.840.1.113883.1.11.10317] (CLOSED)
Code Display Name Code Display Name
CIND has contra-indication PRCN has pre-condition
RSON has reason BLOCK Blocks
CURE curative indication CURE.ADJ adjunct curative indication
DIAG diagnosis MITGT mitigates
RCVY Recovery [http://cda/infrastructure/vocabulary/ActRelationshipType.htm#MTGT.ADJ MTGT.ADJ adjunct mitigation
SYMP symptomatic relief TRIG has trigger
COMP has component ARR arrival
CTRLV has control variable DEP departure
OUTC has outcome OBJC has continuing objective
OBJF has final objective GOAL has goal
RISK has risk PERT has pertinent information
SAE starts after end of SAS starts after start of
CHRG has charge COST has cost
CREDIT has credit DEBIT has debit
AUTH authorized by CAUS is etiology for
COVBY covered by DRIV is derived from
ELNK episodeLink EVID provides evidence for
EXACBY exacerbated by EXPL has explanation
ITEMSLOC items located LIMIT limited by
MFST is manifestation of NAME assigns name
PREV has previous instance REFR refers to
REFV has reference values RELVBY relieved by
SPRT has support SPRTBND has bounded support
SUBJ has subject SUMM summarized by
SEQL is sequel APND is appendage
COMPLY Update DOC documents
FLFS fulfills OCCR occurrence
OREF references order SCH schedules request
GEN has generalization GEVL evaluates (goal)
INST instantiates (master) MOD modifies
MTCH matches (trigger) OPTN has option
RCHAL re-challenge REV reverses
RPLC replaces SUCC succeeds
UPDT updates (condition) XCRPT Excerpts
VRXCRPT Excerpt verbatim XFRM transformation
Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002
Note: Implementation Guide ("IG") authors will need to exercise caution and ensure they fully understand the semantics of the relationship defined by the term they have selected. In addition, IG authors will need to understand the impact of both inversionInd and negationInd flags, as these attributes can materially impact those semantics when machine processing.

entryRelationship.inversionInd

The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. As in the example provided in CDA R2.0, "treadmill test" RSON (has reason) "chest pain". Inverted, this would have "chest pain" as the source and "treadmill test" as the target: "chest pain" RSON (inverted) "treadmill test". Inversion can be useful when the current context is describing the target of an act relationship that needs to be related back to the source.

The entryRelationship.negationInd can be set to "true" to indicate that the meaning of the link is negated. Examples where this might be useful:

  • If the relationship without negation specifies that Act A has Act B as a component, then the negation indicator specifies that Act A does not have Act B as a component.
  • If B is a reason for A, then negation means that B is not a reason for A.
  • If B is a pre-condition for A, then negation means that B is not a precondition for A.

entryRelationship.contextConductionInd

The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute (see CDA Context) in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

entryRelationship.sequenceNumber

An integer specifying the relative sequential ordering of this relationship among other like-types relationships having the same source Act.

entryRelationship.negationInd

An indicator that asserts that the meaning of the link is negated.

entryRelationship.seperatableInd

An indication that the source Act is intended to be interpreted independently of the target Act. The value is defaulted to true.

5.3.8.5 reference

CDA entries can reference external objects such as external images and prior reports. These external objects are not part of the authenticated document content. They contain sufficient attributes to enable an explicit reference rather than duplicating the entire referenced object. The CDA entry that wraps the external reference can be used to encode the specific portions of the external reference that are addressed in the narrative block.

Each object allows for an identifier and a code, and contains the RIM Act.text attribute, which can be used to store the URL and MIME type of the object. External objects always have a fixed moodCode of "EVN".

Table X: reference Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
typeCode CS [0..1] V:ActRelationshipExternalReference Fixed
seperatableInd BL [0..1]


reference.typeCode

A description of allowable reference.typeCode values are shown in the following table.

Table X: Value set for reference.typeCode
V:ActRelationshipType [2.16.840.1.113883.1.11.10317] (CLOSED)
Code Display Name Code Display Name
ELNK episodeLink REFR refers to
SPRT has support RPLC replaces
XCRPT Excerpts
Code System: ActRelationshipType (HL7) Code System OID: 2.16.840.1.113883.5.1002

reference.seperatableInd

The reference class contains the attribute reference.seperatableInd, which indicates whether or not the source is intended to be interpreted independently of the target. The indicator cannot prevent an individual or application from separating the source and target, but indicates the author's desire and willingness to attest to the content of the source if separated from the target. Typically, where seperatableInd is "false", the exchanged package should include the target of the reference so that the recipient can render it.


As in the table above (CDA entryRelationship Types), the following table is a guideline for reasonable relationships between CDA entries and external objects, and is not a conformance constraint.

Table X: EXAMPLE entryRelationship Types
ActRelationship Type Reasonable Source and Target classes Comments
ELNK
(episode link)		 (Observation) ELNK (ExternalObservation) Used to show that the source and the target are part of the same episode (for instance, a diagnosis of "pneumonia" can be linked to an external problem list entry of "pneumonia" to show that the current diagnosis is part of the ongoing episode of pneumonia).
REFR
(refers to)		 (Act | Observation | Procedure | SubstanceAdministration | Supply) REFR (ExternalAct | ExternalDocument | ExternalObservation | ExternalProcedure) Used to show a general relationship between the source and the target, when the more specific semantics of the relationship isn't known.
RPLC
(replace)		 (Act | Encounter | Observation | ObservationMedia | Organizer | Procedure | SubstanceAdministration | Supply) RPLC (ExternalAct | ExternalDocument | ExternalObservation | ExternalProcedure) Used to indicate that the source entry is a replacement for the target external act.
SPRT
(has support)		 (Observation) SPRT (ExternalDocument | ExternalObservation) Used to show that the target provides supporting evidence for the source.
SUBJ
(has subject)		 (Observation | RegionOfInterest) SUBJ (ExternalObservation) Used to relate a source region of interest to a target image, or to relate an observation to its subject observation.
XCRPT
(is excerpt of)		 (Act | Observation) XCRPT (ExternalAct | ExternalDocument | ExternalObservation | ExternalProcedure) Used to show that the source is excerpted from the target (for instance "the hemoglobin is 10.7" is an excerpt of an externally referenced "complete blood count").

Target classes of the reference relationship include ExternalAct, ExternalDocument, ExternalObservation, and External Procedure.


5.3.8.5.1 ExternalAct

The ExternalAct is a derivative of the RIM Act class, to be used when the other more specific classes are not appropriate.

Table X: ExternalAct Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] <= ACT is V:ActClassRoot Closed w/ Default
moodCode CS [0..1] EVN Fixed
id II [1..*]
code CD [0..1] D:ActCode Open
text ED [0..1]

ExternalAct.classCode

The ExternalAct.classCode is bound to the ActClassRoot value set.

Table X: Value set for ExternalAct.classCode
V:ActClassRoot [2.16.840.1.113883.1.11.13856] (CLOSED)
Code Display Name Code Display Name
ACT (Default) act COMPOSITION composition, Attestable unit
DOC document DOCCLIN clinical document
CDALVLONE CDA Level One clinical document CONTAINER record container
CATEGORY category DOCBODY document body
CATEGORY document section, Section TOPIC topic
EXTRACT extract EHR electronic health record
FOLDER folder GROUPER grouper
CLUSTER Cluster ACCM accommodation
ACCT account ACSN accession
ADJUD financial adjudication, financial adjudication results CACT control act
ACTN action INFO information
STC state transition control CNTRCT contract
FCNTRCT financial contract COV coverage
CONS consent CONTREG container registration
CTTEVENT clinical trial timepoint event DISPACT disciplinary action
EXPOS exposure AEXPOS acquisition exposure
TEXPOS transmission exposure INC incident
INFRM inform INVE invoice element
LIST working list MPROT monitoring program
OBS Observation ALRT detected issue
BATTERY battery CLNTRL clinical trial
CONC concern COND Condition
CASE public health case OUTB outbreak
DGIMG diagnostic image GEN genomic observation
DETPOL determinant peptide EXP expression level
LOC locus PHN phenotype
POL polypeptide SEQ bio sequence
SEQVAR bio sequence variation INVSTG investigation
OBSSER observation series OBSCOR correlated observation sequences
POS position POSACC position accuracy
POSCOORD position coordinate SPCOBS specimen observation
VERIF Verification ROIBND bounded ROI
ROIOVL overlay ROI PCPR care provision
ENC encounter POLICY policy
JURISPOL jurisdictional policy ORGPOL organizational policy
SCOPOL scope of practice policy STDPOL standard of practice policy
PROC procedure SBEXT Substance Extraction
SPECCOLLECT Specimen Collection SBADM substance administration
REG registration REV review
SPCTRT specimen treatment SPLY supply
DIET diet STORE storage
SUBST Substitution TRFR transfer
TRNS transportation XACT financial transaction
CNOD (Deprecated) Condition Node LLD (Deprecated) left lateral decubitus
PRN (Deprecated) prone RLD (Deprecated) right lateral decubitus
SFWL (Deprecated) Semi-Fowler's SIT (Deprecated) sitting
STN (Deprecated) standing SUP (Deprecated) supine
RTRD (Deprecated) reverse trendelenburg TRD (Deprecated) trendelenburg
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

ExternalAct.moodCode

The ExternalAct.moodCode is fixed to "EVN" which represents the event mood. Indicating that the act has taken place and this is information about that act.

Table X: Fixed ExternalAct.moodCode
Code Display Name
EVN event
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

ExternalAct.id

The unique instance identifier for the ExternalAct.

ExternalAct.code

The particular kind of Act that the Act-instance represents within its class. ExternalAct.code, if used, SHALL be a specialization of the ExternalAct.classCode. This attribute defines a specific sub-type of a given Act type (determined by the "classCode" attribute). It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the limited set of Act types defined by "classCode." The ExternalAct.code is bound to the ActCode concept domain.

ExternalAct.text

A reference to a renderable textual or multimedia description of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the ExternalAct.

5.3.8.5.2 ExternalDocument

The ExternalDocument is a derivative of the RIM Document class, used for representing external documents. ExternalDocument.text is modeled as an ED data type - allowing for the expression of the MIME type of the external document.

Table X: ExternalDocument Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] <=DOC is V:ActClassDocument Closed w/ Default
moodCode CS [0..1] EVN Fixed
typeId II [1..1]
id II [1..*]
code CE [1..1] D:DocumentType Open
text ED [0..1]
setId II [0..1]
versionNumber ST.SIMPLE [0..1]

ExternalDocument.classCode

The ExternalDocument.classCode is fixed to "DOCCLIN"

Table X: Fixed ExternalDocument.classCode
V:ActClassDocument [2.16.840.1.113883.1.11.18938] (CLOSED)
Code Display Name Code Display Name
DOC(Default) document

DOCCLIN||clinical document

CDALVLONE CDA Level One clinical document
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

ExternalDocument..moodCode

The ExternalDocument.moodCode is fixed to "EVN" which represents the event mood. Indicating that the document has been created and is available.

Table X: Fixed ExternalDocument.moodCode
Code Display Name
EVN event
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

ExternalDocument.id

The unique instance identifier for the ExternalDocument.

ExternalDocument.code

The ExternalDocument.code is bound to the DocumentType concept domain.

ExternalDocument.text

A reference to the external document.

ExternalDocument.setId

The ExternalDocument.setId is an optional identifier that does not change with revisions to a document.

ExternalDocument.versionNumber

The ExternalDocument.setId is an optional version number, that must be used with the setId to identify a given document.

5.3.8.5.3 ExternalObservation

The ExternalObservation is a derivative of the RIM Observation class, used for representing external coded and other observations.

Table X: ExternalObservation Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] <= OBS is V:ActClassObservation Closed w/ Default
moodCode CS [0..1] EVN Fixed
id II [1..*]
code CD [0..1] D:ActCode Open
text ED [0..1]

ExternalObservation.classCode

The ExternalObservation.classCode is defaulted to "OBS" in indicate an observation, but be be set to any code in the ActCode concept domain.

Table X: Value set for ExternalObservation.classCode
V:ActClassObservation [2.16.840.1.113883.1.11.11529] (CLOSED)
Code Display Name Code Display Name
OBS (Default) Observation ALRT detected issue
BATTERY battery CLNTRL clinical trial
CONC concern COND Condition
CASE public health case OUTB outbreak
DGIMG diagnostic image GEN genomic observation
DETPOL determinant peptide EXP expression level
LOC locus PHN phenotype
POL polypeptide SEQ bio sequence
SEQVAR bio sequence variation INVSTG investigation
OBSSER observation series OBSCOR correlated observation sequences
POS position POSACC position accuracy
POSCOORD position coordinate SPCOBS specimen observation
VERIF Verification ROIBND bounded ROI
ROIOVL overlay ROI LLD (Deprecated) left lateral decubitus
PRN (Deprecated) prone RLD (Deprecated) right lateral decubitus
SFWL (Deprecated) Semi-Fowler's SIT (Deprecated) sitting
STN (Deprecated) standing SUP (Deprecated) supine
RTRD (Deprecated) reverse trendelenburg TRD (Deprecated) trendelenburg
CNOD (Deprecated) Condition Node
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

ExternalObservation.moodCode

The ExternalObservation.moodCode is fixed to "EVN" which represents the event mood. Indicating that the observation has taken place and this is information about that observation.

Table X: Fixed ExternalObservation.moodCode
Code Display Name
EVN event
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

ExternalObservation.id

The unique instance identifier for the ExternalObservation.

ExternalObservation.code

The particular kind of observation that the observation-instance represents within its class. ExternalObservation.code, if used, SHALL be a specialization of the ExternalObservation.classCode. This attribute defines a specific sub-type of a given Observation type (determined by the "classCode" attribute). It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the limited set of observation types defined by "classCode." The ExternalObservation.code is bound to the ActCode concept domain.

ExternalObservation.text

A reference to a renderable textual or multimedia description of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the ExternalObservation.

5.3.8.5.4 ExternalProcedure

The ExternalProcedure is a derivative of the RIM Procedure class, used for representing external procedures.

Table X: ExternalProcedure Attributes
Attribute Name Data Type Cardinality Code Binding Binding Type
classCode CS [0..1] PROC Fixed
moodCode CS [0..1] EVN Fixed
id II [1..*]
code CD [0..1] D:ActCode Open
text ED [0..1]

ExternalProcedure.classCode

The ExternalProcedure.classCode is fixed to "PROC".

Table X: Fixed ExternalProcedure.classCode
Code Display Name
PROC procedure
Code System: ActClass (HL7) Code System OID: 2.16.840.1.113883.5.6

ExternalProcedure.moodCode

The ExternalProcedure.moodCode is fixed to "EVN" which represents the event mood. Indicating that the procedure has taken place and this is information about that procedure.

Table X: Fixed ExternalProcedure.moodCode
Code Display Name
EVN event
Code System: ActMood (HL7) Code System OID: 2.16.840.1.113883.5.1001

ExternalProcedure.id

The unique instance identifier for the ExternalProcedure.

ExternalProcedure.code

The particular kind of procedure that the procedure-instance represents within its class. ExternalProcedure.code, if used, SHALL be a specialization of the ExternalProcedure.classCode. This attribute defines a specific sub-type of a given Procedure type (determined by the "classCode" attribute). It allows the use of rich terminologies such as LOINC and SNOMED to represent sub-types of the limited set of Procedure types defined by "classCode." The ExternalProcedure.code is bound to the ActCode concept domain.

ExternalProcedure.text

A reference to a renderable textual or multimedia description of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the ExternalProcedure.

5.4 CDA Context

CDA context is set in the CDA header and applies to the entire document. Context can be overridden at the level of the body, section, and/or CDA entry.

5.4.1 Overview of CDA Context

A document, in a sense, is a contextual wrapper for its contents. Assertions in the document header are typically applicable to statements made in the body of the document, unless overridden. For instance, the patient identified in the header is assumed to be the subject of observations described in the body of the document, unless a different subject is explicitly stated, or the author identified in the header is assumed to be the author of the entire document, unless a different author is explicitly identified on a section. The objective of the CDA context rules are to make these practices explicit with relationship to the RIM, such that a computer will understand the context of a portion of a document the same way that a human interprets it.

At the same time, there is no guarantee that machine processing will identify a mistaken application of contextual rules. If a physician records an "outside diagnosis" in narrative but does not nullify the "informant" context, machine processing will not identify the switch in attribution. This is a special case illustrating the limits of automated validation of electronic records and would apply regardless of the context inheritance mechanism. In other words, from some errors of encoding, there is no recovery other than human review.

CDA's approach to context, and the propagation of that context to nested document components, follows these design principles:

  • CDA uses the RIM context mechanism (contextControlCode for Participations; contextConductionInd for ActRelationships), and assigns fixed values to these attributes to accomplish the design objectives below, thus constraining the RIM context model. CDA extends the context propagation property to designated attributes of the CDA Header, which also propagate through any ActRelationship for which contextConductionInd="true".
  • The CDA Header sets context for the entire document. A propagating value specified in the document header holds true throughout the document, unless explicitly overridden. This principal applies to both Participations and to designated attributes of the CDA Header. Contextual header components (i.e., those that have propagating values) include:
    • Author
    • Confidentiality
    • Data enterer
    • Human language
    • Informant
    • Legal authenticator
    • Participant
    • Record target
  • Context components that can be overridden at the level of the document body include:
    • Confidentiality
    • Human language
  • Context components that can be overridden at the level of a document section include:
    • Author
    • Confidentiality
    • Human language
    • Informant
    • Subject
  • Context components that can be overridden at the level of a CDA entry include:
    • Author
    • Human language
    • Informant
    • Participant
    • Subject
  • Context propagates from outer tags to nested tags. Context that is specified on an outer tag holds true for all nested tags, unless overridden on a nested tag. Context specified on a tag within the CDA body always overrides context propagated from an outer tag. For instance, the specification of authorship at a document section level overrides all authorship propagated from outer tags.
  • Context is sometimes known precisely, and is sometimes unknown, such as in the case where a document is comprised of a large unparsed narrative block that potentially includes statements that contradict outer context. Because CDA context always propagates unless overridden, the representation of unknown context is achieved by overriding with a null value.

5.4.2 Technical Aspects of CDA Context

The RIM defines the "context" of an act as those participants of the act that can be propagated to nested acts. In the RIM, whether or not contextual participants do propagate to nested acts depends on whether or not the intervening act relationship between parent and child act allows for conduction of context. The explicit representation of context, and whether or not the context on an act can propagate to nested acts, is expressed via the RIM attributes Participation.contextControlCode and ActRelationship.contextConductionInd. CDA constrains the general RIM context mechanism such that context always overrides and propagates, as shown in the following table.

Table X: CDA constraints on RIM context attributes
RIM attribute Cardinality Conformance Fixed Value
Participation.contextControlCode 1..1 Mandatory (NULL values not permitted) "OP" (overriding, propagating)
ActRelationship.contextConductionInd 1..1 Mandatory (NULL values not permitted) "true"*

*The one exception to this is entryRelationship.contextConductionInd, which is defaulted to "true", but can be changed to "false". See entryRelationship for details.

Where the context of a nested component is unknown, the propagated context must be overridden with a null-valued component, as shown in the following table.

Table X: Blocking context propagation with null values
Context Null value representation
Author AssignedAuthor.id = NULL; No playing entity; No scoping entity.
Confidentiality confidentialityCode = NULL.
Human language languageCode = NULL.
Informant AssignedEntity.id = NULL; No playing entity; No scoping entity.
Participant ParticipantRole.id = NULL; No playing entity; No scoping entity.

The following exhibit illustrates the CDA context model. ClinicalDocument has an author participant, a confidentialityCode, and a languageCode, all of which will propagate to nested acts. The component act relationship going from ClinicalDocument to bodyChoice has contextConductionInd fixed as "true", thus allowing for the propagation of context. The bodyChoice classes, NonXMLBody and StructuredBody, contain a confidentialityCode and languageCode which can be used to override the value specified in the header. The component act relationship going from StructuredBody to Section has contextConductionInd fixed at "true", thus the context on StructuredBody will propagate through to Section. Section can override confidentialityCode, languageCode, and author. A null value for the Section's author participant indicates that the author for that particular section is unknown.

Link to wide graphic (opens in a new window)

Because context is always overriding and propagating, one can compute the context of a given node by looking for the most proximate assertion. The following example is a sample XPath expression that can be used to identify the <author> context of a section or entry:

Example X
(ancestor-or-self::*/author)[position()=last()]

5.4.3 InfrastructureRoot & CDA Classes

All of CDA classes inherits 1 attribute and 3 element from InfrastructureRoot. Infrastructure Root provides a set of infrastructure attributes that may be used in instances of HL7-specified, RIM-based classes. When valued in an instance, these attributes indicate whether the information structure is being constrained by specifically defined templates, realms or common element types.


  • An optional nullFlavor attribute has been added to each CDA class. When the class is null, this code can be used to indicate the flavor of null that is intended.

The following 3 optional elements have been added at the beginning of each CDA class:

  • realmCode, is vocabulary domain qualifier that allows the vocabulary domain of coded attributes to be specialized according to the geographical, organizational, or political environment where the HL7 standard is being used. It is defined as a SET<CS>data type.
  • typeId, is a unique identifier for an HL7 static structure that imposes constraints on an artifact. In CDA it must be defined at the root element, to indicate a CDA R2.1 document,with ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040UV" (which is the unique identifier for the CDA, Release Two Hierarchical Description). As CMETs are not used in CDA, this element will not be used in other classes. It is defined as a II data type.
  • templateId, is an optional unique identifier, which indicates to a receiver that a set of constraints have been defined for a given class and it's attributes. See section 4 on templates in CDA.

6 CDA Hierarchical Description

(content on separate page)

7 CDA XML Implementation

(content on separate page)

8 Appendix

(content on separate page)

Retrieved from "https://pubwiki.hl7.org/w/index.php?title=DraftCDA2.1.b&oldid=1403"