FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/be-model-medication-dispense

Packagehl7.fhir.be.medication
TypeStructureDefinition
Idbe-model-medication-dispense
FHIR VersionR4
Sourcehttps://www.ehealth.fgov.be/standards/fhir/medication/https://www.ehealth.fgov.be/standards/fhir/medication/1.0.0/StructureDefinition-be-model-medication-dispense.html
URLhttps://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-model-medication-dispense
Version1.0.0
Statusdraft
Date2021-06-28T13:54:34+02:00
NameBeModelMedicationDispense
Realmbe
Authorityhl7
DescriptionThis is the logical model for the Dispense Record entry - the information that can be captured upon the act of dispensing - in a hospital pharmacy, or a community pharmacy. This is not for a future dispense, rather a record of an actual dispense.
TypeBeModelMedicationDispense
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
be-organizationBeOrganization
be-patientBePatient
be-practitionerBePractitioner

Narrative

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. BeModelMedicationDispense 0..*ElementAn individual record of a medication dispense
... identifier 0..1IdentifierThe business identifier(s) for the medication dispense session
... patient 1..1Reference(BePatient)The person for which the medication is dispensed.
... dispenser 0..1Reference()The dispenser, if known and relevant
.... dispenser 1..1Reference(BePractitioner)Reference to person that performed the recording or reporting
.... organization 1..1Reference(BeOrganization)Reference to person that performed the recording or reporting
... dispenseDate 1..1dateTimeThe date when the dispense ocurred
... prescription 0..1BackboneElementThe information about a prescription related to the dispense
.... isPrescribed 0..1booleanWhether this dispense was performed against a prescription
.... prescription 0..1Reference()The prescription identification
... dispensedItem 0..*BackboneElementEach product that was dispensed
.... product 0..1Reference()The product that was dispensed - coded or not (e.g. for magistral preparations)
.... quantityDispensed 0..1QuantityThe amound of product that was dispensed
.... dosageInstructions 0..1DosageThe instructions for use
.... note 0..*AnnotationAdditional information about the dispensed item
... note 0..*AnnotationAdditional information about the dispense

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "be-model-medication-dispense",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/be-model-medication-dispense",
  "version": "1.0.0",
  "name": "BeModelMedicationDispense",
  "status": "draft",
  "date": "2021-06-28T13:54:34+02:00",
  "publisher": "eHealth Platform",
  "contact": [
    {
      "name": "eHealth Platform",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ehealth.fgov.be/standards/fhir"
        },
        {
          "system": "email",
          "value": "message-structure@ehealth.fgov.be"
        }
      ]
    },
    {
      "name": "Message Structure eHealth",
      "telecom": [
        {
          "system": "email",
          "value": "message-structure@ehealth.fgov.be",
          "use": "work"
        }
      ]
    }
  ],
  "description": "This is the logical model for the Dispense Record entry - the information that can be captured upon the act of dispensing - in a hospital pharmacy, or a community pharmacy. This is not for a future dispense, rather a record of an actual dispense.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "BE",
          "display": "Belgium"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "BeModelMedicationDispense",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "id": "BeModelMedicationDispense",
        "path": "BeModelMedicationDispense",
        "short": "An individual record of a medication dispense",
        "definition": "Base definition for all elements in a resource.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.id",
        "path": "BeModelMedicationDispense.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.extension",
        "path": "BeModelMedicationDispense.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional content defined by implementations",
        "definition": "May 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.",
        "comment": "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.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.identifier",
        "path": "BeModelMedicationDispense.identifier",
        "short": "The business identifier(s) for the medication dispense session",
        "definition": "The business identifier(s) for the medication dispense session, also known as Session GUID (SGUID).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.identifier",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.patient",
        "path": "BeModelMedicationDispense.patient",
        "short": "The person for which the medication is dispensed.",
        "definition": "The person for which the medication is dispensed.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.patient",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispenser",
        "path": "BeModelMedicationDispense.dispenser",
        "short": "The dispenser, if known and relevant",
        "definition": ".",
        "min": 0,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.dispenser",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispenser.dispenser",
        "path": "BeModelMedicationDispense.dispenser.dispenser",
        "short": "Reference to person that performed the recording or reporting",
        "definition": "Who was responsible for asserting the observed value as \"true\". (Reference)",
        "min": 1,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.dispenser.dispenser",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispenser.organization",
        "path": "BeModelMedicationDispense.dispenser.organization",
        "short": "Reference to person that performed the recording or reporting",
        "definition": "Who was responsible for asserting the observed value as \"true\". (Reference)",
        "min": 1,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.dispenser.organization",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispenseDate",
        "path": "BeModelMedicationDispense.dispenseDate",
        "short": "The date when the dispense ocurred",
        "definition": "The date (or date-time) when the dispense ocurred",
        "min": 1,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.dispenseDate",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/dateTime"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.prescription",
        "path": "BeModelMedicationDispense.prescription",
        "short": "The information about a prescription related to the dispense",
        "definition": ".",
        "min": 0,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.prescription",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.prescription.isPrescribed",
        "path": "BeModelMedicationDispense.prescription.isPrescribed",
        "short": "Whether this dispense was performed against a prescription",
        "definition": ".",
        "min": 0,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.prescription.isPrescribed",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.prescription.prescription",
        "path": "BeModelMedicationDispense.prescription.prescription",
        "short": "The prescription identification",
        "definition": ".",
        "min": 0,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.prescription.prescription",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem",
        "path": "BeModelMedicationDispense.dispensedItem",
        "short": "Each product that was dispensed",
        "definition": ".",
        "min": 0,
        "max": "*",
        "base": {
          "path": "BeModelMedicationDispense.dispensedItem",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem.product",
        "path": "BeModelMedicationDispense.dispensedItem.product",
        "short": "The product that was dispensed - coded or not (e.g. for magistral preparations)",
        "definition": ".",
        "min": 0,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.dispensedItem.product",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem.quantityDispensed",
        "path": "BeModelMedicationDispense.dispensedItem.quantityDispensed",
        "short": "The amound of product that was dispensed",
        "definition": ".",
        "min": 0,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.dispensedItem.quantityDispensed",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem.dosageInstructions",
        "path": "BeModelMedicationDispense.dispensedItem.dosageInstructions",
        "short": "The instructions for use",
        "definition": ".",
        "min": 0,
        "max": "1",
        "base": {
          "path": "BeModelMedicationDispense.dispensedItem.dosageInstructions",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Dosage"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem.note",
        "path": "BeModelMedicationDispense.dispensedItem.note",
        "short": "Additional information about the dispensed item",
        "definition": "Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "BeModelMedicationDispense.dispensedItem.note",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Annotation",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/Annotation"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.note",
        "path": "BeModelMedicationDispense.note",
        "short": "Additional information about the dispense",
        "definition": "Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "BeModelMedicationDispense.note",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Annotation",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/Annotation"
            ]
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "BeModelMedicationDispense",
        "path": "BeModelMedicationDispense",
        "short": "An individual record of a medication dispense",
        "min": 0,
        "max": "*"
      },
      {
        "id": "BeModelMedicationDispense.identifier",
        "path": "BeModelMedicationDispense.identifier",
        "short": "The business identifier(s) for the medication dispense session",
        "definition": "The business identifier(s) for the medication dispense session, also known as Session GUID (SGUID).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.patient",
        "path": "BeModelMedicationDispense.patient",
        "short": "The person for which the medication is dispensed.",
        "definition": "The person for which the medication is dispensed.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispenser",
        "path": "BeModelMedicationDispense.dispenser",
        "short": "The dispenser, if known and relevant",
        "definition": ".",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispenser.dispenser",
        "path": "BeModelMedicationDispense.dispenser.dispenser",
        "short": "Reference to person that performed the recording or reporting",
        "definition": "Who was responsible for asserting the observed value as \"true\". (Reference)",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispenser.organization",
        "path": "BeModelMedicationDispense.dispenser.organization",
        "short": "Reference to person that performed the recording or reporting",
        "definition": "Who was responsible for asserting the observed value as \"true\". (Reference)",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispenseDate",
        "path": "BeModelMedicationDispense.dispenseDate",
        "short": "The date when the dispense ocurred",
        "definition": "The date (or date-time) when the dispense ocurred",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/dateTime"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.prescription",
        "path": "BeModelMedicationDispense.prescription",
        "short": "The information about a prescription related to the dispense",
        "definition": ".",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.prescription.isPrescribed",
        "path": "BeModelMedicationDispense.prescription.isPrescribed",
        "short": "Whether this dispense was performed against a prescription",
        "definition": ".",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.prescription.prescription",
        "path": "BeModelMedicationDispense.prescription.prescription",
        "short": "The prescription identification",
        "definition": ".",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem",
        "path": "BeModelMedicationDispense.dispensedItem",
        "short": "Each product that was dispensed",
        "definition": ".",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem.product",
        "path": "BeModelMedicationDispense.dispensedItem.product",
        "short": "The product that was dispensed - coded or not (e.g. for magistral preparations)",
        "definition": ".",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem.quantityDispensed",
        "path": "BeModelMedicationDispense.dispensedItem.quantityDispensed",
        "short": "The amound of product that was dispensed",
        "definition": ".",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem.dosageInstructions",
        "path": "BeModelMedicationDispense.dispensedItem.dosageInstructions",
        "short": "The instructions for use",
        "definition": ".",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Dosage"
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.dispensedItem.note",
        "path": "BeModelMedicationDispense.dispensedItem.note",
        "short": "Additional information about the dispensed item",
        "definition": "Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Annotation",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/Annotation"
            ]
          }
        ]
      },
      {
        "id": "BeModelMedicationDispense.note",
        "path": "BeModelMedicationDispense.note",
        "short": "Additional information about the dispense",
        "definition": "Additional information about the dispense - this can be relevant history, any remarks by the patient or professional, etc.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Annotation",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/Annotation"
            ]
          }
        ]
      }
    ]
  }
}