FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagextehr.eu.ehds.models
Resource TypeStructureDefinition
IdStructureDefinition-EHDSAdministeredDosage.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/Xt-EHR/xt-ehr-common/StructureDefinition-EHDSAdministeredDosage.html
URLhttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAdministeredDosage
Version0.3.0
Statusdraft
Date2026-02-09T10:38:57+00:00
NameEHDSAdministeredDosage
TitleAdministered dosage model
DescriptionModel contains elements needed for registering an individual medication administration. It is derived from the full dosage regimen model in order to keep the consistency between the shared elements.
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAdministeredDosage
Kindlogical

Resources that use this resource

StructureDefinition
EHDSMedicationAdministrationMedication administration model

Resources that this resource uses

StructureDefinition
EHDSDosageDosage model

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition EHDSAdministeredDosage

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSAdministeredDosage 0..*EHDSDosageAdministered dosage model

Elements defined in Ancestors:renderedDosageInstruction, dosageDetails
... dosageDetails 0..1BaseDetails of single dosage scheme step
.... sequence 0..0Order 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.
.... repeat 0..0Repetition of the administration.
.... asNeeded 0..0Take as needed

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "EHDSAdministeredDosage",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAdministeredDosage",
  "version": "0.3.0",
  "name": "EHDSAdministeredDosage",
  "title": "Administered dosage model",
  "status": "draft",
  "date": "2026-02-09T10:38:57+00:00",
  "publisher": "Xt-EHR",
  "contact": [
    {
      "name": "Xt-EHR",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.xt-ehr.eu/"
        }
      ]
    }
  ],
  "description": "Model contains elements needed for registering an individual medication administration. It is derived from the full dosage regimen model in order to keep the consistency between the shared elements.",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAdministeredDosage",
  "baseDefinition": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDosage",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.3.0"
      }
    ],
    "element": [
      {
        "id": "EHDSAdministeredDosage",
        "path": "EHDSAdministeredDosage",
        "short": "Administered dosage model",
        "definition": "Model contains elements needed for registering an individual medication administration. It is derived from the full dosage regimen model in order to keep the consistency between the shared elements.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.renderedDosageInstruction",
        "path": "EHDSAdministeredDosage.renderedDosageInstruction",
        "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.",
        "definition": "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": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.renderedDosageInstruction",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails",
        "path": "EHDSAdministeredDosage.dosageDetails",
        "short": "Details of single dosage scheme step",
        "definition": "Details of single dosage scheme step",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.sequence",
        "path": "EHDSAdministeredDosage.dosageDetails.sequence",
        "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.",
        "definition": "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": 0,
        "max": "0",
        "base": {
          "path": "EHDSDosage.dosageDetails.sequence",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.note",
        "path": "EHDSAdministeredDosage.dosageDetails.note",
        "short": "Patient oriented instructions as free text for this dosage step",
        "definition": "Patient oriented instructions as free text for this dosage step",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.note",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.doseAndRate",
        "path": "EHDSAdministeredDosage.dosageDetails.doseAndRate",
        "short": "Amount of medication administered per one dose (= one timing)",
        "definition": "Amount of medication administered per one dose (= one timing)",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSDosage.dosageDetails.doseAndRate",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.doseAndRate.dose[x]",
        "path": "EHDSAdministeredDosage.dosageDetails.doseAndRate.dose[x]",
        "short": "Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)",
        "definition": "Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.doseAndRate.dose[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity"
          },
          {
            "code": "Range"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "UCUM (units of measurement), EDQM Standard Terms (units of presentation)"
        }
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.doseAndRate.rate[x]",
        "path": "EHDSAdministeredDosage.dosageDetails.doseAndRate.rate[x]",
        "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).",
        "definition": "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": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.doseAndRate.rate[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity"
          },
          {
            "code": "Ratio"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "UCUM (units of measurement), EDQM Standard Terms (units of presentation)"
        }
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat",
        "short": "Repetition of the administration.",
        "definition": "Repetition of the administration.",
        "min": 0,
        "max": "0",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.bounds",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.bounds",
        "short": "Time bounds for the treatment (current dosage scheme). Only one of the following can exist.",
        "definition": "Time bounds for the treatment (current dosage scheme). Only one of the following can exist.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.bounds",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.bounds.duration",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.bounds.duration",
        "short": "Number of time units, e.g 10 days",
        "definition": "Number of time units, e.g 10 days",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.bounds.duration",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "UCUM"
        }
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.bounds.period",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.bounds.period",
        "short": "Start and end date, 05.08.2023 - 10.08.2023",
        "definition": "Start and end date, 05.08.2023 - 10.08.2023",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.bounds.period",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.duration",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.duration",
        "short": "Duration of administration (e.g '5 minutes', '1 hour')",
        "definition": "Duration of administration (e.g '5 minutes', '1 hour')",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.duration",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "UCUM"
        }
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.frequency",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.frequency",
        "short": "Frequency of intake/administration (e.g 'three times a day')",
        "definition": "Frequency of intake/administration (e.g 'three times a day')",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.frequency",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.frequency.numberOfTimes",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.frequency.numberOfTimes",
        "short": "Number of times per period (e.g '3 times')",
        "definition": "Number of times per period (e.g '3 times')",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.frequency.numberOfTimes",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.frequency.period",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.frequency.period",
        "short": "Duration to which the frequency applies (e.g '... / 1 day')",
        "definition": "Duration to which the frequency applies (e.g '... / 1 day')",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.frequency.period",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "UCUM"
        }
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.dayOfWeek",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.dayOfWeek",
        "short": "The day of the week of administration, e.g Mon, Tue, etc",
        "definition": "The day of the week of administration, e.g Mon, Tue, etc",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.dayOfWeek",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.timeOfDay",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.timeOfDay",
        "short": "Exact time of day of administration (e.g '10:00')",
        "definition": "Exact time of day of administration (e.g '10:00')",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.timeOfDay",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "time"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat.eventTime",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat.eventTime",
        "short": "Time period or event when the administration should happen ('before meal', 'immediately', 'morning')",
        "definition": "Time period or event when the administration should happen ('before meal', 'immediately', 'morning')",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSDosage.dosageDetails.repeat.eventTime",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.asNeeded",
        "path": "EHDSAdministeredDosage.dosageDetails.asNeeded",
        "short": "Take as needed",
        "definition": "Take as needed",
        "min": 0,
        "max": "0",
        "base": {
          "path": "EHDSDosage.dosageDetails.asNeeded",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.bodySite",
        "path": "EHDSAdministeredDosage.dosageDetails.bodySite",
        "short": "Body site of administration",
        "definition": "Body site of administration",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.bodySite",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSBodyStructure"
          }
        ]
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.routeOfAdministration",
        "path": "EHDSAdministeredDosage.dosageDetails.routeOfAdministration",
        "short": "Route of administration",
        "definition": "Route of administration",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDosage.dosageDetails.routeOfAdministration",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "EDQM Standard Terms"
        }
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "EHDSAdministeredDosage",
        "path": "EHDSAdministeredDosage",
        "short": "Administered dosage model",
        "definition": "Model contains elements needed for registering an individual medication administration. It is derived from the full dosage regimen model in order to keep the consistency between the shared elements."
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails",
        "path": "EHDSAdministeredDosage.dosageDetails",
        "max": "1"
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.sequence",
        "path": "EHDSAdministeredDosage.dosageDetails.sequence",
        "max": "0"
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.repeat",
        "path": "EHDSAdministeredDosage.dosageDetails.repeat",
        "max": "0"
      },
      {
        "id": "EHDSAdministeredDosage.dosageDetails.asNeeded",
        "path": "EHDSAdministeredDosage.dosageDetails.asNeeded",
        "max": "0"
      }
    ]
  }
}