R2.1 Errata
TemplateIdSummary descriptionErrata Release DatePrior textAfter UpdateSearchable CONF #
710Substance or Device Allergy - Intolerance Observation (V2) [observation: identifier urn:hl7ii:2.16.840.1.113883.10.20.24.3.90:2014-06-09 (open)]Add Criticality template to Substance or Device Allergy3/1/2016This template: Substance or Device Allergy - Intolerance Observation (V2) [observation: identifier urn:hl7ii:2.16.840.1.113883.10.20.24.3.90:2014-06-09 (open)] did not get updated to absorb the structural changes adopted for the use of the Criticality Observation and the SHOULD NOT for the Severity Observation templateUpdate the Substance or Device Allergy - Intolerance Observation (V2) with the following: 13. SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-9961) such that it a. SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-9962). b. SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-9964). c. SHALL contain exactly one [1..1] Severity Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-15956). 14. SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32910) such that it a. SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32911). b. SHALL contain zero or one [0..1] @inversionInd="true" True (CONF:1098-32912). c. SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32913).9961
737US Realm Header (V3) [ClinicalDocument: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.1.1:2015-08-01 (open)]Add guidance to country code value set3/1/2016Value Set: Country urn:oid:2.16.840.1.113883.3.88.12.80.63 This identifies the codes for the representation of names of countries, territories and areas of geographical interest. Value Set Source: http://www.iso.org/iso/country_codes/iso_3166_code_lists.htmAdd clarification to C-CDA (R1.1/R2.0/R2.1) that the 2 character codes for country code value set 2.16.840.1.113883.3.88.12.80.63 will be used. 5404
747US Realm Header (V3) [ClinicalDocument: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.1.1:2015-08-01 (open)]Value set OID incorrectly listed as code system in country value set.3/1/2016This addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:1198-5404).Update the code system in the Country (2.16.840.1.113883.3.88.12.80.63) value set table. Currently it lists the value set OID in the code system OID column.5404
757US Realm Header (V3) [ClinicalDocument: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.1.1:2015-08-01 (open)]Including R1.1 templateId in compatible C-CDA R2.1 instances3/1/2016C-CDA 2.1 has the following conformance statement: 1. SHALL contain exactly one [1..1] templateId (CONF:1198-5252) such that it a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:1198-10036). b. SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32503). c. When asserting this templateId, all document, section, and entry templates SHALL include a templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32936).Remove 32963. see comment http://www.hl7.org/dstucomments/showdetail_comment.cfm?commentid=78132936
781All 13 document headersRequire C-CDA R1.1 Template IDs3/1/2016See DSTU comment 757.VOLUME 1 Assertion of Compatibility Volume 2 of this guide includes a requirement that all C-CDA R2.1 conformant instances: • Include a C-CDA R2.1 templateId, • Additionally, when the C-CDA R2.1 templateId includes an extension, the C-CDA R1.1 templateId must also be included. By including both templateIds the sending application is asserting conformance with C-CDA R2.1 and C-CDA R1.1. This requirement (CONF:32936) is included in each document template defined in C-CDA R2.1 (example is for the Discharge Summary (V3) document template: SHALL contain exactly one [1..1] templateId (CONF:1198-5252) such that it a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.8" (CONF:1198-10036). b. SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32503). c. When asserting conformance with a document template defined in C-CDA R2.1, document-, section-, and entry-level templates SHALL include the templateId of the corresponding template defined in C-CDA R1.1 to assert compatibility with that release of C-CDA. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32936). --- VOLUME 2 Add a bullet 'c' to all 13 document templates: SHALL contain exactly one [1..1] templateId (CONF:1198-XXX) such that it a. SHALL contain exactly one [1..1] @root="<document template root>" (CONF:1198-10036). b. SHALL contain exactly one [1..1] @extension="<document template extension>" (CONF:1198-32503). c. When asserting conformance with a document template defined in C-CDA R2.1, document-, section-, and entry-level templates SHALL include the templateId of the corresponding template defined in C-CDA R1.1 to assert compatibility with that release of C-CDA. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-XX).
790Volume 1 - Appendix AIncorrect definition of acronym3/1/2016Standard Duty Title Code Structure Document Technical Committee
792Family History Organizer (V3) [organizer: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.4.45:2015-08-01 (open)] 3.107 Tobacco Use (V2) [observation: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.4.85:2014-06-09 (open)] Allow use of nullFlavor3/1/2016The following conformance statements preclude the ability to send a nullFlavor in communicating unmappable or unavailable codes. These look like errors. Family History Organizer 6. SHALL contain exactly one [1..1] subject (CONF:1198-8609). ... 1. The subject, if present, SHALL contain exactly one [1..1] administrativeGenderCode (CONF:1198-15974). a. This administrativeGenderCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-15975). Tobacco Use 8. SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF:1098-16562). a. This value SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Tobacco Use urn:oid:2.16.840.1.113883.11.20.9.41 DYNAMIC (CONF:1098-16563).Update binding to code rather than @code since the editors didn't intent to preclude nullFlavor. Need to fix in 1.1 also.15975, 16563
806US Realm Header (V3) [ClinicalDocument: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.1.1:2015-08-01 (open)]Language value set3/1/2016which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (ClinicalDocument/languageCode and also patient/languageCommunication/languageCode) A value set of codes defined by Internet RFC 4646 (replacing RFC 3066). Please see ISO 639 language code set maintained by Library of Congress for enumeration of language codes. Value Set Source: http://www.loc.gov/standards/iso639-2/php/code_list.php Table Examples: aa Language urn:oid:2.16.840.1.113883.6.121 Afar ab Language urn:oid:2.16.840.1.113883.6.121 Abkhazian ace Language urn:oid:2.16.840.1.113883.6.121 Achinese From the loc.gov site: Note: ISO 639-2 is the alpha-3 code in Codes for the representation of names of languages-- Part 2. There are 21 languages that have alternative codes for bibliographic or terminology purposes. In those cases, each is listed separately and they are designated as "B" (bibliographic) or "T" (terminology). In all other cases there is only one ISO 639-2 code. Multiple codes assigned to the same language are to be considered synonyms. ISO 639-1 is the alpha-2 code.For C-CDA R2.1, SDWG will bind the DYNAMIC value set to RFC 5646: -use 2 character code if one exists -use 3 character code if a 2 character code does not exist. -country extensions are allowed (ISO 3166-1). See http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry Search for value set: 2.16.840.1.113883.1.11.11526
808US Realm Header (V3) [ClinicalDocument: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.1.1:2015-08-01 (open)]Incorrect binding change of patient name.3/1/2016iv. This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-5283). 1. This patient SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5284).iv. This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-). 1. This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:1198-).5283
812US Realm Address (AD.US.FIELDED) [addr: identifier urn:oid:2.16.840.1.113883.10.20.22.5.2 (open)]Postal code is restricted to US3/1/20162. This addr MAY contain zero or one [0..1] postalCode, which SHALL be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:1198-5403).Add text similar to CONF 81-10025 that states 'if country is US'5403
813SeveralBackwards compatability with prior C-CDA versions requires a root template without an extension3/1/2016Many templateId conformance statements do not explicitly state that the 'such that it' does not require the absence of a @extension element. Statements like this: 1. SHALL contain exactly one [1..1] templateId (CONF:81-7711) such that it a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.2.8" (CONF:81-10382).Add an additional conformance to all templates without an extension: b. SHALL not contain [0..0] @extension. Several
814Care Plan (V2) [ClinicalDocument: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.1.15:2015-08-01 (open)] Transfer Summary (V2) [ClinicalDocument: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.1.13:2015-08-01 (open)] Patient Referral Act [act: identifier urn:oid:2.16.840.1.113883.10.20.22.4.140 (open)] Vital Sign Observation (V2) [observation: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.4.27:2014-06-09 (open)] Wound Measurement Observation [observation: identifier urn:oid:2.16.840.1.113883.10.20.22.4.133 (open)] 4.4 US Realm Address (AD.US.FIELDED) [addr: identifier urn:oid:2.16.840.1.113883.10.20.22.5.2 (open)]Missing conformance binding to value set3/1/20161. The code, if present, SHALL contain exactly one [1..1] @code (ValueSet: Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1) (CONF:1198-32367). i. This associatedEntity SHALL contain exactly one [1..1] @classCode (ValueSet: INDRoleclassCodes urn:oid:2.16.840.1.113883.11.20.9.33 DYNAMIC) (CONF:1198-31873). i. This section SHALL contain exactly one [1..1] code (ValueSet: Physical Exam Type urn:oid:2.16.840.1.113883.11.20.9.65 STATIC) (CONF:1198-32436). v. This observation SHOULD contain zero or one [0..1] priorityCode (ValueSet: Act Priority urn:oid:2.16.840.1.113883.1.11.16866 DYNAMIC) (CONF:1098-32443). a. The interpretationCode, if present, SHALL contain exactly one [1..1] @code (ValueSet: Observation Interpretation (HL7) urn:oid:2.16.840.1.113883.1.11.78 STATIC 2014-09-01) (CONF:1098-32886). 5. SHALL contain exactly one [1..1] code (ValueSet: Wound Measurements urn:oid:2.16.840.1.113883.1.11.20.2.5 DYNAMIC) (CONF:1098-29931). 3. SHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).Exclusion of nullFlavor was unintentional. Remove binding to the @code, update to bind at code. 1. Update 32367 to SHOULD value set binding 2. Update 31873 to SHALL @classCode SHALL INDRoleclassCodes 3. No decision on 32436. Benjamin to add new 4. Update 32443 to SHOULD value set binding 5. Update 32866 to SHALL value set binding 6. Update 29931 to SHALL value set binding 7. Merge 7293 with existing primiative 10024 and state if US, then SHALL value set binding 32367, 31873, 32443, 32886, 29931, 7293
818US Realm Address (AD.US.FIELDED) [addr: identifier urn:oid:2.16.840.1.113883.10.20.22.5.2 (open)] Clarification on state requirement for US addresses.3/1/2016In US Realm Address: a. State is required if the country is US. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). a. PostalCode is required if the country is US. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).Add clarification that, if the country is US, the state element is required but SHOULD have @nullFlavor if the state is unknown. if the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. 10024, 10025
819US Realm Address (AD.US.FIELDED) [addr: identifier urn:oid:2.16.840.1.113883.10.20.22.5.2 (open)]US Realm Address restricts address to 1 line3/1/2016US Realm Address 6. SHALL contain exactly one [1..1] streetAddressLine (CONF:81-7291).Update to R1.1 requirement of 1..47291
820Discharge Medications Section (entries optional) (V3) [section: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.2.11:2015-08-01 (open)] Discharge Medications Section (entries required) (V3) [section: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.2.11.1:2015-08-01 (open)] Discharge Medication (V2) [act: identifier urn:hl7ii:2.16.840.1.113883.10.20.22.4.35:2014-06-09 (open)] Update Discharge Medication to support compatability with C-CDA R1.13/1/2016Discharge Medication (V2) ... 1. SHALL contain exactly one [1..1] templateId (CONF:1098-16760) such that it a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.35" (CONF:1098-16761). b. SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32513). 2. SHALL contain exactly one [1..1] code (CONF:1098-7691). a. This code SHALL contain exactly one [1..1] @code="75311-1" Discharge medication (CONF:1098-19161). b. This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1098-32159).Update Discharge Medication Sections: SHOULD contain zero or more [0..*] entry (CONF:1198-7820) such that it --SHALL contain exactly one [1..1] Discharge Medication (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.35:2016-03-01) (CONF:1198-15490). SHALL contain at least one [1..*] entry (CONF:1198-7826) such that it --SHALL contain exactly one [1..1] Discharge Medication (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.35:2016-03-01) (CONF:1198-15491). Create Discharge Medication Entry (V3) to use 10183-2 in the code and 75311-1 in the translation. Use the errata date of 2016-03-01 in the extension.7820, 7826
825Value set: 2.16.840.1.113883.3.88.12.80.32Invalid codes in Encounter Type Code Value Set3/1/2016Value Set: EncounterTypeCode urn:oid:2.16.840.1.113883.3.88.12.80.32 This value set includes only the codes of the Current Procedure and Terminology designated for Evaluation and Management (99200 – 99607) (subscription to AMA Required Value Set Source: http://www.amacodingonline.com/ ...and then table contains SNOMED CT entries...Remove invalid SNOMED codesSearch for value set: 2.16.840.1.113883.3.88.12.80.32
842Table 1, Volume 2Missing required section in table 1 for Consultation Note3/1/2016Table 1 in volume 2 shows the Allergies and Intolerances section to be optional in the Consultation Note document, but the conformance constraints say it is required. i. This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28910) such that it 1. SHALL contain exactly one [1..1] Allergies and Intolerances Section (entries required) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.6.1:2015-08-01) (CONF:1198-28911).Table 1 will include Allergies and Intolerance Section (entries required) in the required column for the Consultation Note.28911