Narrative Reference - Act

back to homepage

Approval Status

  • Approval Status: Approved
  • Example Task Force: 6/1/2017
  • SDWG: 7/6/2017

C-CDA 2.1 Example:

  • Applies to all C-CDA/CDA templates with this entry type

Reference to full CDA sample:

  • This sample will not validate

Validation location

  • Not applicable

Comments

  • This example demonstrates how to link the section narrative (section.text) to the coded information (entry) below. The example includes several comments and does not conform to any specific C-CDA/CDA template. The principles agreed to in this sample should be present in all other examples.

Custodian

  • Brett Marquard, brett@riverrockassociates.com (GitHub: brettmarquard) (original design courtesy of George Cole)

Keywords

  • narrative, narrative-entry, linking text

Permalink

Links

 

Example: download example view on GitHub 

<component>
	<!-- The following section is fictitious - it exists solely for the purpose of showing examples of text/reference and originalText/reference from discrete entry children. As such, many elements are omitted and replaced by ... comments. The text and content in the discrete entry elements does not use actual clinical content, but instead relies on filler text commonly used in publishing and graphic design. -->
	<section>
		<!--  ... -->
		<text>
			<!-- The text in this section is created strictly to illustrate how discrete entry child elements make references into the human readable text. -->
			<!-- this paragraph is used for a simple act; the ID values are meant to be unique across the whole document -->
			<paragraph ID="simpleActFullTextReference1">
				<content ID="simpleActCodeReference1">Lorem ipsum dolor sit amet</content>, consectetur adipiscing elit.</paragraph>
			labetText: DD-mmm-YYYY
		</text>
		<!-- this illustrates an act, the basic class of the RIM, but in C-CDA terms the act is used for both Allergy and Problem Concerns, Authorization Activity, Comment Activity and a few other acts.
-->
		<entry>
			<!-- illustrating a simple act -->
			<act classCode="ACT" moodCode="EVN">
				<!-- ... -->
				<!-- the code is a required element of act; @displayName is an optional attribute, and when present it should represent a name (some say the name) as defined for the @code in the given @codeSystem -->
				<code code="12345" codeSystem="1.2.3.4.5.6.7.8.42" displayName="loreum ipsum">
					<!-- it is not unusual for the code of an act to be specified in an Implementation Guide and often times text of the code is not in the human readable text, so originalText SHALL NOT be present in those cases
									however, If some of the human readable text is a representation of the code, we SHOULD include a reference to that text using the originalText/reference construct 
								-->
					<originalText>
						<!-- the value of this reference begins with hashtag, and is followed by text that is the value of an ID element in the human readable text 
											notice that the referenced text is similar to but different than the @displayName  of the code element
											from an interoperability perspective, this pattern is a SHOULD as access to the human readable text reflecting the (code, codeSystem) in use is beneficial to consuming systems
									-->
						<reference value="#simpleActCodeReference1"/>
					</originalText>
				</code>
				<!-- when present, the text/reference points to the entire text of the act 
									from an interoperability perspective, this pattern is a MAY as access to the entire human readable text of the act is sometimes useful, but generally not programatically useful (NLP may be needed)
							-->
				<text>
					<!-- notice that the ID containing the referenced value is on an element that includes all text of the act.
					     in this case, the element is a paragraph, but might be a table, tbody, tr, etc....elements that typically wrap more entire concepts, not just pieces of content
					     Example referenced content, using Comment Activity: Patient is having difficulty paying co-pays for these medications.
								-->
					<reference value="#simpleActFullTextReference1"/>
				</text>
				<!-- ... -->
				<effectiveTime value="YYYMMDD"/>
			</act>
		</entry>
	</section>
</component>

  1. C-CDA Example Search Help

    C-CDA Example Search Results
    This screen displays the results of executing the example search criteria against the existing examples recorded in the example database.

  2. Search Criteria Panel

    This panel allow you to further refine your queries and narrow the results

  3. Text Search Words

    Use this field to enter words related to your search. These words can appear in the title, the comments or as part of a special list of keywords associated with the example. The search words should be entered with spaces separating the items.

  4. Filter by example status

    By selecting the various statuses, the search results can be limited to only the example that are set to the selected status(es). By removing all status selections, the filtering is removed and examples from all statuses will be returned (based on any other filtering).

  5. Select only ONC Certified examples

    These are samples referenced in a government rule or certification companion guide.

  6. Execute the search based on the criteria entered (or retrieve all examples if no criteria specified).

  7. The number of results that match the query parameters can be found here.

  8. Use this link to jump back to the initial page of the application (that lists the sections).

  9. This columns list the names of the examples that match the criteria (and the comment for each example).

  10. This columns lists the area in the C-CDA specification (the specification is broken into distinct topics for the various exchangeable documents, the common header, and the sections that occur within the exchangeable documents) that the example demonstrates.

  11. This columns lists the state of the example in the example verification and approval process.

  12. You can select to download the examples directly or navigate to page with the full detailed description of the example.

  13. Tour Complete

    Return to the C-CDA Example Search Results page.