HealthSense Implementation Guide (Taltech)
0.1.0 - ci-build

HealthSense Implementation Guide (Taltech), published by Taltech. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/e-medlab/healthsense/ and changes regularly. See the Directory of published versions

Logical Model: TobaccoUseModel - Detailed Descriptions

Draft as of 2025-12-30

Definitions for the tobacco-use-model logical model.

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

0. tobacco-use-model
Definition

TobaccoUseModel


Base definition for all elements in a resource.

ShortTobaccoUseModelBase for all elements
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. tobacco-use-model.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
4. tobacco-use-model.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 tobacco-use-model.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. tobacco-use-model.patient
    Definition

    Subject of procedure.

    ShortPatient
    Control1..1
    TypeReference(Patient)
    8. tobacco-use-model.effectiveTime
    Definition

    When the observation was measured.

    ShortEffective time
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. tobacco-use-model.value
    Definition

    The actual coded result of observation.

    ShortThe actual coded result of observation.
    Control1..1
    BindingThe codes SHALL be taken from https://ig.kodality.dev/healthsense/ValueSet-hs-tobacco-user.json
    (required to https://ig.kodality.dev/healthsense/ValueSet-hs-tobacco-user.json)
    TypeCoding
    12. tobacco-use-model.note
    Definition

    Comments about the observation or the results.

    ShortComments about the observation
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

    0. tobacco-use-model
    Definition

    TobaccoUseModel

    ShortTobaccoUseModel
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. tobacco-use-model.patient
    Definition

    Subject of procedure.

    ShortPatient
    Control1..1
    TypeReference(Patient)
    4. tobacco-use-model.effectiveTime
    Definition

    When the observation was measured.

    ShortEffective time
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. tobacco-use-model.value
    Definition

    The actual coded result of observation.

    ShortThe actual coded result of observation.
    Control1..1
    BindingThe codes SHALL be taken from https://ig.kodality.dev/healthsense/ValueSet-hs-tobacco-user.json
    (required to https://ig.kodality.dev/healthsense/ValueSet-hs-tobacco-user.json)
    TypeCoding
    8. tobacco-use-model.note
    Definition

    Comments about the observation or the results.

    ShortComments about the observation
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

    0. tobacco-use-model
    Definition

    TobaccoUseModel

    ShortTobaccoUseModel
    Control0..*
    This element is affected by the following invariants: ele-1
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    2. tobacco-use-model.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
    4. tobacco-use-model.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 tobacco-use-model.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. tobacco-use-model.patient
      Definition

      Subject of procedure.

      ShortPatient
      Control1..1
      TypeReference(Patient)
      8. tobacco-use-model.effectiveTime
      Definition

      When the observation was measured.

      ShortEffective time
      Control1..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. tobacco-use-model.value
      Definition

      The actual coded result of observation.

      ShortThe actual coded result of observation.
      Control1..1
      BindingThe codes SHALL be taken from https://ig.kodality.dev/healthsense/ValueSet-hs-tobacco-user.json
      (required to https://ig.kodality.dev/healthsense/ValueSet-hs-tobacco-user.json)
      TypeCoding
      12. tobacco-use-model.note
      Definition

      Comments about the observation or the results.

      ShortComments about the observation
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension