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

EN NL FR

HdBe-InstructionsForUse

CBBDescriptionStatus
HdBe-InstructionsForUse

Instructions for the use or administration of the medication, e.g. dose and route of administration. In the event of medication use, this is the pattern of use established by the patient or which the patient followed. This is a partial information model.

Purpose

InstructionsForUse gives an insight into the manner a drug is to be used.

Instructions

AsNeeded dosage: Using the term 'as needed' or a specific reason (e.g. 'in case of pain') to use medication leads to ambiguity. It is not always clear whether the whole dose is 'as needed' or only part of the dose. For example: 1x daily 1-2 tablets as needed. This can mean: 1 tablet fixed per day and 1 tablet as needed or, as needed, a maximum of 2 tablets. As needed medication is not included in GDS. In the first situation, 1 tablet comes in the GDS (drug dispensing systems) and 1 tablet is delivered separately. In the second situation there is only separate delivery. The system must make sufficiently clear whether the entire instruction or part of the dose is necessary. The CBB supports both options described above.

active

id0..1string
extensionI0..*Extension
AdditionalInstructions0..*string
Description0..1string
RepeatPeriodCyclicalScheduleI0..1Quantity
RouteOfAdministration0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
DoseDurationI0..1Quantity
SequenceNumber0..1positiveInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
AdministeringSpeed0..1HdBe-Range
DurationOfAdministration0..1HdBe-TimeInterval
Dose0..1HdBe-Range
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
Condition0..1CodeableConceptBinding
MaximumDoseI0..1Quantity
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
Frequency0..1HdBe-Range
WeekDay0..*CodeableConceptBinding
TimeOfDay0..*CodeableConceptBinding
AdministrationTime0..*dateTime
IntervalI0..1Quantity

InstructionsForUse0..*
InstructionsForUse.AdditionalInstructionsstring0..*
InstructionsForUse.Descriptionstring0..1
InstructionsForUse.RepeatPeriodCyclicalScheduleQuantity0..1
InstructionsForUse.RouteOfAdministrationCodeableConcept0..1
InstructionsForUse.DosingInstructionsBackboneElement0..*
InstructionsForUse.DosingInstructions.DoseDurationQuantity0..1
InstructionsForUse.DosingInstructions.SequenceNumberpositiveInt0..1
InstructionsForUse.DosingInstructions.DosageBackboneElement0..*
InstructionsForUse.DosingInstructions.Dosage.AdministeringSpeedHdBe-Range0..1
InstructionsForUse.DosingInstructions.Dosage.DurationOfAdministrationHdBe-TimeInterval0..1
InstructionsForUse.DosingInstructions.Dosage.DoseHdBe-Range0..1
InstructionsForUse.DosingInstructions.Dosage.AsNeededBackboneElement0..1
InstructionsForUse.DosingInstructions.Dosage.AsNeeded.ConditionCodeableConcept0..1
InstructionsForUse.DosingInstructions.Dosage.AsNeeded.MaximumDoseQuantity0..1
InstructionsForUse.DosingInstructions.Dosage.AdministeringScheduleBackboneElement0..1
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.FrequencyHdBe-Range0..1
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.WeekDayCodeableConcept0..*
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.TimeOfDayCodeableConcept0..*
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.AdministrationTimedateTime0..*
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.IntervalQuantity0..1


InstructionsForUse
DefinitionRoot concept of the InstructionsForUse partial information model. This root concept contains all data elements of the InstructionsForUse partial 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
InstructionsForUse.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
Typestring
Mappings
  • rim: n/a
InstructionsForUse.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
InstructionsForUse.AdditionalInstructions
DefinitionThe additional instructions contain extra information on the use of the current prescription. This includes all instructions for use. The text can come from the original “paper" medication prescription, but can also be generated from the coded information. This concept may contain more information than what is structurally coded in the information below, but may not conflict with it. The instructions may not conflict with other components of the request for administration. The instructions can also refer to an existing protocol.
Cardinality0...*
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
InstructionsForUse.Description
DefinitionTextual description of the complete instructions for use including the period 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
InstructionsForUse.RepeatPeriodCyclicalSchedule
DefinitionThe repeated period in a cyclical schedule (of one or more dosing instructions). A cyclic schedule is noted in days, the corresponding dosing duration is also in days. Examples of a cyclical schedule: contraceptive pill (21 days, 1 pill 1x a day, then skip for 7 days, repeat), repeat period here is 28 days
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
InstructionsForUse.RouteOfAdministration
DefinitionThe route through which the medication is administered (oral, nasal, intravenous, etc.).
Cardinality0...1
TypeCodeableConcept
Binding

RouteOfAdministration codes

RouteOfMedicationAdministration (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
InstructionsForUse.DosingInstructions
DefinitionDosing instructions
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.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
Typestring
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.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
InstructionsForUse.DosingInstructions.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
InstructionsForUse.DosingInstructions.DoseDuration
DefinitionThe intended time duration for these dosing instructions, *e.g*. 5 days or 8 weeks. In the case of medication for an indefinite period, the dosing duration is left empty in the last dosing instruction.
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
InstructionsForUse.DosingInstructions.SequenceNumber
DefinitionThis indicates the sequence of the dosing instructions within the medication agreement.
Cardinality0...1
TypepositiveInt
Comments

32 bit number; for values larger than this, use decimal

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage
DefinitionContainer of the Dosage concept. This container contains all data elements of the Dosage concept. Instructions for the administrator to administer the medication (the patient themselves, a nurse or other aid). When taking stock of medication use, the dosage describes the pattern of use established by the patient. Once the dose schedule (distribution of doses over time) and the dose have been determined, then there should be one single instruction for use. Multiple *parallel* instructions for use can be included in the event of a changing dose within one day and in the event of a variable use frequency. Multiple *sequential* instructions for use can be included in the event of changing doses within one period and/or in the event of a changing dose schedule.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.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
Typestring
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.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
InstructionsForUse.DosingInstructions.Dosage.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
InstructionsForUse.DosingInstructions.Dosage.AdministeringSpeed
DefinitionThe administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. For example, with an administering speed of 10ml/hour: * amount = 10, * dose unit = ml, * time unit = hour
Cardinality0...1
TypeHdBe-Range
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.DurationOfAdministration
DefinitionThe duration of administration defines the length of time during which the drug is administered and is mainly used in the slow parenteral administration of fluids.
Cardinality0...1
TypeHdBe-TimeInterval
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.Dose
DefinitionThe dose indicates the amount/unit per administration. The unit can be any unit that can occur with this particular medicine.
Cardinality0...1
TypeHdBe-Range
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.AsNeeded
DefinitionAs needed means that the dose is only to be administered under certain conditions. See also the Instructions section for more information about use of the element.
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
InstructionsForUse.DosingInstructions.Dosage.AsNeeded.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
Typestring
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.AsNeeded.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
InstructionsForUse.DosingInstructions.Dosage.AsNeeded.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
InstructionsForUse.DosingInstructions.Dosage.AsNeeded.Condition
DefinitionThe condition for administering medication can be: * a physiological measurement value (plasma glucose concentration, body temperature, blood pressure); * a symptom or other circumstance (in the event of a headache, or itch). Physiological measurement values or other conditions do not need to be coded. These can be expressed in free text in the Description concept.
Cardinality0...1
TypeCodeableConcept
Binding

Condition codes

AsNeededCriterium (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
InstructionsForUse.DosingInstructions.Dosage.AsNeeded.MaximumDose
DefinitionA maximum dose indicates the maximum duration a product can be used with an ‘as needed’ prescription.
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
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule
DefinitionSpecifications of the times at which the medication is to be administered. This is indicated as follows: * Time(s) (16:00) or indications (“before meals”) at which the medication is to be taken each day. * A specific number of times the medication is to be taken each day ("3x a day"), indicated with the frequency. * A time interval between consecutive doses (“Every 2 hours”, “every 3 days”), indicated with the word Interval. * Combined periods with an interval and duration (“1 daily for three out of four weeks: the pill schedule”) If a certain medication is not to be taken daily, the aforementioned can be combined with daily indications: * One or more week days on which the medication is to be administered (e.g. “Monday, Wednesday, Friday”) * ”3x a week”, “2x a month”. The specified administration “infinite” is automatically to be repeated until: * The end date and time has been reached * The total administration duration has been reached (14 days) * A specific amount of administrations has been reached (“20 doses”), to be entered in the Frequency concept.
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
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.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
Typestring
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.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
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.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
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.Frequency
DefinitionThe frequency indicates the number of dose moments per time unit, usually per day. If this frequency is included, then the Interval will not have been included. Usually, frequency comprises both amount and time unit (3 times a day), but it can occur without the time unit (single use). In that case, a reasonable distribution over the day is expected, but exact times are not given. This is left to the patient. It is the most common manner of extramural prescription. In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). The time unit of the frequency must be the same as how it is indicated in the textual description of the dose. Example: for a '2x a day...' dose: * amount = 2 * time unit = 'day'. for a '3x a week...' dose: * amount = 3 * time unit = 'week'.
Cardinality0...1
TypeHdBe-Range
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.WeekDay
DefinitionWeekDay indicates a pattern of doses on fixed week days.
Cardinality0...*
TypeCodeableConcept
Binding

WeekDay codes

WeekDay (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
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.TimeOfDay
DefinitionTime of day: morning, afternoon, evening, night.
Cardinality0...*
TypeCodeableConcept
Binding

TimeOfDay codes

TimeOfDay (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
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.AdministrationTime
DefinitionThe time of administration is a specific time of day (on the clock). This time usually isn’t (intended to be) exact. There can be multiple administering times in one day. The ideal time of administration can also be entered as a time of day (morning, afternoon, evening, night-time). The administration time is then to be left empty, and the time of day can be entered in the TimeOfDay concept.
Cardinality0...*
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
InstructionsForUse.DosingInstructions.Dosage.AdministeringSchedule.Interval
DefinitionInterval indicates the time between dose times. If this is included, then the *Frequency *will not have been included. Examples: every 4 hours, every 3 weeks. The times can now be chosen freely, but distribution throughout the day is more precise, and the interval between times is important (e.g. in the case of antibiotics) In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics).
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

Example instances

InstructionsForUse
description From 24 Oct 2016, for 4 days, 4 times per day 1 unit, if needed 2 times a day 1 unit, oral.
RouteOfAdministration 26643006 - Oral route (code by SNOMED CT)
DosingInstructions with sequenceNumber 1 4 times per day 1 unit
DosingInstructions with sequenceNumber 1 NC006 - if needed (code by healthdata.be - Sciensano) 2 times a day 1 unit

More functional and technical examples of dosages (in Dutch): https://informatiestandaarden.nictiz.nl/wiki/mp:V9.2.0.0_VoorbeeldenDoseringen

zib InstructionsForUse-v1.2.1 difference

Concept Category Description
description textual Removed guidance regarding Dutch codes.
AdditionalInstructions textual Removed text regarding the G-standard.
RouteOfAdministration terminology Replaced Dutch valueSet with the SNOMED hierarchy containing descendents of 284009009 (Route of administration value) (zib ticket #1781). Renamed ValueSet name RouteOfAdministration to RouteOfMedicationAdministration as there is an identically named valueSet (in HdBe-DrugUse) and to reuse it both here and in MedicationAdministration.
DosingInstructions.Dosage.AsNeeded.Condition terminology TO-DO: Replace Dutch valueSet with Belgium or international codes (zib ticket #1781).
DosingInstructions.Dosage.AsNeeded.Condition textual Removed text regarding the specific Dutch codes.
DosingInstructions.Dosage.AdministeringSpeed type Replaced type BackboneElement with Range type and added HdBe-Range partial CBB.
DosingInstructions.Dosage.AdministeringSpeed element Removed elements minimumValue, maximumValue and nominalValue as they are defined within the HdBe-Range.
DosingInstructions.Dosage.DurationOfAdministration type Replaced type BackboneElement with Range type and added HdBe-TimeInterval partial CBB.
DosingInstructions.Dosage.DurationOfAdministration element Removed elements startDateTime, endDateTime and duration as they are defined within the HdBe-TimeInterval.
DosingInstructions.Dosage.Dose type Replaced type BackboneElement with Range type and added HdBe-Range datatype CBB.
DosingInstructions.Dosage.Dose element Removed elements minimumValue, maximumValue and nominalValue as they are defined within the HdBe-Range.
DosingInstructions.Dosage.AdminsteringSchedule.Frequency type Replaced type BackboneElement with Range type and added HdBe-Range partial CBB.
DosingInstructions.Dosage.AdminsteringSchedule.Frequency element Removed elements minimumValue, maximumValue and nominalValue as they are defined within the HdBe-Range.
concept textual Added a period after 'This is a partial information model'.
instructions textual Replaced 'eg' with 'e.g.'.
instructions textual Replaced 'tablets.As' with 'tablets. As'.
instructions textual Replaced 'delivery.The system' with 'delivery. The system'.



Terminology Bindings

PathNameStrengthURL
RouteOfAdministrationRouteOfMedicationAdministrationrequiredhttps://fhir.healthdata.be/ValueSet/RouteOfMedicationAdministration
DosingInstructions.Dosage.AsNeeded.ConditionAsNeededCriteriumrequiredhttps://fhir.healthdata.be/ValueSet/AsNeededCriterium
DosingInstructions.Dosage.AdministeringSchedule.WeekDayWeekDayrequiredhttps://fhir.healthdata.be/ValueSet/WeekDay
DosingInstructions.Dosage.AdministeringSchedule.TimeOfDayTimeOfDayrequiredhttps://fhir.healthdata.be/ValueSet/TimeOfDay