International Patient Summary (IPS)
1.1.0-ballot - CI Build

International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.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-IPS/ and changes regularly. See the Directory of published versions

Logical Model: IPSSocialHistoryObsTobaccoUse - Detailed Descriptions

Draft as of 2017-06-20

Definitions for the 2.16.840.1.113883.10.22.4.34--20170620000000 logical model.

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

0. Observation
Control0..*
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.
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:primary
    Slice Nameprimary
    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    Must Supporttrue
    6. Observation.templateId:primary.root
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Value2.16.840.1.113883.10.22.4.34
    8. Observation.classCode
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueOBS
    10. Observation.moodCode
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueEVN
    12. Observation.id
    Control0..*
    14. Observation.code
    Control1..1
    Must Supporttrue
    16. Observation.code.code
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Value72166-2
    18. Observation.code.codeSystem
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Value2.16.840.1.113883.6.1
    20. Observation.code.translation
    Control0..*
    Must Supporttrue
    22. Observation.statusCode
    Control1..1
    Must Supporttrue
    24. Observation.statusCode.code
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuecompleted
    26. Observation.effectiveTime
    Control1..1
    Must Supporttrue
    28. Observation.value
    Control1..1
    BindingThe codes SHALL be taken from IPS Current Smoking Status
    (required to http://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips)

    IPS Current Smoking Status

    Must Supporttrue
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    30. Observation.value.type
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace http://www.w3.org/2001/XMLSchema-instance.In the XML format, this property has the actual namexsi.
    Fixed ValueCD

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

    0. Observation
    Definition

    Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

    ShortBase for all types and resources
    Control0..*
    Is Modifierfalse
    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.
    2. Observation.templateId
    Definition

    When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    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:primary
      Slice Nameprimary
      Definition

      When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      Must Supporttrue
      6. Observation.templateId:primary.root
      Definition

      A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.10.22.4.34
      8. Observation.classCode
      Control1..1
      BindingThe codes SHALL be taken from CDAActClassObservation
      (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueOBS
      10. Observation.moodCode
      Control1..1
      BindingThe codes SHALL be taken from XActMoodDocumentObservation (2.0.0)
      (required to http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueEVN
      12. Observation.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..*1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIstring
      Is Modifierfalse
      14. Observation.code
      Definition

      Describes what was observed. Sometimes this is called the observation "name".

      ShortType of observation (code / type)
      Comments

      All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

      Control1..1
      BindingFor example codes, see ObservationTypehttp://hl7.org/fhir/ValueSet/observation-codes
      (example to http://terminology.hl7.org/ValueSet/v3-ObservationType)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      Requirements

      Knowing what kind of observation is being made is essential to understanding the observation.

      Alternate NamesName
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Observation.code.code
      Definition

      The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

      Control0..1
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode
      Fixed Value72166-2
      18. Observation.code.codeSystem
      Definition

      Specifies the code system that defines the code.

      Control0..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System
      Fixed Value2.16.840.1.113883.6.1
      20. Observation.code.translation
      Definition

      A set of other concept descriptors that translate this concept descriptor into other code systems.

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
      Must Supporttrue
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      LabelTranslation
      22. Observation.statusCode
      Control1..1
      BindingThe codes SHALL be taken from ActStatus
      (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
      Must Supporttrue
      24. Observation.statusCode.code
      Definition

      The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

      Control0..1
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode
      Fixed Valuecompleted
      26. Observation.statusCode.codeSystem
      Definition

      Specifies the code system that defines the code.

      Control0..0
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System
      28. Observation.statusCode.codeSystemName
      Definition

      The common name of the coding system.

      Control0..0
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System Name
      30. Observation.statusCode.codeSystemVersion
      Definition

      If applicable, a version descriptor defined specifically for the given code system.

      Control0..0
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System Version
      32. Observation.statusCode.displayName
      Definition

      A name or title for the code, under which the sending system shows the code value to its users.

      Control0..0
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplay Name
      34. Observation.statusCode.originalText
      Definition

      The text or phrase used as the basis for the coding.

      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
      LabelOriginal Text
      36. Observation.statusCode.qualifier
      Definition

      Specifies additional codes that increase the specificity of the the primary code.

      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
      LabelQualifier
      38. Observation.statusCode.translation
      Definition

      A set of other concept descriptors that translate this concept descriptor into other code systems.

      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      LabelTranslation
      40. Observation.effectiveTime
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
      Must Supporttrue
      42. Observation.value
      Control1..1
      BindingThe codes SHALL be taken from IPS Current Smoking Status
      (required to http://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips)

      IPS Current Smoking Status

      TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      XML FormatThe type of this property is determined using the xsi:typeattribute.

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

      0. Observation
      Definition

      Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

      ShortBase for all types and resources
      Control0..*
      Is Modifierfalse
      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.
      2. Observation.nullFlavor
      Definition

      If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      4. Observation.realmCode
      Definition

      When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
      6. Observation.typeId
      Definition

      When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      8. Observation.typeId.nullFlavor
      Definition

      If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      10. Observation.typeId.assigningAuthorityName
      Definition

      A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

      Control0..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      12. Observation.typeId.displayable
      Definition

      Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

      Control0..1
      Typeboolean(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      14. Observation.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      16. Observation.typeId.extension
      Definition

      A character string as a unique identifier within the scope of the identifier root.

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      18. Observation.templateId
      Definition

      When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      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
      • 20. Observation.templateId:primary
        Slice Nameprimary
        Definition

        When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        Must Supporttrue
        22. Observation.templateId:primary.nullFlavor
        Definition

        If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        24. Observation.templateId:primary.assigningAuthorityName
        Definition

        A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        26. Observation.templateId:primary.displayable
        Definition

        Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

        Control0..1
        Typeboolean(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        28. Observation.templateId:primary.root
        Definition

        A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.10.22.4.34
        30. Observation.templateId:primary.extension
        Definition

        A character string as a unique identifier within the scope of the identifier root.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        32. Observation.classCode
        Control1..1
        BindingThe codes SHALL be taken from CDAActClassObservation
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation)
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueOBS
        34. Observation.moodCode
        Control1..1
        BindingThe codes SHALL be taken from XActMoodDocumentObservation (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0)
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueEVN
        36. Observation.negationInd
        Control0..1
        Typeboolean(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        38. Observation.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        40. Observation.code
        Control1..1
        BindingFor example codes, see ObservationType
        (example to http://terminology.hl7.org/ValueSet/v3-ObservationType)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        Must Supporttrue
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        42. Observation.code.nullFlavor
        Definition

        If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        44. Observation.code.code
        Definition

        The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

        Control0..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        Fixed Value72166-2
        46. Observation.code.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        Fixed Value2.16.840.1.113883.6.1
        48. Observation.code.codeSystemName
        Definition

        The common name of the coding system.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        50. Observation.code.codeSystemVersion
        Definition

        If applicable, a version descriptor defined specifically for the given code system.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        52. Observation.code.displayName
        Definition

        A name or title for the code, under which the sending system shows the code value to its users.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        54. Observation.code.sdtcValueSet
        Definition

        The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

        Control0..1
        Typestring(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
        56. Observation.code.sdtcValueSetVersion
        Definition

        The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
        58. Observation.code.originalText
        Definition

        The text or phrase used as the basis for the coding.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        60. Observation.code.qualifier
        Definition

        Specifies additional codes that increase the specificity of the the primary code.

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        62. Observation.code.translation
        Definition

        A set of other concept descriptors that translate this concept descriptor into other code systems.

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        Must Supporttrue
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        64. Observation.derivationExpr
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
        66. Observation.text
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        68. Observation.statusCode
        Control1..1
        BindingThe codes SHALL be taken from ActStatus
        (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        Must Supporttrue
        70. Observation.statusCode.nullFlavor
        Definition

        If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        72. Observation.statusCode.code
        Definition

        The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

        Control0..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        Fixed Valuecompleted
        74. Observation.statusCode.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..0
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        76. Observation.statusCode.codeSystemName
        Definition

        The common name of the coding system.

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        78. Observation.statusCode.codeSystemVersion
        Definition

        If applicable, a version descriptor defined specifically for the given code system.

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        80. Observation.statusCode.displayName
        Definition

        A name or title for the code, under which the sending system shows the code value to its users.

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        82. Observation.statusCode.sdtcValueSet
        Definition

        The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

        Control0..1
        Typestring(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
        84. Observation.statusCode.sdtcValueSetVersion
        Definition

        The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
        86. Observation.statusCode.originalText
        Definition

        The text or phrase used as the basis for the coding.

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        88. Observation.statusCode.qualifier
        Definition

        Specifies additional codes that increase the specificity of the the primary code.

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        90. Observation.statusCode.translation
        Definition

        A set of other concept descriptors that translate this concept descriptor into other code systems.

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        92. Observation.effectiveTime
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
        Must Supporttrue
        94. Observation.priorityCode
        Control0..1
        BindingFor example codes, see ActPriority
        (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        96. Observation.repeatNumber
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
        98. Observation.languageCode
        Control0..1
        BindingThe codes SHALL be taken from AllLanguages
        (required to http://hl7.org/fhir/ValueSet/all-languages)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        100. Observation.value
        Control1..1
        BindingThe codes SHALL be taken from IPS Current Smoking Status
        (required to http://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips)

        IPS Current Smoking Status

        TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        102. Observation.value.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        104. Observation.value.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Observation.value.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 106. Observation.interpretationCode
          Control0..*
          BindingThe codes SHALL be taken from CDAObservationInterpretation
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          108. Observation.methodCode
          Control0..*
          BindingFor example codes, see ObservationMethod
          (example to http://terminology.hl7.org/ValueSet/v3-ObservationMethod)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          110. Observation.targetSiteCode
          Definition

          Drawn from concept domain ActSite

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          112. Observation.subject
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
          114. Observation.specimen
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
          116. Observation.performer
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
          118. Observation.author
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
          120. Observation.informant
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
          122. Observation.participant
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
          124. Observation.entryRelationship
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          126. Observation.reference
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
          128. Observation.precondition
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
          130. Observation.sdtcPrecondition2
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
          132. Observation.referenceRange
          Definition

          Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
          134. Observation.referenceRange.nullFlavor
          Definition

          If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          136. Observation.referenceRange.realmCode
          Definition

          When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
          138. Observation.referenceRange.typeId
          Definition

          When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          140. Observation.referenceRange.typeId.nullFlavor
          Definition

          If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          142. Observation.referenceRange.typeId.assigningAuthorityName
          Definition

          A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          144. Observation.referenceRange.typeId.displayable
          Definition

          Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

          Control0..1
          Typeboolean(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          146. Observation.referenceRange.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          148. Observation.referenceRange.typeId.extension
          Definition

          A character string as a unique identifier within the scope of the identifier root.

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          150. Observation.referenceRange.templateId
          Definition

          When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          152. Observation.referenceRange.typeCode
          Control0..1
          BindingThe codes SHALL be taken from CDAActRelationshipType
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueREFV
          154. Observation.referenceRange.observationRange
          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationRange
          156. Observation.sdtcInFulfillmentOf1
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.