EHDSDosage
type: StructureDefinition
node role: treeRoot
id:
  v: EHDSDosage
language:
  v: en
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition EHDSDosage Language: en Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> EHDSDosage 0..* Base Dosage model #xD; renderedDosageInstruction 0..1 string 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. #xD; dosageDetails 0..* Base Details of single dosage scheme step #xD; sequence 0..1 integer 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. #xD; note 0..1 string Patient oriented instructions as free text for this dosage step #xD; doseAndRate 0..* Base Amount of medication administered per one dose (= one timing) #xD; dose[x] 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml) Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation) #xD; doseQuantity Quantity #xD; doseRange Range #xD; rate[x] 0..1 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). Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation) #xD; rateQuantity Quantity #xD; rateRatio Ratio #xD; repeat 0..1 Base Repetition of the administration. #xD; bounds[x] 0..1 Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023). Binding Description: (preferred): UCUM #xD; boundsQuantity Quantity #xD; boundsPeriod Period #xD; duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour') Binding Description: (preferred): UCUM #xD; frequency 0..…
url:
  v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDosage
  l: EHDSDosage
version:
  v: 1.0.0
name:
  v: EHDSDosage
title:
  v: Dosage model
status:
  v: active
date:
  v: 2026-04-03T08:10:50+00:00
publisher:
  v: Xt-EHR
contact:
  name:
    v: Xt-EHR
  telecom:
    system:
      v: url
    value:
      v: http://www.xt-ehr.eu/
description:
  v: 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.
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDosage
  l: EHDSDosage
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  l: Base
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 5.0.0
  element:
    id:
      v: EHDSDosage
    path:
      v: EHDSDosage
    short:
      v: Dosage model
    definition:
      v: 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.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: EHDSDosage.renderedDosageInstruction
    path:
      v: EHDSDosage.renderedDosageInstruction
    short:
      v: 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.
    definition:
      v: 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.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: EHDSDosage.renderedDosageInstruction
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: EHDSDosage.dosageDetails
    path:
      v: EHDSDosage.dosageDetails
    short:
      v: Details of single dosage scheme step
    definition:
      v: Details of single dosage scheme step
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: EHDSDosage.dosageDetails
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Base
        l: Base
  element:
    id:
      v: EHDSDosage.dosageDetails.sequence
    path:
      v: EHDSDosage.dosageDetails.sequence
    short:
      v: 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.
    definition:
      v: 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.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: EHDSDosage.dosageDetails.sequence
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: integer
        l: integer
  element:
    id:
      v: EHDSDosage.dosageDetails.note
    path:
      v: EHDSDosage.dosageDetails.note
    short:
      v: Patient oriented instructions as free text for this dosage step
    definition:
      v: Patient oriented instructions as free text for this dosage step
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: EHDSDosage.dosageDetails.note
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: EHDSDosage.dosageDetails.doseAndRate
    path:
      v: EHDSDosage.dosageDetails.doseAndRate
    short:
      v: Amount of medication administered per one dose (= one timing)
    definition:
      v: Amount of medication administered per one dose (= one timing)
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: EHDSDosage.dosageDetails.doseAndRate

v: 0

v: *

code:
  v: Base
  l: Base

id:
  v: EHDSDosage.dosageDetails.doseAndRate.dose[x]
path:
  v: EHDSDosage.dosageDetails.doseAndRate.dose[x]
short:
  v: Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
definition:
  v: Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.doseAndRate.dose[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Quantity
    l: Quantity
type:
  code:
    v: Range
    l: Range
binding:
  strength:
    v: preferred
  description:
    v: UCUM (units of measurement), EDQM Standard Terms (units of presentation)

id:
  v: EHDSDosage.dosageDetails.doseAndRate.rate[x]
path:
  v: EHDSDosage.dosageDetails.doseAndRate.rate[x]
short:
  v: 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).
definition:
  v: 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).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.doseAndRate.rate[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Quantity
    l: Quantity
type:
  code:
    v: Ratio
    l: Ratio
binding:
  strength:
    v: preferred
  description:
    v: UCUM (units of measurement), EDQM Standard Terms (units of presentation)

id:
  v: EHDSDosage.dosageDetails.repeat
path:
  v: EHDSDosage.dosageDetails.repeat
short:
  v: Repetition of the administration.
definition:
  v: Repetition of the administration.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.repeat
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSDosage.dosageDetails.repeat.bounds[x]
path:
  v: EHDSDosage.dosageDetails.repeat.bounds[x]
short:
  v: Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
definition:
  v: Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.repeat.bounds[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Quantity
    l: Quantity
type:
  code:
    v: Period
    l: Period
binding:
  strength:
    v: preferred
  description:
    v: UCUM

id:
  v: EHDSDosage.dosageDetails.repeat.duration
path:
  v: EHDSDosage.dosageDetails.repeat.duration
short:
  v: Duration of administration (e.g '5 minutes', '1 hour')
definition:
  v: Duration of administration (e.g '5 minutes', '1 hour')
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.repeat.duration
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Quantity
    l: Quantity
binding:
  strength:
    v: preferred
  description:
    v: UCUM

id:
  v: EHDSDosage.dosageDetails.repeat.frequency
path:
  v: EHDSDosage.dosageDetails.repeat.frequency
short:
  v: Frequency of intake/administration (e.g 'three times a day')
definition:
  v: Frequency of intake/administration (e.g 'three times a day')
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.repeat.frequency
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSDosage.dosageDetails.repeat.frequency.numberOfTimes
path:
  v: EHDSDosage.dosageDetails.repeat.frequency.numberOfTimes
short:
  v: Number of times per period (e.g '3 times')
definition:
  v: Number of times per period (e.g '3 times')
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.repeat.frequency.numberOfTimes
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: EHDSDosage.dosageDetails.repeat.frequency.period
path:
  v: EHDSDosage.dosageDetails.repeat.frequency.period
short:
  v: Duration to which the frequency applies (e.g '... / 1 day')
definition:
  v: Duration to which the frequency applies (e.g '... / 1 day')
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.repeat.frequency.period
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Quantity
    l: Quantity
binding:
  strength:
    v: preferred
  description:
    v: UCUM

id:
  v: EHDSDosage.dosageDetails.repeat.dayOfWeek
path:
  v: EHDSDosage.dosageDetails.repeat.dayOfWeek
short:
  v: The day of the week of administration, e.g Mon, Tue, etc
definition:
  v: The day of the week of administration, e.g Mon, Tue, etc
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSDosage.dosageDetails.repeat.dayOfWeek
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: EHDSDosage.dosageDetails.repeat.timeOfDay
path:
  v: EHDSDosage.dosageDetails.repeat.timeOfDay
short:
  v: Exact time of day of administration (e.g '10:00')
definition:
  v: Exact time of day of administration (e.g '10:00')
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSDosage.dosageDetails.repeat.timeOfDay
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: time
    l: time

id:
  v: EHDSDosage.dosageDetails.repeat.eventTime
path:
  v: EHDSDosage.dosageDetails.repeat.eventTime
short:
  v: Time period or event when the administration should happen ('before meal', 'immediately', 'morning')
definition:
  v: Time period or event when the administration should happen ('before meal', 'immediately', 'morning')
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSDosage.dosageDetails.repeat.eventTime
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: EHDSDosage.dosageDetails.asNeeded
path:
  v: EHDSDosage.dosageDetails.asNeeded
short:
  v: Take as needed
definition:
  v: Take as needed
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.asNeeded
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: EHDSDosage.dosageDetails.bodySite
path:
  v: EHDSDosage.dosageDetails.bodySite
short:
  v: Body site of administration
definition:
  v: Body site of administration
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.bodySite
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSBodyStructure
    l: EHDSBodyStructure

id:
  v: EHDSDosage.dosageDetails.routeOfAdministration
path:
  v: EHDSDosage.dosageDetails.routeOfAdministration
short:
  v: Route of administration
definition:
  v: Route of administration
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDosage.dosageDetails.routeOfAdministration
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: EDQM Standard Terms

element:
  id:
    v: EHDSDosage
  path:
    v: EHDSDosage
  short:
    v: Dosage model
  definition:
    v: 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.
element:
  id:
    v: EHDSDosage.renderedDosageInstruction
  path:
    v: EHDSDosage.renderedDosageInstruction
  short:
    v: 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.
  definition:
    v: 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.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: EHDSDosage.dosageDetails
  path:
    v: EHDSDosage.dosageDetails
  short:
    v: Details of single dosage scheme step
  definition:
    v: Details of single dosage scheme step
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Base
      l: Base
element:
  id:
    v: EHDSDosage.dosageDetails.sequence
  path:
    v: EHDSDosage.dosageDetails.sequence
  short:
    v: 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.
  definition:
    v: 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.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: integer
      l: integer
element:
  id:
    v: EHDSDosage.dosageDetails.note
  path:
    v: EHDSDosage.dosageDetails.note
  short:
    v: Patient oriented instructions as free text for this dosage step
  definition:
    v: Patient oriented instructions as free text for this dosage step
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: EHDSDosage.dosageDetails.doseAndRate
  path:
    v: EHDSDosage.dosageDetails.doseAndRate
  short:
    v: Amount of medication administered per one dose (= one timing)
  definition:
    v: Amount of medication administered per one dose (= one timing)
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Base
      l: Base
element:
  id:
    v: EHDSDosage.dosageDetails.doseAndRate.dose[x]
  path:
    v: EHDSDosage.dosageDetails.doseAndRate.dose[x]
  short:
    v: Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
  definition:
    v: Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Quantity
      l: Quantity
  type:
    code:
      v: Range
      l: Range
  binding:
    strength:
      v: preferred
    description:
      v: UCUM (units of measurement), EDQM Standard Terms (units of presentation)
element:
  id:
    v: EHDSDosage.dosageDetails.doseAndRate.rate[x]
  path:
    v: EHDSDosage.dosageDetails.doseAndRate.rate[x]
  short:
    v: 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).
  definition:
    v: 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).
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Quantity
      l: Quantity
  type:
    code:
      v: Ratio
      l: Ratio
  binding:
    strength:
      v: preferred
    description:
      v: UCUM (units of measurement), EDQM Standard Terms (units of presentation)
element:
  id:
    v: EHDSDosage.dosageDetails.repeat
  path:
    v: EHDSDosage.dosageDetails.repeat
  short:
    v: Repetition of the administration.
  definition:
    v: Repetition of the administration.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Base
      l: Base
element:
  id:
    v: EHDSDosage.dosageDetails.repeat.bounds[x]
  path:
    v: EHDSDosage.dosageDetails.repeat.bounds[x]
  short:
    v: Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
  definition:
    v: Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Quantity
      l: Quantity
  type:
    code:
      v: Period
      l: Period
  binding:
    strength:
      v: preferred
    description:
      v: UCUM
element:
  id:
    v: EHDSDosage.dosageDetails.repeat.duration
  path:
    v: EHDSDosage.dosageDetails.repeat.duration
  short:
    v: Duration of administration (e.g '5 minutes', '1 hour')
  definition:
    v: Duration of administration (e.g '5 minutes', '1 hour')
  min:
    v: 0
  max:
    v: 1

code:
  v: Quantity
  l: Quantity

strength:
  v: preferred
description:
  v: UCUM

id:
  v: EHDSDosage.dosageDetails.repeat.frequency
path:
  v: EHDSDosage.dosageDetails.repeat.frequency
short:
  v: Frequency of intake/administration (e.g 'three times a day')
definition:
  v: Frequency of intake/administration (e.g 'three times a day')
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSDosage.dosageDetails.repeat.frequency.numberOfTimes
path:
  v: EHDSDosage.dosageDetails.repeat.frequency.numberOfTimes
short:
  v: Number of times per period (e.g '3 times')
definition:
  v: Number of times per period (e.g '3 times')
min:
  v: 1
max:
  v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: EHDSDosage.dosageDetails.repeat.frequency.period
path:
  v: EHDSDosage.dosageDetails.repeat.frequency.period
short:
  v: Duration to which the frequency applies (e.g '... / 1 day')
definition:
  v: Duration to which the frequency applies (e.g '... / 1 day')
min:
  v: 1
max:
  v: 1
type:
  code:
    v: Quantity
    l: Quantity
binding:
  strength:
    v: preferred
  description:
    v: UCUM

id:
  v: EHDSDosage.dosageDetails.repeat.dayOfWeek
path:
  v: EHDSDosage.dosageDetails.repeat.dayOfWeek
short:
  v: The day of the week of administration, e.g Mon, Tue, etc
definition:
  v: The day of the week of administration, e.g Mon, Tue, etc
min:
  v: 0
max:
  v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: EHDSDosage.dosageDetails.repeat.timeOfDay
path:
  v: EHDSDosage.dosageDetails.repeat.timeOfDay
short:
  v: Exact time of day of administration (e.g '10:00')
definition:
  v: Exact time of day of administration (e.g '10:00')
min:
  v: 0
max:
  v: *
type:
  code:
    v: time
    l: time

id:
  v: EHDSDosage.dosageDetails.repeat.eventTime
path:
  v: EHDSDosage.dosageDetails.repeat.eventTime
short:
  v: Time period or event when the administration should happen ('before meal', 'immediately', 'morning')
definition:
  v: Time period or event when the administration should happen ('before meal', 'immediately', 'morning')
min:
  v: 0
max:
  v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: EHDSDosage.dosageDetails.asNeeded
path:
  v: EHDSDosage.dosageDetails.asNeeded
short:
  v: Take as needed
definition:
  v: Take as needed
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: EHDSDosage.dosageDetails.bodySite
path:
  v: EHDSDosage.dosageDetails.bodySite
short:
  v: Body site of administration
definition:
  v: Body site of administration
min:
  v: 0
max:
  v: 1
type:
  code:
    v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSBodyStructure
    l: EHDSBodyStructure

id:
  v: EHDSDosage.dosageDetails.routeOfAdministration
path:
  v: EHDSDosage.dosageDetails.routeOfAdministration
short:
  v: Route of administration
definition:
  v: Route of administration
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: EDQM Standard Terms