Back To Index  <<  Back To Templates

draft Template  BC Annotation Comment

Id 1.3.6.1.4.1.19376.1.5.3.1.4.2 Effective Date valid from 2016‑04‑05 01:57:44
Status draft Draft Version Label
Name BCAnnotationComment Display Name BC Annotation Comment
Description This entry allows for a comment to be supplied with each entry.
For CDA this structure is usually included in the target act using the <entryRelationship> element defined in the CDA Schema, but can also be used in the <component> element when the comment appears within an <organizer>. The example below shows recording a comment for an <entry>, and is used as context for the following sections. For HL7 Version 3 Messages, this relationship is represented with the element <sourceOf>, although the remainder of the typecodes and semantics are unchanged. Any condition or allergy may be the subject of a comment.

See also IHE PCC Wiki Content
Context Parent nodes of template element with id 1.3.6.1.4.1.19376.1.5.3.1.4.2
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 10 templates, Uses 0 templates
Used by Template id as Name Version
1.3.6.1.4.1.19376.1.3.1 Containment draft Laboratory Report Data Processing Entry (2016) 2016‑07‑05
1.3.6.1.4.1.19376.1.3.3.2.2 link draft Laboratory Report Item Section (2016) 2016‑07‑05
1.3.6.1.4.1.19376.1.3.3.2.1 link draft BC CDA LabResultSpecialtyStructuredBody 2016‑04‑05 00:27:44
1.3.6.1.4.1.19376.1.3.3.2.2 link draft BC CDA Laboratory Report Item Section 2016‑04‑05 02:22:00
1.3.6.1.4.1.19376.1.3.1 Containment draft BC Laboratory Report Data Processing Entry 2016‑04‑05 01:31:43
1.3.6.1.4.1.19376.1.3.1.4 Containment draft Laboratory Battery Organizer (2016) 2016‑07‑05
1.3.6.1.4.1.19376.1.3.1.5 link draft BC Laboratory Isolate Organizer 2016‑09‑29 14:55:37
1.3.6.1.4.1.19376.1.3.1.4 Containment draft BC Laboratory Battery Organizer 2016‑04‑05 01:44:00
1.3.6.1.4.1.19376.1.3.1.6 Containment draft Laboratory Observation (2016) 2016‑07‑05
1.3.6.1.4.1.19376.1.3.1.6 link draft BC Laboratory Observation 2016‑04‑05 01:50:49
Relationship Specialization: template 2.16.840.1.113883.10.12.301 (2005‑09‑07)
Specialization: template 1.3.6.1.4.1.19376.1.5.3.1.4.2 (2009‑12‑04)
Example
Structure included in the target act using the <entryRelationship> element
<entry>
  <observation classCode="OBS" moodCode="EVN">
    <!-- :: -->
    <entryRelationship typeCode="SUBJ" inversionInd="true">
      <act classCode="ACT" moodCode="EVN">
        <templateId root="2.16.840.1.113883.10.20.1.40"/>        <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.2"/>        <code code="48767-8" displayName="Annotation Comment" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC"/>        <text>
          <reference value="#comment-2"/>        </text>
        <statusCode code="completed"/>        <author>
          <time value=""/>          <assignedAuthor>
            <id root="" extension=""/>            <addr>
              <!-- .. -->
            </addr>
            <telecom value="" use=""/>            <assignedPerson>
              <name>
                <!-- .. -->
              </name>
            </assignedPerson>
            <representedOrganization>
              <name>
                <!-- .. -->
              </name>
            </representedOrganization>
          </assignedAuthor>
        </author>
      </act>
    </entryRelationship>
    <!-- :: -->
  </observation>
</entry>
Example
Structure used in the <component> element when the comment appears within an <organizer>
<entry>
  <organizer>
    <!-- :: -->
    <component typeCode="COMP">
      <act classCode="ACT" moodCode="EVN">
        <templateId root="2.16.840.1.113883.10.20.1.40"/>        <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.2"/>        <code code="48767-8" displayName="Annotation Comment" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC"/>        <!-- :: -->
      </act>
    </component>
  </organizer>
</entry>
Item DT Card Conf Description Label
hl7:act
M The related statement is an event (moodCode='EVN') describing the act (classCode='ACT') of making an arbitrary comment or providing instruction on the related entry. (BCAnnotationComment)
treetree @classCode
cs 1 … 1 F ACT
treetree @moodCode
cs 1 … 1 F EVN
treetree hl7:templateId
II 1 … 1 R (BCAnnotationComment)
treeblank treetree @root
uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.2
treetree hl7:code
CD 1 … 1 M The <code> element indicates that this is a comment and shall be recorded as shown above. The codeSystem and code attributes shall use the values specified above. (BCAnnotationComment)
treeblank treetree @code
CONF 1 … 1 F 48767-8
treeblank treetree @codeSystem
1 … 1 F 2.16.840.1.113883.6.1 (Logical Observation Identifier Names and Codes)
treeblank treetree @displayName
1 … 1 F Annotation Comment
treeblank treetree @codeSystemName
1 … 1 F LOINC
treetree hl7:text
ED 1 … 1 M The <text> element provides a way to represent the <reference> to the text of the comment in the narrative portion of the document. For CDA, this SHALL be represented as a <reference> element that points to the narrative text section of the CDA. The comment itself is not the act being coded, so it appears in the <text> of the <observation>, not as part of the <code>. For HL7 Version 3 Messages, the <text> element SHALL contain the full narrative text. (BCAnnotationComment)
treetree hl7:statusCode
CS 1 … 1 M The code attribute of <statusCode> for all comments must be completed. (BCAnnotationComment)
treeblank treetree @code
CONF 1 … 1 F completed
treetree hl7:author
0 … 1 R The comment may have an author. (BCAnnotationComment)
treeblank treetree @typeCode
cs 1 … 1 F AUT
treeblank treetree hl7:time
TS 0 … 1 R The time of the comment creation shall be recorded in the <time> element when the <author> element is present. (BCAnnotationComment)
treeblank treetree hl7:assignedAuthor
1 … 1 M The identifier of the author, and their address and telephone number must be present inside the <id>, <addr> and <telecom> elements when the <author> element is present. (BCAnnotationComment)
treeblank treeblank treetree @classCode
cs 1 … 1 F ASSIGNED
treeblank treeblank treetree hl7:id
II 1 … 1 R (BCAnnotationComment)
treeblank treeblank treetree hl7:addr
AD 1 … 1 R (BCAnnotationComment)
treeblank treeblank treetree hl7:telecom
TEL 1 … 1 R (BCAnnotationComment)
Choice 1 … 2
The author's and/or the organization's name must be present when the <author> element is present.
Elements to choose from:
  • hl7:assignedPerson
  • hl7:representedOrganization
treeblank treeblank treeblank treetree hl7:assignedPerson
0 … 1 R (BCAnnotationComment)
treeblank treeblank treeblank treetree hl7:representedOrganization
0 … 1 R (BCAnnotationComment)