BBMRI.de/GBA Implementation Guide
1.2.0 - CI Build
BBMRI.de/GBA Implementation Guide
1.2.0 - CI Build
BBMRI.de/GBA Implementation Guide - Local Development build (v1.2.0). See the Directory of published versions
| Official URL: https://fhir.bbmri.de/StructureDefinition/TobaccoUse | Version: 1.2.0 | |||
| Active as of 2023-09-01 | Computable Name: TobaccoUse | |||
Tobacco use
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | Observation | Measurements and simple assertions | |
  code | ||||
  coding | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
   system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72166-2 | |
| subject | S | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
 effective[x] | S | 0..1 | dateTime | Clinically relevant time/time-period for observation |
 value[x] | S | 0..1 | CodeableConcept | Actual result Binding: IPS Current Smoking Status (required) |
| component | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.value[x] | required | IPSCurrentSmokingStatus |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72166-2 | |
 subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| effective[x] | SΣ | 0..1 | dateTime | Clinically relevant time/time-period for observation |
| value[x] | SΣC | 0..1 | CodeableConcept | Actual result Binding: IPS Current Smoking Status (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | ObservationStatus |
| Observation.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.value[x] | required | IPSCurrentSmokingStatus |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72166-2 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| focus | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | SΣ | 0..1 | dateTime | Clinically relevant time/time-period for observation | ||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | SΣC | 0..1 | CodeableConcept | Actual result Binding: IPS Current Smoking Status (required) | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.subject.type | extensible | ResourceType | ||||
| Observation.value[x] | required | IPSCurrentSmokingStatus | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
This structure is derived from Observation
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | Observation | Measurements and simple assertions | |
| code | ||||
| coding | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72166-2 | |
| subject | S | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| effective[x] | S | 0..1 | dateTime | Clinically relevant time/time-period for observation |
| value[x] | S | 0..1 | CodeableConcept | Actual result Binding: IPS Current Smoking Status (required) |
| component | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.value[x] | required | IPSCurrentSmokingStatus |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72166-2 | |
| subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| effective[x] | SΣ | 0..1 | dateTime | Clinically relevant time/time-period for observation |
| value[x] | SΣC | 0..1 | CodeableConcept | Actual result Binding: IPS Current Smoking Status (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | ObservationStatus |
| Observation.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.value[x] | required | IPSCurrentSmokingStatus |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72166-2 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| focus | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | SΣ | 0..1 | dateTime | Clinically relevant time/time-period for observation | ||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | SΣC | 0..1 | CodeableConcept | Actual result Binding: IPS Current Smoking Status (required) | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.subject.type | extensible | ResourceType | ||||
| Observation.value[x] | required | IPSCurrentSmokingStatus | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
This structure is derived from Observation
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ bbmri.de. Package de.bbmri.fhir#1.2.0 based on FHIR 4.0.1. Generated 2023-09-01
Links: Table of Contents |
QA Report
| 