Consolidated CDA

Consolidated CDA (C-CDA) 1.1 and 2.1

This DECOR project is part of the HL7 Templates Work Group project that defined a generic template exchange format (Templates DSTU, see: HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1) for various template creation suites.

It must be noted that this setup is an amalgamation of C-CDA 1.1 and 2.1: Templates and Value Sets are labeled appropriately with "1.1" or "2.1" respectively but appear as versions of each other. Unlike Lantana's Trifolia Workbench that has an implementation guide viewpoint, the ART-DECOR library here looks at versions of the different document level templates with all subsequent and referenced templates and value sets. It acts as a Building Block Repository (BBR) that allows easy re-use of template s and value sets.

Conversions from Lantana's Trifolia Workbench

The templates and value sets for 1.1 and 2.1 in this decor project are tranformations from the proprietary export format of the Trifolia Workbench. They have been revised and corrected manually to fit the requirements of the Templates DSTU and to allow proper schematron generation. Please note that parts of the Trifolia Workbench maybe copyrighted by Lantana Consulting Group (see http://www.lantanagroup.com)

Status

Please note that definitions here may be IN REVIEW STATUS. The "source of truth" are the C-CDA specifications from HL7 International.

IMPORTANT NOTES

HL7 licenses its standards and select IP free of charge. If you did not acquire a free license from HL7 for this document, you are not authorized to access or make any use of it. To obtain a free license, please visit http://www.HL7.org/implement/standards/index.cfm.
If you are the individual that obtained the license for this HL7 Standard, specification or other freely licensed work (in each and every instance "Specified Material"), the following describes the permitted uses of the Material.
A. HL7 INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS, who register and agree to the terms of HL7’s license, are authorized, without additional charge, to read, and to use Specified Material to develop and sell products and services that implement, but do not directly incorporate, the Specified Material in whole or in part without paying license fees to HL7.
INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS wishing to incorporate additional items of Special Material in whole or part, into products and services, or to enjoy additional authorizations granted to HL7 ORGANIZATIONAL MEMBERS as noted below, must become ORGANIZATIONAL MEMBERS of HL7.
B. HL7 ORGANIZATION MEMBERS, who register and agree to the terms of HL7's License, are authorized, without additional charge, on a perpetual (except as provided for in the full license terms governing the Material), non-exclusive and worldwide basis, the right to (a) download, copy (for internal purposes only) and share this Material with your employees and consultants for study purposes, and (b) utilize the Material for the purpose of developing, making, having made, using, marketing, importing, offering to sell or license, and selling or licensing, and to otherwise distribute, Compliant Products, in all cases subject to the conditions set forth in this Agreement and any relevant patent and other intellectual property rights of third parties (which may include members of HL7). No other license, sublicense, or other rights of any kind are granted under this Agreement.
C. NON-MEMBERS, who register and agree to the terms of HL7’s IP policy for Specified Material, are authorized, without additional charge, to read and use the Specified Material for evaluating whether to implement, or in implementing, the Specified Material, and to use Specified Material to develop and sell products and services that implement, but do not directly incorporate, the Specified Material in whole or in part.
NON-MEMBERS wishing to incorporate additional items of Specified Material in whole or part, into products and services, or to enjoy the additional authorizations granted to HL7 ORGANIZATIONAL MEMBERS, as noted above, must become ORGANIZATIONAL MEMBERS of HL7.
Please see http://www.HL7.org/legal/ippolicy.cfm for the full license terms governing the Material.
Health Level Seven International 3300 Washtenaw Avenue Suite 227 Ann Arbor, MI 48104- 4261 USA T +1 734 677 7777 F +1 734 677 6622 E info@hl7.org The ART-DECOR expert group E info@art-decor.org E contact@art-decor.org dr Kai U. Heitmann Corrections of final C-CDA release 2.1 as of 2015-08-13 Conversion of final C-CDA release 2.1 as of 2015-08-13
Technical corrections based on issues signalled by variuos sources and an internal ART-DECOR expert group review process to address problems raised in conjunction with the DSTU HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1
  • Added datatype CS to various elements like statusCode etc
  • Review of all assert statements: it seems that the original asserts all uses the context of the top element of the respective template where they are mentioned while there hierarchical position is nested in an element. E.g. an assert aiming on a @value attribute in a cda:time element in an cda:performer element in an cda: observation and positioned within the cda:performer element had originally the xpath cda:performer/cda:time/@value. Asserts following the Templates DSTU R1 inherit their context from the element where they are mentioned in, so the correct xpath for this example is simply @value
  • The 191 original assert has been brought down to 124 due to the possibility to explicitly express choices, some of the asserts where expressed as cardinality constraints rather than an assert
  • Errors in xpath expressions of the asserts have been correct, like "not(informant) or informant/cda:*/addr" to "not(cda:informant) or cda:informant/cda:*/cda:addr"
  • The stdc: extensions have been explicitly included as an element definition rather an assert statement with a constrain that would have failed anyway. In essence sdtc:raceCode in patient, sdtc:id in relatedSubject/subject, sdtc:deceasedInd and sdtc:deceasedTime in subject, sdtc:birthTime in associatedPerson and sdtc:dischargeDispositionCode in encounter; a good summary of CDA R2 stdc extensions can be found at http://motorcycleguy.blogspot.de/2012/06/extending-cda-for-qrda.html, the list of all CDA R2 extensions is summarized at http://wiki.hl7.org/index.php?title=CDA_R2_Extensions
Technical corrections based on issues signalled by IHE
  • In template "2.16.840.1.113883.10.20.22.4.18" (MedicationDispense) the assert the checks US addresses was checking an incorrect path
  • Added datatype CS to every relevant element in all templates (realmCode, languageCode, statusCode). This causes derived schematron rules to only consider attribute @code
Scripted updated to add template element and attribute ids.
Minor fixes:
  • Set PolicyActivity Template 2.16.840.1.113883.10.20.22.4.61 to open (closed would never work due to incomplete definitions)
  • Fixed a typo in Xpath expression in a schematron assert
Minor fixes:
  • Add missing building block repository reference ad2bbr-, and added value set reference that caused value set ResponsibleParty to be unresolvable.
  • Add missing value set Medication Product Form (2.16.840.1.113883.3.88.12.3221.8.11)
  • Replaced context path cda:ClinicalDocument with // to indicate that the document might be wrapped by something else. The cda:ClinicalDocument path was actually causing a duplicate path indicator as the root element was also ClinicalDocument.
Initial release, direct transcript from XML extract from Trifolia database Transformation updated, more trifolia rules taken over Corrections due to DECOR Conversion of final C-CDA release 1.1 as of 31-01-2013
CDA creator Consolidated CDA Consolidated CDA 1.1 document group Continuity of Care Document (CCD) (Release 1.1) Consultation Notes (Release 1.1) Discharge Summary (Release 1.1) Progress Note (Release 1.1) Procedure Note (US Realm – Release 1) Operative Note (Release 1.1) History and Physical (H and P) (Release 1.1) Imaging Integration, and DICOM Diagnostic Imaging Reports (DIR) (US Realm - Release 1) Unstructured Documents (Release 1.1) Consolidated CDA 2.1 document group Care Plan (V2) Consultation Note (V3) Continuity of Care Document (CCD) (V3) Diagnostic Imaging Report (V3) Discharge Summary (V3) History and Physical (V3) Operative Note (V3) Procedure Note (V3) Progress Note (V3) Referral Note (V2) Transfer Summary (V2) Unstructured Document (V3) US Realm Header (V3) US Realm Header for Patient Generated Document (V2) SNOMED CT ActPriority ActStatus LOINC orderableDrugForm AdministrativeGender UCUM Country RoleCode CDC Vaccine Code (CVX) DCM CPT4 EntityNameUse EntityNamePartQualifier Race & Ethnicity - CDC HL7ActClass Insurance Type Code Healthcare Provider Taxonomy (HIPAA) HL7 HealthcareServiceLocation ConfidentialityCode RoleClass ActMood Language LanguageAbilityMode LanguageAbilityProficiency MaritalStatus Unique Ingredient Identifier (UNII) RxNorm FDA RouteOfAdministration ActReason AddressUse USPostalCodes Provider Role (HL7) HL7ActRelationshipType ReligiousAffiliation Source of Payment Typology (PHDSC) FIPS 5-2 (State) Observation Value Health Care Provider Taxonomy Observation Interpretation Participation Function Media Type ParticipationType Act Code Participation Signature National Center for Health Statistics HL7 version 2.x Discharge disposition used in chapter(s) 3; HL7 table 0112 DICOM UID All prescribable medication formulations represented using either a "generic" or "brand-specific" concept. This includes RxNorm codes whose Term Type is SCD (semantic clinical drug), SBD (semantic brand drug), GPCK (generic pack), BPCK (brand pack), SCDG (semantic clinical drug group), SBDG (semantic brand drug group), SCDF (semantic clinical drug form), or SBDF (semantic brand drug form). Value set intensionally defined as a GROUPING made up of: Value Set: Medication Clinical General Drug (2.16.840.1.113883.3.88.12.80.17) (RxNorm Generic Drugs); Value Set: Medication Clinical Brand-specific Drug (2.16.840.1.113762.1.4.1010.5) (RxNorm Branded Drugs).

Valueset Source: https://vsac.nlm.nih.gov/

Unique Ingredient Identifier - Complete Set (UNII codes) Value Set: Medication Clinical General Drug (RxNorm Brand-specific Drugs) List of detailed ethnicity codes reported on a limited basis Value Set Source: http://phinvads.cdc.gov/vads/ViewValueSet.action?id=34D34BBC-617F- DD11-B38D-00188B398520#
Code Code System Code System OID Print Name
2138-6 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Andalusian
2166-7 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Argentinean
2139-4 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Asturian
2142-8 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Belearic Islander
2167-5 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Bolivian
2163-4 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Canal Zone
2145-1 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Canarian
2140-2 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Castillian
2141-0 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Catalonian
2155-0 Race & Ethnicity - CDC 2.16.840.1.113883.6.238 Central American
...
All substances that may need to be represented in the context of health care related activities. This value set is quite broad in coverage and includes concepts that may never be needed in a health care activity event, particularly the included SNOMED CT concepts. The code system-specific value sets in this grouping value set are intended to provide broad coverage of all kinds of agents, but the expectation for use is that the chosen concept identifier for a substance should be appropriately specific and drawn from the appropriate code system as noted: prescribable medications should use RXNORM concepts, more specific drugs and chemicals should be represented using UNII concepts, and any substances not found in either of those two code systems, should use the appropriate SNOMED CT concept. This overarching grouping value set is intended to support identification of prescribable medications, foods, general substances and environmental entities.
Value set intensionally defined as a GROUPING made up of: Value Set: Medication Clinical Drug (2.16.840.1.113762.1.4.1010.4) (RxNorm generic and brand codes); Value Set: Unique Ingredient Identifier - Complete Set (2.16.840.1.113883.3.88.12.80.20) (UNII codes); Value Set: Substance Other Than Clinical Drug (2.16.840.1.113762.1.4.1010.9) (SNOMED CT codes).

Valueset Source: https://vsac.nlm.nih.gov/

Codes that are similar to a drug "form" but limited to those used as units when describing drug administration when the drug item is a physical form that is continuous and therefore not administered as an "each" of the physical form, or is not using standard measurement units (inch, ounce, gram, etc.) This set does not include unit concepts that mimic "physical form" concepts that can be counted using "each", such as tablet, bar, lozenge, packet, etc
Value Set Source: https://vsac.nlm.nih.gov/
Code Code System Code System OID Print Name
C122629 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Actuation Dosing Unit
C25397 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Application Unit
C102405 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Capful Dosing Unit
C122631 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Dropperful Dosing Unit
C48501 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Inhalation Dosing Unit
C48491 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Metric Drop
C71204 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Nebule Dosing Unit
C65060 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Puff Dosing Unit
C48536 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Scoopful Dosing Unit
C48537 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Spray Dosing Unit
C44278 FDA RouteOfAdministration urn:oid:2.16.840.1.11388 3.3.26.1.1 Unit
...
A value set of the file formats supported by the Unstructured Document IG.
Value Set Source: http://www.hl7.org
The Provider type vocabulary classifies providers according to the type of license or accreditation they hold or the service they provide. Value Set Source: http://www.nucc.org/index.php?option=com_content&view=article&id=14&Itemid=125
Code Code System Code System OID Print Name
CP Provider Role (HL7) urn:oid:2.16.840.1.11388 3.3.88.12.3221.4 Consulting Provider
PP Provider Role (HL7) urn:oid:2.16.840.1.11388 3.3.88.12.3221.4 Primary Care Provider
RP Provider Role (HL7) urn:oid:2.16.840.1.11388 3.3.88.12.3221.4 Referring Provider
National Uniform Billing Committee (NUBC) code system.
Value Set Source: http://www.nubc.org
Code Code System Code System OID Print Name
01 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Discharged to Home or Self Care (Routine Discharge)
01 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Discharged/transferred to a Short-Term General Hospital for Inpatient Care
03 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Discharged/transferred to Skilled Nursing Facility (SNF) with Medicare Certification in Anticipation of Skilled Care
04 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Discharged/transferred to a Facility that Provides Custodial or Supportive Care
05 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Discharged/transferred to a Designated Cancer Center or Children’s Hospital
05 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Discharged/transferred to Home Under Care of an Organized Home Health Service Organization in Anticipation of Covered Skilled Care
06 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Discharged/transferred to Home Under Care of an Organized Home Health Service Organization in Anticipation of Covered Skilled Care
07 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Left Against Medical Advice or Discontinued Care
08 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Reserved for Assignment by the NUBC
09 nubc-UB-04-Manual-code set urn:oid:2.16.840.1.11388 3.6.301 Admitted as an Inpatient to this Hospital
...
Value Set: CVX Vaccines Administered - Vaccine Set 2.16.840.1.113762.1.4.1010.6 CVX vaccine concepts that represent actual vaccines types. This does not include the identifiers for CVX codes that do not represent vaccines.
Value set intensionally defined from CVX (OID: 2.16.840.1.113883.12.292)
FilterOnProperty(nonvaccine,FALSE).

Valueset Source: https://vsac.nlm.nih.gov/

Substance Other Than Clinical Drug (SNOMED CT codes).

This is the physical form of the product as presented to the individual. For example: tablet, capsule, liquidor ointment. http://www.fda.gov/ForIndustry/DataStandards/StructuredProductLabeling/ucm162038.htm.

Examples:

Code Code System Print Name
C42887 NCI Thesaurus AEROSOL
C42909 NCI Thesaurus GRANULE, EFFERVESCENT
C42998 NCI Thesaurus TABLET
...
description:

The role played by a party who has legal responsibility for another party.

This value set contains extensionally identified RxNorm vaccine codes. It should be used to supplement the Vaccine Clinical Drug Value Set (Value Set OID 2.16.840.1.113762.1.4.1010.8). Intensional rules for the latter value set are being refined, but at this time lack complete sensitivity, and as a result can miss including relevant codes. This Specific Vaccine Clinical Drug Value Set is used to manually provide for these other RxNorm codes.
(At the time of Consolidated CDA R2 publication, the value set has no members)
Value Set Source: https://vsac.nlm.nih.gov/
Code Code System Code System OID Print Name
NA RxNorm urn:oid:2.16.840.1.11388 3.6.88 At the time of Consolidated CDA R2 publication, the value set has no members
...
Value Set Source: https://vsac.nlm.nih.gov/
Code Code System Code System OID Print Name
1002-5 Race & Ethnicity - CDC urn:oid:2.16.840.1.11388 3.6.238 American Indian or Alaska Native
2028-9 Race & Ethnicity - CDC urn:oid:2.16.840.1.11388 3.6.238 Asian
2054-5 Race & Ethnicity - CDC urn:oid:2.16.840.1.11388 3.6.238 Black or African American
2076-8 Race & Ethnicity - CDC urn:oid:2.16.840.1.11388 3.6.238 Native Hawaiian or Other Pacific Islander
2106-3 Race & Ethnicity - CDC urn:oid:2.16.840.1.11388 3.6.238 White
Medication Clinical General Drug (RxNorm Generic Drugs)