Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-AlcoholUse

CBB	Description	Status
HdBe-AlcoholUse	In the context of this information model, alcohol is the collective term for alcoholic beverages consumed as a leisure product. This information model describes the information asked of the patient about their alcohol use. Purpose During the social anamnesis, the patient is frequently asked about their alcohol consumption. Excessive (episodic) alcohol consumption may influence the current treatment and diagnostics. Alcohol-related problems are diagnosed as secondary diagnoses more and more often. Source: Guidelines - Multidisciplinary guidelines for Disorders in alcohol use (CBO, 2009) Instructions If the exchange of information on past alcohol consumption is desired in the event that the patient has by now stopped or significantly reduced their alcohol intake, then this can be done by applying the information model a second time with an entered stop date, so that it is clear that the amount of units per day is the past amount. If desired, the sender can include the type of alcohol used in the ‘Comment’ field.	active

CBB

Description

Status

HdBe-AlcoholUse

In the context of this information model, alcohol is the collective term for alcoholic beverages consumed as a leisure product. This information model describes the information asked of the patient about their alcohol use.

Purpose

During the social anamnesis, the patient is frequently asked about their alcohol consumption. Excessive (episodic) alcohol consumption may influence the current treatment and diagnostics. Alcohol-related problems are diagnosed as secondary diagnoses more and more often. Source: Guidelines - Multidisciplinary guidelines for Disorders in alcohol use (CBO, 2009)

Instructions

If the exchange of information on past alcohol consumption is desired in the event that the patient has by now stopped or significantly reduced their alcohol intake, then this can be done by applying the information model a second time with an entered stop date, so that it is clear that the amount of units per day is the past amount.

If desired, the sender can include the type of alcohol used in the ‘Comment’ field.

active

AlcoholUse			AlcoholUse	Element id AlcoholUse Short description AlcoholUse Definition Root concept of the AlcoholUse information model. This concept contains all data elements of the AlcoholUse information model. Data type AlcoholUse Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id AlcoholUse.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AlcoholUse.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
Comment		0..1	string	Element id AlcoholUse.Comment Short description Comment Definition Relevant comments on the alcohol consumption. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
AlcoholUseStatus		1..1	CodeableConceptBinding	Element id AlcoholUse.AlcoholUseStatus Short description AlcoholUseStatus Definition The status of the patient’s alcohol use. 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. Data type CodeableConcept Binding AlcoholUseStatus codes AlcoholUseStatus (required) Constraints 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
ObservationOfUse		0..1	BackboneElement	Element id AlcoholUse.ObservationOfUse Short description ObservationOfUse Definition Container of the ObservationOfUse concept. This container contains all data elements of the observation of alcohol use. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id AlcoholUse.ObservationOfUse.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AlcoholUse.ObservationOfUse.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AlcoholUse.ObservationOfUse.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May 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). 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. Data type Extension Constraints 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
StartDate		0..1	dateTime	Element id AlcoholUse.ObservationOfUse.StartDate Short description StartDate Definition The date on which the patient started using alcohol. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
StopDate		0..1	dateTime	Element id AlcoholUse.ObservationOfUse.StopDate Short description StopDate Definition The date on which the patient stopped consuming alcohol. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
Amount	I	0..1	Quantity	Element id AlcoholUse.ObservationOfUse.Amount Short description Amount Definition The extent of the patient’s alcohol use in units of alcohol per time period. 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. Data type Quantity Constraints 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

AlcoholUse		0..*
AlcoholUse.Comment	string	0..1
AlcoholUse.AlcoholUseStatus	CodeableConcept	1..1
AlcoholUse.ObservationOfUse	BackboneElement	0..1
AlcoholUse.ObservationOfUse.StartDate	dateTime	0..1
AlcoholUse.ObservationOfUse.StopDate	dateTime	0..1
AlcoholUse.ObservationOfUse.Amount	Quantity	0..1

AlcoholUse
Definition	Root concept of the AlcoholUse information model. This concept contains all data elements of the AlcoholUse information model.
Cardinality	0...*
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
AlcoholUse.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
AlcoholUse.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.
Cardinality	0...*
Type	Extension
Alias	extensions, 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.
Slicing	Unordered, 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
AlcoholUse.Comment
Definition	Relevant comments on the alcohol consumption.
Cardinality	0...1
Type	string
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
AlcoholUse.AlcoholUseStatus
Definition	The status of the patient’s alcohol use.
Cardinality	1...1
Type	CodeableConcept
Binding	AlcoholUseStatus codes AlcoholUseStatus (required)
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
AlcoholUse.ObservationOfUse
Definition	Container of the ObservationOfUse concept. This container contains all data elements of the observation of alcohol use.
Cardinality	0...1
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
AlcoholUse.ObservationOfUse.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
AlcoholUse.ObservationOfUse.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.
Cardinality	0...*
Type	Extension
Alias	extensions, 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.
Slicing	Unordered, 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
AlcoholUse.ObservationOfUse.modifierExtension
Definition	May 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).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, 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
AlcoholUse.ObservationOfUse.StartDate
Definition	The date on which the patient started using alcohol.
Cardinality	0...1
Type	dateTime
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
AlcoholUse.ObservationOfUse.StopDate
Definition	The date on which the patient stopped consuming alcohol.
Cardinality	0...1
Type	dateTime
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
AlcoholUse.ObservationOfUse.Amount
Definition	The extent of the patient’s alcohol use in units of alcohol per time period.
Cardinality	0...1
Type	Quantity
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

Example instances

AlcoholUse
Comment	Drinks mostly in weekends.
AlcoholUseStatus	219006 - Current drinker (code by SNOMED CT)
ObservationOfUse.StartDate	1995-01-01
ObservationOfUse.StopDate
ObservationOfUse.Amount	3 units per day

zib AlcoholUse-v3.2 difference

Concept	Category	Description
`AlcoholUseStatus`	terminology	Replaced Other (code by Nullflavor) with the 74964007 - Other (code by SNOMED CT) and added 261665006 - Unknown (code by SNOMED CT).

Terminology Bindings

Path	Name	Strength	URL
AlcoholUseStatus	AlcoholUseStatus	required	https://fhir.healthdata.be/ValueSet/AlcoholUseStatus