FHIR IG Statistics: StructureDefinition/NLLDispensePaperPrescription.StructureDefinition

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "url": "http://electronichealth.se/fhir/StructureDefinition/NLLDispensePaperPrescription",
  "version": "1.2.0",
  "name": "NLLDispensePaperPrescription",
  "status": "active",
  "date": "2024-08-28",
  "publisher": "Swedish eHealth Agency",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "EHM",
      "uri": "http://ehalsomyndigheten.se",
      "name": "E-hälsomyndighetens internal model"
    },
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "rx-dispense-rmim",
      "uri": "http://www.hl7.org/v3/PORX_RM020070UV",
      "name": "V3 Pharmacy Dispense RMIM"
    },
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "MedicationDispense",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "MedicationDispense",
        "path": "MedicationDispense",
        "short": "A medication dispense to a specific patient authorzied by a paper prescription",
        "definition": "A dispense for a paper prescription is a medication dispense where the authorizing prescription is not registererd in the National Swedish Medication List but is instead made based on a prescription in paper format."
      },
      {
        "id": "MedicationDispense.id",
        "path": "MedicationDispense.id",
        "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.\r\nThis id is identified by the URI http://electronichealth.se/identifier/nllmedicationdispenseid in documentation and external systems.",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Logiskt id för uttag pappersrecept"
          }
        ]
      },
      {
        "id": "MedicationDispense.meta",
        "path": "MedicationDispense.meta",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.meta.versionId",
        "path": "MedicationDispense.meta.versionId",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Uttagsversion för uttag pappersrecept"
          }
        ]
      },
      {
        "id": "MedicationDispense.meta.security",
        "path": "MedicationDispense.meta.security",
        "mustSupport": true,
        "binding": {
          "strength": "extensible",
          "valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/security-labels"
        }
      },
      {
        "id": "MedicationDispense.meta.security.system",
        "path": "MedicationDispense.meta.security.system",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.meta.security.version",
        "path": "MedicationDispense.meta.security.version",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.meta.security.code",
        "path": "MedicationDispense.meta.security.code",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension",
        "path": "MedicationDispense.extension",
        "min": 1
      },
      {
        "id": "MedicationDispense.extension:nllDispatchId",
        "path": "MedicationDispense.extension",
        "sliceName": "nllDispatchId",
        "short": "The identifier of the dispatch in which the dispense was made",
        "definition": "Value is treated as an integer, i.e the String can only contain numbers.\r\nMay be entered by the pharmacy, otherwise it is calculated by the Swedish E-health Agency .",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLDispatchId"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Expeditions-id"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:nllNumberOfPackagesDispensed",
        "path": "MedicationDispense.extension",
        "sliceName": "nllNumberOfPackagesDispensed",
        "short": "Number of packages dspensed",
        "definition": "Number of packages dspensed",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLNumberOfPackagesDispensed"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Antal expedierade förpackningar"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:nllActorDispatchId",
        "path": "MedicationDispense.extension",
        "sliceName": "nllActorDispatchId",
        "short": "The identifier of the actors dispatch in which the dispense was made",
        "definition": "The identifier of the actors dispatch in which the dispense was made. Mandatory when creating a dispense for a paper prescription. Not present in all legacy data.",
        "comment": "Maximum string length: 12",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLActorDispatchId"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Aktörens expeditions-id"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:nllDispatchRowNo",
        "path": "MedicationDispense.extension",
        "sliceName": "nllDispatchRowNo",
        "short": "Identier for MedicationDispense within dispatch",
        "definition": "Used when communicationg an error or warning for a MedicationDispense within a dispatch. The DispatchRowNo (ExpeditionsRadNummer) uniquely identifies a MediationDispense within a dispatch.\r\nMandatory when creating a detached dispense.",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLDispatchRowNo"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Aktörens expeditionsradnummer"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:nllBenefitChoiceCode",
        "path": "MedicationDispense.extension",
        "sliceName": "nllBenefitChoiceCode",
        "short": "Benefit choice",
        "definition": "Type of benefit for the dispense. Only used for validation (input only).",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLBenefitChoiceCode"
            ]
          }
        ],
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/benefit-choices"
        },
        "mapping": [
          {
            "identity": "EHM",
            "map": "Förmånsval"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:nllPrescriptionDetails",
        "path": "MedicationDispense.extension",
        "sliceName": "nllPrescriptionDetails",
        "short": "Information from the authorizing prescription",
        "definition": "Information from the authorizing prescription",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionDetails"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriptionDate",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "nllPrescriptionDate",
        "definition": "Date when prescription was initially authored. <br>\r\nOnly used for validation (input only).",
        "comment": "_",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriber",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "nllPrescriber",
        "short": "Prescriber",
        "definition": "The prescriber as a contained Practitioner resource (confirming to the NLLPractitioner profile).",
        "comment": "_",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllRegistrationBasis",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "nllRegistrationBasis",
        "comment": "_",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllCountryCode",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "nllCountryCode",
        "short": "Deprecated. Country code",
        "definition": "NB! Deprecated, Practitioner.address.country should be used.\r\n\r\nCountry code, as defined on the authorizing prescription\r\nISO 3166-1 alpha-2\r\nExample: NO (Norway)",
        "comment": "Maximum string length: 2",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllSubstitutionAllowed",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "nllSubstitutionAllowed",
        "definition": "Indicates if medication may be substituted (sv: generisk substitution tillåten) <br>\r\nOnly used for validation (input only).",
        "comment": "_",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllFirstDispenseBefore",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "nllFirstDispenseBefore",
        "definition": "Not used for dose dispensed prescriptions\r\nThe first dispense must occur before this date. If not, the prescription is invalidated.<br>\r\nOnly used for validation (input only).",
        "comment": "_",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllPrescriptionDetails.extension:nllPrescriberCostCenter",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "nllPrescriberCostCenter",
        "short": "The prescribers cost center",
        "definition": "The prescribers cost center code when making the prescription. Used for benefit billing within the regions.",
        "comment": "Minimum string length: 3\r\nMaximum string length: 13",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllDispenseCrediting",
        "path": "MedicationDispense.extension",
        "sliceName": "nllDispenseCrediting",
        "definition": "Crediting details for a dispense. Only used when crediting a dispense.",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLDispenseCrediting"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllDispenseCrediting.extension:creditDate",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "creditDate",
        "comment": "_",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchId",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "creditDispatchId",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.extension:nllDispenseCrediting.extension:creditDispatchRowNo",
        "path": "MedicationDispense.extension.extension",
        "sliceName": "creditDispatchRowNo",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.status",
        "path": "MedicationDispense.status",
        "short": "cancelled | completed",
        "definition": "Note! Used in NLL when a dispense is cancelled (sv: uttaget backat eller krediterat).",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "http://electronichealth.se/fhir/ValueSet/medication-dispense-status"
        },
        "mapping": [
          {
            "identity": "EHM",
            "map": "Uttagsstatus"
          }
        ]
      },
      {
        "id": "MedicationDispense.medication[x]",
        "path": "MedicationDispense.medication[x]",
        "short": "Dispensed medication",
        "definition": "Identifies the medical product being prescribed. The codes used are Swedish NplId from medical product, NplPackId for medicine packages and Varunr for reimbursed consumables. \r\nFor a medicine package, both the NplId and the NplPackId shall be provided. Varunr is not allowed to use when prescribing a medication.\r\nFor a reimbursed consumable, only Varunr shall be provided.",
        "comment": "_",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "Swedish medicine packages and reimbursed consumables.",
          "valueSet": "http://electronichealth.se/fhir/ValueSet/medicines-consumables"
        }
      },
      {
        "id": "MedicationDispense.medication[x].coding",
        "path": "MedicationDispense.medication[x].coding",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.medication[x].coding:nplid",
        "path": "MedicationDispense.medication[x].coding",
        "sliceName": "nplid",
        "short": "NPL-id",
        "definition": "A unique identifier of a medical product according to \"Nationellt produktregister för läkemedel\" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)",
        "max": "1",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "NPL-id"
          }
        ]
      },
      {
        "id": "MedicationDispense.medication[x].coding:nplid.system",
        "path": "MedicationDispense.medication[x].coding.system",
        "min": 1,
        "fixedUri": "http://electronichealth.se/fhir/NamingSystem/nplid",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.medication[x].coding:nplid.code",
        "path": "MedicationDispense.medication[x].coding.code",
        "comment": "Maximum string length: 14",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.medication[x].coding:nplpackid",
        "path": "MedicationDispense.medication[x].coding",
        "sliceName": "nplpackid",
        "short": "NPL-pack-id",
        "definition": "A unique identifier of a medical product package according to \"Nationellt produktregister för läkemedel\" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)",
        "max": "1",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "NPL-pack-id"
          }
        ]
      },
      {
        "id": "MedicationDispense.medication[x].coding:nplpackid.system",
        "path": "MedicationDispense.medication[x].coding.system",
        "min": 1,
        "fixedUri": "http://electronichealth.se/fhir/NamingSystem/nplpackid",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.medication[x].coding:nplpackid.code",
        "path": "MedicationDispense.medication[x].coding.code",
        "comment": "Maximum string length: 14",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.medication[x].coding:varunr",
        "path": "MedicationDispense.medication[x].coding",
        "sliceName": "varunr",
        "short": "Varunummer",
        "definition": "A unique identifier of a medical consumable according to \"Nationellt produktregister för läkemedel\" provided by the Swedish Medical Products Agency (sv Läkemedelsverket)\r\nAlso a non-unique identifier of a medical product package.",
        "max": "1",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Varunummer"
          }
        ]
      },
      {
        "id": "MedicationDispense.medication[x].coding:varunr.system",
        "path": "MedicationDispense.medication[x].coding.system",
        "min": 1,
        "fixedUri": "http://electronichealth.se/fhir/NamingSystem/varunr",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.medication[x].coding:varunr.code",
        "path": "MedicationDispense.medication[x].coding.code",
        "comment": "Minimum string length: 6\r\nMaximum string length: 6",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.subject",
        "path": "MedicationDispense.subject",
        "short": "Which patient the dispense is for",
        "definition": "A patient with personal identification number (sv: personnummer) must be referenced, other cases must be handled by containing the patient resource.",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLPatient"
            ],
            "aggregation": [
              "contained",
              "referenced"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Patient"
          },
          {
            "identity": "EHM",
            "map": "Patientreferens"
          }
        ]
      },
      {
        "id": "MedicationDispense.authorizingPrescription",
        "path": "MedicationDispense.authorizingPrescription",
        "definition": "Indicates the medication order that is being dispensed against. In this profile, the authorizing prescription is always in paper form (current format)  and/or there is no electronic presecription in NLL to refer to (sv: uttag där underlaget är ett papper eller ett utländskt e-recept)",
        "max": "0"
      },
      {
        "id": "MedicationDispense.authorizingPrescription.reference",
        "path": "MedicationDispense.authorizingPrescription.reference",
        "max": "0"
      },
      {
        "id": "MedicationDispense.authorizingPrescription.identifier",
        "path": "MedicationDispense.authorizingPrescription.identifier",
        "max": "0"
      },
      {
        "id": "MedicationDispense.type",
        "path": "MedicationDispense.type",
        "short": "Standard packing fill, Dose dispensed fill or Trial fill",
        "definition": "Type is used for specifing if the dispense was a \"Standard packing fill\", \"Trial fill\" (startförpackning) or \"Dose dispensed fill\" in the Swedish National Medication List. (Trial fill is not used for dose dispensed fills).\r\nDose dispensed fill can no longer occur for a dispense of a paper prescription. The code DD will be removed from the value set used by this profile in a future release.",
        "min": 1,
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "Indicates the type of dispensing event that is performed, e.g. Standard packing fill, Trial fill or Dose dispense refill",
          "valueSet": "http://electronichealth.se/fhir/ValueSet/dispense-types"
        },
        "mapping": [
          {
            "identity": "EHM",
            "map": "Uttagstyp"
          }
        ]
      },
      {
        "id": "MedicationDispense.type.coding",
        "path": "MedicationDispense.type.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.type.coding.system",
        "path": "MedicationDispense.type.coding.system",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.type.coding.version",
        "path": "MedicationDispense.type.coding.version",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.type.coding.code",
        "path": "MedicationDispense.type.coding.code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.quantity",
        "path": "MedicationDispense.quantity",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Expedierad mängd"
          }
        ]
      },
      {
        "id": "MedicationDispense.quantity.value",
        "path": "MedicationDispense.quantity.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.whenHandedOver",
        "path": "MedicationDispense.whenHandedOver",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Expedieringstidpunkt"
          }
        ]
      },
      {
        "id": "MedicationDispense.dosageInstruction",
        "path": "MedicationDispense.dosageInstruction",
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.dosageInstruction.patientInstruction",
        "path": "MedicationDispense.dosageInstruction.patientInstruction",
        "comment": "Maximum string length: 1016",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Doseringsinstruktion"
          }
        ]
      },
      {
        "id": "MedicationDispense.substitution",
        "path": "MedicationDispense.substitution",
        "mustSupport": true
      },
      {
        "id": "MedicationDispense.substitution.wasSubstituted",
        "path": "MedicationDispense.substitution.wasSubstituted",
        "definition": "True if the dispenser dispensed a different drug or product from what was prescribed.\r\nOnly used for validation (input only).",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Generikautbyte utfört"
          }
        ]
      },
      {
        "id": "MedicationDispense.detectedIssue",
        "path": "MedicationDispense.detectedIssue",
        "short": "Automatic Format and Constitution Control warning (AFF varning)",
        "definition": "FOR FUTURE USE, SHOULD NOT BE USED!\r\nAccepted warnings can be provided when creating a MedicationDispense.\r\nAutomatic Format and Constitution Control (AFF) accepted by the pharmacist.\r\nNB! The DetectedIssues are never saved by the Swedish eHealth Agency.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://electronichealth.se/fhir/StructureDefinition/NLLDetectedIssue"
            ],
            "aggregation": [
              "contained"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "EHM",
            "map": "Accepterade varningar"
          }
        ]
      }
    ]
  }
}