description: Logical model for prescribed/dispensed medication. The model is shared by statements, requests, dispensations, and administrations. Each of those may have different restrictions in a FHIR profile. The model is suitable for generic/virtual medications as well as branded/real products. The model aims to have basic alignment with ISO IDMP but it does not cover the full complexity needed for medication registries.
package_name: xtehr.eu.ehds.models
derivation: specialization
name: EHDSMedication
type: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication
elements:
  description: {type: string, short: 'Textual description of the product, e.g. including package description.', index: 10}
  identifyingCode:
    short: An identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.
    choices: [identifyingCodeCodeableConcept, identifyingCodeIdentifier]
    array: true
    index: 1
  doseForm: {type: CodeableConcept, short: 'Dose form at the package level (e.g. authorised dose form), corresponding to IDMP Combined Pharmaceutical Dose Form (this includes terms from EDQM Combination Pack or Combined Dose Form lists). Dose form for a single package item is defined in item.doseForm.', index: 9}
  item:
    type: Base
    short: A medication item. For combination packs, this can be multiple manufactured items with each item having its own dose form and ingredients+strengths defined
    array: true
    index: 11
    elements:
      doseForm: {type: CodeableConcept, short: 'Administrable or manufactured item dose form, depending on the type of medication definition. This should not include combined dose forms.', index: 12}
      ingredient:
        type: Base
        short: Ingredients
        array: true
        min: 1
        index: 13
        elements:
          isActive: {type: boolean, short: 'Marks whether the ingredient is considered an active ingredient. Excipients are typically not needed, and by default only active ingredients are expected.', index: 14}
          substance: {type: CodeableConcept, short: Substance, index: 15}
          strengthInfo:
            type: Base
            short: Strength of the product - amount of substance per unit
            index: 16
            elements:
              strength: {type: Ratio, short: 'Concentration or presentation strength, e.g ''100 mg/1 ml'' or ''500 mg per 1 tablet''', index: 17}
              basisOfStrengthSubstance: {type: CodeableConcept, short: 'Substance that the strength refers to, especially when different from .item.strength.substance', index: 18}
            required: [strength]
        required: [substance]
      unitOfPresentation: {type: CodeableConcept, short: 'Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package.', index: 19}
      containedQuantity: {type: Ratio, short: Manufactured item quantity per one item (3 ml / 1 vial), index: 20}
      amount: {type: Quantity, short: Number of such items in this product (5 vials). The combined amount of all items will be considered to be the total package size., index: 21}
      packageType: {type: CodeableConcept, short: Type of package of the medication item, index: 22}
    required: [ingredient]
  marketingAuthorisationHolder:
    type: Base
    short: Marketing authorisation holder of the medicinal product. Relevant for identifying the exact product. If the product does not have a marketing authorisation, the manufacturer information may be used.
    index: 6
    elements:
      organisationName: {type: string, short: Name of the organisation holding the authorisation for marketing/manufacturing, index: 7}
      organisationIdentifier: {type: Identifier, short: Identifier of the organisation and/or its physical location, array: true, index: 8}
  productName: {type: string, short: 'Current trade name (authorised name) of the product. When medication is specified by a CodeableConcept, the name may be omitted when available as the display name of the concept.', index: 5}
  classification: {type: CodeableConcept, short: Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.), array: true, index: 4}
  batch:
    type: Base
    short: Batch information of a medicinal product. Typically recorded during dispense or administration, rarely known or relevant for a prescription/request.
    index: 41
    elements:
      lotNumber: {type: string, short: Batch identifier of the medicinal product., index: 42}
      expirationDate: {type: dateTime, short: Batch expiration date of the medicinal product., index: 43}
  identifyingCodeIdentifier: {type: Identifier, short: 'An identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.', choiceOf: identifyingCode, array: true, index: 3}
  characteristic:
    type: Base
    short: Additional features of the product (e.g. reimbursable, sugar-free, easy-open cap, score-lined). It is expected that implementers will define a valueset supporting their use cases.
    array: true
    index: 29
    elements:
      valueDecimal: {type: decimal, short: Description of the characteristic value., choiceOf: value, index: 39}
      valueQuantity: {type: Quantity, short: Description of the characteristic value., choiceOf: value, index: 36}
      value:
        short: Description of the characteristic value.
        choices: [valueBoolean, valueCodeableConcept, valueString, valueQuantity, valueDateTime, valueInteger, valueDecimal, valueRatio]
        index: 32
      valueString: {type: string, short: Description of the characteristic value., choiceOf: value, index: 35}
      valueRatio: {type: Ratio, short: Description of the characteristic value., choiceOf: value, index: 40}
      valueBoolean: {type: boolean, short: Description of the characteristic value., choiceOf: value, index: 33}
      valueDateTime: {type: dateTime, short: Description of the characteristic value., choiceOf: value, index: 37}
      type: {type: CodeableConcept, short: A code expressing the type of characteristic., index: 30}
      valueCodeableConcept: {type: CodeableConcept, short: Description of the characteristic value., choiceOf: value, index: 34}
      valueInteger: {type: integer, short: Description of the characteristic value., choiceOf: value, index: 38}
    required: [type]
  identifyingCodeCodeableConcept: {type: CodeableConcept, short: 'An identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.', choiceOf: identifyingCode, array: true, index: 2}
  device:
    type: Base
    short: Administration device included in the product. Devices that are not inside the medication package are excluded.
    array: true
    index: 23
    elements:
      deviceQuantity: {type: Quantity, short: Number of such devices, index: 24}
      device:
        short: Device coded
        choices: [deviceCodeableConcept, 'deviceHttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice']
        index: 26
      deviceCodeableConcept: {type: CodeableConcept, short: Device coded, choiceOf: device, index: 27}
      deviceHttp://www:
        elements:
          xt-ehr:
            elements:
              eu/fhir/models/StructureDefinition/EHDSDevice: {type: 'http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice', short: Device coded, choiceOf: device, index: 28}
            required: [fhir/models/StructureDefinition/EHDSDevice]
    required: [device, deviceQuantity, deviceCodeableConcept]
package_version: 1.0.0
class: logical
kind: logical
url: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication
base: http://hl7.org/fhir/StructureDefinition/Base
version: 1.0.0