Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: TobaccoUse - Detailed Descriptions

Retired as of 2024-12-19

Definitions for the TobaccoUse logical model.

Guidance on how to interpret the contents of this table can be found here

0. Observation
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-author: SHOULD contain author (author.exists())
2. Observation.templateId
Control1..?
SlicingThis element introduces a set of slices on Observation.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Observation.templateId:tobacco-use
    Slice Nametobacco-use
    Control1..1
    6. Observation.templateId:tobacco-use.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.85
    8. Observation.templateId:tobacco-use.extension
    Control1..?
    Pattern Value2014-06-09
    10. Observation.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16558).

    Fixed ValueOBS
    12. Observation.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-16559).

    Fixed ValueEVN
    14. Observation.id
    Comments

    SHALL contain at least one [1..*] id (CONF:1098-32400).

    Control1..?
    16. Observation.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:1098-19174).

    18. Observation.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="11367-0" History of tobacco use (CONF:1098-19175).

    Control1..?
    Pattern Value11367-0
    20. Observation.code.codeSystem
    Comments

    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-32172).

    Control1..?
    Pattern Value2.16.840.1.113883.6.1
    22. Observation.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    24. Observation.text.reference
    Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
    26. Observation.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:1098-16561).

    Control1..?
    28. Observation.statusCode.code
    Comments

    This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19118).

    Control1..?
    Fixed Valuecompleted
    30. Observation.effectiveTime
    ShortThe effectiveTime represents the biologically relevant time of the observation. A "former smoker" is recorded with the proper code "current smoker" with an effectiveTime/low and effectiveTime/high defining the time during which the patient was a smoker.
    Comments

    SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16564).

    Control1..?
    32. Observation.effectiveTime.low
    Comments

    This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-16565).

    Control1..?
    34. Observation.effectiveTime.high
    Comments

    This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31431).

    36. Observation.value
    Comments

    SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF-1098-16562).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/SC
    38. Observation.value.nullFlavor
    Control0..0
    40. Observation.value.code
    Control1..?
    BindingThe codes SHALL be taken from Tobacco Use .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.41)
    42. Observation.author
    Comments

    SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31152).

    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)