HdBe-SmokingStatus

ProfileStatusURL
HdBe-SmokingStatusdrafthttps://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-SmokingStatus

smoking_status1..1CodeableConceptBinding
type_of_smoking_or_tobacco0..1CodeableConceptBinding
start_date0..1dateTime
stop_date0..1dateTime
frequency0..1CodeableConceptBinding
amount0..1Quantity
pack_years0..1Count
comment0..1string

smoking_status0..*
smoking_status.smoking_statusCodeableConcept1..1
smoking_status.type_of_smoking_or_tobaccoCodeableConcept0..1
smoking_status.observation_of_useBackboneElement0..1
smoking_status.observation_of_use.start_datedateTime0..1
smoking_status.observation_of_use.stop_datedateTime0..1
smoking_status.observation_of_use.frequencyCodeableConcept0..1
smoking_status.observation_of_use.amountQuantity0..1
smoking_status.observation_of_use.pack_yearsCount0..1
smoking_status.commentstring0..1



smoking_status
DefinitionRoot concept of the SmokingStatus information model. This concept contains all data elements of the SmokingStatus information model.
Cardinality0...*
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
smoking_status.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
smoking_status.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-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()
Mappings
  • rim:n/a
  • rim:N/A
smoking_status.smoking_status
DefinitionThe patient’s smoking status or usage of (smokeless) tobacco.
Cardinality1...1
TypeCodeableConcept
Binding

SmokingStatus codes

SmokingStatus (extensible)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
smoking_status.type_of_smoking_or_tobacco
DefinitionThe patient's type of smoking or tobacco use.
Cardinality0...1
TypeCodeableConcept
Binding

TypeOfSmokingOrTobacco codes

TypeOfSmokingOrTobacco (extensible)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
smoking_status.observation_of_use
DefinitionThis container contains all information on the extent to which the patient is or was exposed to tobacco.
Cardinality0...1
TypeBackboneElement
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
smoking_status.observation_of_use.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
smoking_status.observation_of_use.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-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()
Mappings
  • rim:n/a
  • rim:N/A
smoking_status.observation_of_use.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-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()
Mappings
  • rim:n/a
  • rim:N/A
smoking_status.observation_of_use.start_date
DefinitionThe date on which the patient started smoking.
Cardinality0...1
TypedateTime
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
smoking_status.observation_of_use.stop_date
DefinitionThe date on which the patient quit smoking
Cardinality0...1
TypedateTime
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
smoking_status.observation_of_use.frequency
DefinitionThe frequency of smoking or tobacco use.
Cardinality0...1
TypeCodeableConcept
Binding

Frequency qualifier values

https://fhir.healthdata.be/ValueSet/Frequency (extensible)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
smoking_status.observation_of_use.amount
DefinitionThe number of cigarettes, cigars or grams of rolling tobacco consumed per day, week, month or year.
Cardinality0...1
TypeQuantity
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3:If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
Mappings
  • rim:n/a
  • v2:SN (see also Range) or CQ
  • rim:PQ, IVL<PQ>, MO, CO, depending on the values
smoking_status.observation_of_use.pack_years
DefinitionThe unit indicating the smoker’s total exposure to tobacco smoke. For cigarettes, this is calculated using the number of smoked packs of cigarettes per day (one pack = 20 cigarettes) times the number of years of smoking. For other forms of tobacco, this is usually converted to an equivalent cigarette consumption. Often, only the number of pack years is estimated.
Cardinality0...1
TypeCount
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3:If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • cnt-3:There SHALL be a code with a value of "1" if there is a value. If system is present, it SHALL be UCUM. If present, the value SHALL be a whole number.
    (code.exists() or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.hasValue().not() or value.toString().contains('.').not())
Mappings
  • rim:n/a
  • v2:SN (see also Range) or CQ
  • rim:PQ, IVL<PQ>, MO, CO, depending on the values
smoking_status.comment
DefinitionRelevant comments on the patient’s use of tobacco.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a

Example instances

smoking_status
smoking_status 722499006 - Electronic cigarette user (SNOMED CT)
type_of_smoking_or_tobacco 785889008 - Nicotine-filled electronic cigarette user (SNOMED CT)
observation_of_use.start_date 1985
observation_of_use.stop_date
observation_of_use.frequency 69620002 - Daily (SNOMED CT)
observation_of_use.amount 16mg Nicotine per day
observation_of_use.pack_years
comment Tries to quit. Partner also smokes.

zib TobaccoUse-v3.2 difference

Concept Category Description
description textual Widend the scope of the CBB to smoking status to include the use of e-Sigarate smoking.
smoking_status element Renamed element from TobaccoUseStatus to SmokingStatus.
smoking_status terminology Added codes to define electronic cigarette users. Removed codes that contained frequency information because this is replaced by the observation_of_use.frequencyelement. Added Unkown and Other qualifier codes.
type_of_smoking_or_tobacco element Renamed element from TypeOfTobaccoUsed to accomodate e-sigarettes.
type_of_smoking_or_tobacco terminology Added type of e-cigarette codes and Unkown and Other qualifier codes.
observation_of_use.frequency element Added element to capture the frequency of the smoking or tobacco use. This may have some overlap with amount.



Terminology Bindings

PathNameStrengthURL
smoking_statusSmokingStatusextensiblehttps://fhir.healthdata.be/ValueSet/SmokingStatus
type_of_smoking_or_tobaccoTypeOfSmokingOrTobaccoextensiblehttps://fhir.healthdata.be/ValueSet/TypeOfSmokingOrTobacco
observation_of_use.frequencyFrequencyextensiblehttps://fhir.healthdata.be/ValueSet/Frequency