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

Draft as of 2024-12-19

Definitions for the BrandNameObservation 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())
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:brand-name-obs
    Slice Namebrand-name-obs
    Control1..1
    6. Observation.templateId:brand-name-obs.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.301
    8. Observation.templateId:brand-name-obs.extension
    Control1..?
    Pattern Value2019-06-21
    10. Observation.code
    ShortCode for "Device Brand Name"
    Comments

    SHALL contain exactly one [1..1] code (CONF:4437-3404).

    12. Observation.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="C71898" Brand Name (CodeSystem: NCI Thesaurus (NCIt) urn:oid:2.16.840.1.113883.3.26.1.1 STATIC) (CONF:4437-3407).

    Control1..?
    Pattern ValueC71898
    14. Observation.code.codeSystem
    Comments

    This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.3.26.1.1" (CONF:4437-3408).

    Control1..?
    Pattern Value2.16.840.1.113883.3.26.1.1
    16. Observation.code.codeSystemName
    ShortMAY be set to 'NCI Thesaurus'
    Comments

    This code MAY contain zero or one [0..1] @codeSystemName="NCI Thesaurus" (CONF:4437-3409).

    18. Observation.code.displayName
    ShortMAY be set to 'Brand Name'
    Comments

    This code MAY contain zero or one [0..1] @displayName="Brand Name" (CONF:4437-3410).

    20. Observation.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    22. 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('#'))
    24. Observation.value
    Comments

    SHALL contain exactly one [1..1] value with @xsi:type="ED" (CONF:4437-3411).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED, 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/TS, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, 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