HdBe-DrugUse

CBBStatusURL
HdBe-DrugUsedrafthttps://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-DrugUse

start_date0..1dateTime
stop_date0..1dateTime
amount0..1string
comment0..1string
drug_or_medication_type0..1CodeableConceptBinding
drug_use_status1..1CodeableConceptBinding
route_of_administration0..*CodeableConceptBinding

drug_use0..*
drug_use.observation_of_useBackboneElement0..1
drug_use.observation_of_use.start_datedateTime0..1
drug_use.observation_of_use.stop_datedateTime0..1
drug_use.observation_of_use.amountstring0..1
drug_use.commentstring0..1
drug_use.drug_or_medication_typeCodeableConcept0..1
drug_use.drug_use_statusCodeableConcept1..1
drug_use.route_of_administrationCodeableConcept0..*



drug_use
DefinitionRoot concept of the DrugUse information model. This concept contains all data elements of the DrugUse 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
drug_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
drug_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
drug_use.observation_of_use
DefinitionContainer for ObservationOfUse. This container contains all data elements of the ObservationOfUse container.
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
drug_use.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
drug_use.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
drug_use.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
drug_use.observation_of_use.start_date
DefinitionThe date on which the patient started using.
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
drug_use.observation_of_use.stop_date
DefinitionThe date on which the patient quit using
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
drug_use.observation_of_use.amount
DefinitionThe number of units (pills, joints, shots etc.) per day, week, month or year or the frequency of use.
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
drug_use.comment
DefinitionRelevant comments on the drug use.
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
drug_use.drug_or_medication_type
DefinitionType of drug used by the patient.
Cardinality0...1
TypeCodeableConcept
Binding

DrugOrMedicationType codes

TypeOfDrugOrMedication (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
drug_use.drug_use_status
DefinitionIndication stating whether there was any drug use in the past or present.
Cardinality1...1
TypeCodeableConcept
Binding

DrugUseStatus codes

DrugUseStatus (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
drug_use.route_of_administration
DefinitionThe way the drugs are used.
Cardinality0...*
TypeCodeableConcept
Binding

RouteOfAdministration codes

RouteOfAdministration (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

Example instances

drug_use
observation_of_use.start_date 1985-01-01
observation_of_use.stop_date
observation_of_use.amount 2x per month
comment Uses at parties and on weekends. The patient used more in the past than the present.
drug_or_medication_type 288459003 - Methylenedioxymethamphetamine (SNOMED CT)
drug_use_status 417284009 - Current drug user (SNOMED CT)
route_of_administration 26643006 - Oral route (SNOMED CT), 46713006 - Nasal route (SNOMED CT)

zib DrugUse-v3.3 difference

Concept Category Description
drug_use_status terminology Replaced 'Other' from HL7 NullFlavor CodeSystem with equivalent SNOMED code.
drug_or_medication_type terminology Replaced 'Other' from HL7 NullFlavor CodeSystem with equivalent SNOMED code.
route_of_administration terminology Replaced ValueSet content of RouteOfAdministration with SNOMED codes.



Terminology Bindings

PathNameStrengthURL
drug_or_medication_typeTypeOfDrugOrMedicationextensiblehttps://fhir.healthdata.be/ValueSet/TypeOfDrugOrMedication
drug_use_statusDrugUseStatusextensiblehttps://fhir.healthdata.be/ValueSet/DrugUseStatus
route_of_administrationRouteOfAdministrationextensiblehttps://fhir.healthdata.be/ValueSet/RouteOfAdministration