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: SmokingStatusMeaningfulUse - Detailed Descriptions

Retired as of 2024-12-19

Definitions for the SmokingStatusMeaningfulUse 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:smoking-status
    Slice Namesmoking-status
    Control1..1
    6. Observation.templateId:smoking-status.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.78
    8. Observation.templateId:smoking-status.extension
    Control1..?
    Pattern Value2024-05-01
    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-14806).

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

    Fixed ValueEVN
    14. Observation.id
    Comments

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

    Control1..?
    16. Observation.code
    Comments

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

    18. Observation.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="72166-2" Tobacco smoking status NHIS (CONF:1098-31039).

    Control1..?
    Pattern Value72166-2
    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-32157).

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

    Control1..?
    28. Observation.statusCode.nullFlavor
    Control0..0
    30. Observation.statusCode.code
    Control1..?
    BindingThe codes SHALL be taken from Completed or Nullified Act Status .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.6)
    32. Observation.effectiveTime
    ShortThis template represents a "snapshot in time" observation, simply reflecting what the patient's current smoking status is at the time of the observation. As a result, the effectiveTime is constrained to just a time stamp, and will approximately correspond with the author/time.
    Comments

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

    Control1..?
    Invariantsvalue-only: Interval fields SHALL NOT be present ((low | high | width | center).empty())
    34. Observation.effectiveTime.value
    Shortvalue should be used instead of low/high
    36. Observation.value
    Short𝗨𝗦𝗖𝗗𝗜: Smoking Status: If the patient's current smoking status is unknown, @code **SHALL** contain '266927001' (Unknown if ever smoked) from ValueSet Current Smoking Status (2.16.840.1.113883.11.20.9.38 STATIC 2014-09-01) (CONF:1098-31019).
    Comments

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

    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.code
    Comments

    This value SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Smoking Status urn:oid:2.16.840.1.113883.11.20.9.38 DYNAMIC (CONF:1098-14817).

    BindingThe codes SHOULD be taken from Smoking Status .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.38)
    40. 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-31148).

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