description: The model covers usage instructions for administering a medicinal product, focusing on the most frequently used data elements. More complex dosage schemes may require additional elements, which should be communicated as part of the rendered dosage instructions element.
package_name: xtehr.eu.ehds.models
derivation: specialization
name: EHDSDosage
type: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDosage
elements:
  renderedDosageInstruction: {type: string, short: Full dosage information as human-readable text covering all dosage steps. Generating the text follows local rules and should include all locally implemented dosage data even when such elements are not present in this model., index: 0}
  dosageDetails:
    type: Base
    short: Details of single dosage scheme step
    array: true
    index: 1
    elements:
      sequence: {type: integer, short: 'Order of the dosage instruction, in case one treatment consists of several dosage steps. When two schemes share the same sequence number, they are meant to be running in parallel.', index: 2}
      note: {type: string, short: Patient oriented instructions as free text for this dosage step, index: 3}
      doseAndRate:
        type: Base
        short: Amount of medication administered per one dose (= one timing)
        array: true
        index: 4
        elements:
          dose:
            short: Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
            choices: [doseQuantity, doseRange]
            index: 6
          doseQuantity: {type: Quantity, short: 'Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)', choiceOf: dose, index: 7}
          doseRange: {type: Range, short: 'Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)', choiceOf: dose, index: 8}
          rate:
            short: Amount of medication per time period (e.g. 100mg per 1 hour). When rate is provided per 1 time unit, Quantity data type can be used with a suitable unit (e.g. mg/h, ug/min).
            choices: [rateQuantity, rateRatio]
            index: 10
          rateQuantity: {type: Quantity, short: 'Amount of medication per time period (e.g. 100mg per 1 hour). When rate is provided per 1 time unit, Quantity data type can be used with a suitable unit (e.g. mg/h, ug/min).', choiceOf: rate, index: 11}
          rateRatio: {type: Ratio, short: 'Amount of medication per time period (e.g. 100mg per 1 hour). When rate is provided per 1 time unit, Quantity data type can be used with a suitable unit (e.g. mg/h, ug/min).', choiceOf: rate, index: 12}
      repeat:
        type: Base
        short: Repetition of the administration.
        index: 13
        elements:
          bounds:
            type: Base
            short: Time bounds for the treatment (current dosage scheme). Only one of the following can exist.
            index: 14
            elements:
              duration: {type: Quantity, short: 'Number of time units, e.g 10 days', index: 15}
              period: {type: Period, short: 'Start and end date, 05.08.2023 - 10.08.2023', index: 16}
          duration: {type: Quantity, short: 'Duration of administration (e.g ''5 minutes'', ''1 hour'')', index: 17}
          frequency:
            type: Base
            short: Frequency of intake/administration (e.g 'three times a day')
            index: 18
            elements:
              numberOfTimes: {type: integer, short: Number of times per period (e.g '3 times'), index: 19}
              period: {type: Quantity, short: Duration to which the frequency applies (e.g '... / 1 day'), index: 20}
          dayOfWeek: {type: CodeableConcept, short: 'The day of the week of administration, e.g Mon, Tue, etc', array: true, index: 21}
          timeOfDay: {type: time, short: 'Exact time of day of administration (e.g ''10:00'')', array: true, index: 22}
          eventTime: {type: CodeableConcept, short: 'Time period or event when the administration should happen (''before meal'', ''immediately'', ''morning'')', array: true, index: 23}
      asNeeded: {type: boolean, short: Take as needed, index: 24}
      bodySite: {type: 'http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSBodyStructure', short: Body site of administration, index: 25}
      routeOfAdministration: {type: CodeableConcept, short: Route of administration, index: 26}
package_version: 0.3.0
class: logical
kind: logical
url: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDosage
base: http://hl7.org/fhir/StructureDefinition/Base
version: 0.3.0