Implementation Guide
ePA Medication Service
Version 1.0.5-ballot.1 - draft

: Cancel Dispensation eRP - JSON Representation

Draft as of 2025-02-14

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "cancel-dispensation-erp-OP",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition cancel-dispensation-erp-OP</b></p><a name=\"cancel-dispensation-erp-OP\"> </a><a name=\"hccancel-dispensation-erp-OP\"> </a><a name=\"cancel-dispensation-erp-OP-en-US\"> </a><p>URL: [base]/$cancel-dispensation-erp</p><p>Input parameters Profile:<a href=\"StructureDefinition-epa-op-cancel-dispensation-erp-input-parameters.html\">EPA Operation CancelDispensation ERP Input-Parameters</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-epa-op-rx-dispensation-erp-output-parameters.html\">EPA Operation RxDispensation ERP Output-Parameters</a></p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>rxDispensation</td><td/><td>1..*</td><td></td><td/><td/></tr><tr><td>IN</td><td>rxDispensation.prescriptionId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td/></tr><tr><td>IN</td><td>rxDispensation.authoredOn</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td/></tr><tr><td>OUT</td><td>rxDispensation</td><td/><td>1..*</td><td></td><td/><td/></tr><tr><td>OUT</td><td>rxDispensation.prescriptionId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td/></tr><tr><td>OUT</td><td>rxDispensation.authoredOn</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td/></tr><tr><td>OUT</td><td>rxDispensation.operationOutcome</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td/></tr></table></div>"
  },
  "url" : "https://gematik.de/fhir/epa-medication/OperationDefinition/cancel-dispensation-erp-OP",
  "version" : "1.0.5-ballot.1",
  "name" : "Cancel Dispensation eRP",
  "title" : "Cancel Dispensation eRP",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2025-02-14",
  "publisher" : "gematik GmbH",
  "contact" : [
    {
      "name" : "gematik GmbH",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.gematik.de"
        },
        {
          "system" : "email",
          "value" : "patientteam [ at ] gematik.de"
        }
      ]
    }
  ],
  "description" : "The Cancel Dispensation eRP operation, used by the E-Rezept-Fachdienst, in the context of the ePA Medication Service, is applied to cancel or reverse information regarding the dispensation of a medication. This operation is necessary when a medication dispensation is cancelled by a pharmacist or when there is a return of the medication by the insurant. After the E-Rezept-Fachdienst performs this operation, the corresponding dispensation entry for the medication in the patient's ePA is marked as cancelled, which the goal in ensuring an accurate and up-to-date record of the patient's medication data.",
  "code" : "cancel-dispensation-erp",
  "system" : true,
  "type" : false,
  "instance" : false,
  "inputProfile" : "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-cancel-dispensation-erp-input-parameters",
  "outputProfile" : "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-rx-dispensation-erp-output-parameters",
  "parameter" : [
    {
      "name" : "rxDispensation",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "part" : [
        {
          "name" : "prescriptionId",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "type" : "Identifier"
        },
        {
          "name" : "authoredOn",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "type" : "date"
        }
      ]
    },
    {
      "name" : "rxDispensation",
      "use" : "out",
      "min" : 1,
      "max" : "*",
      "part" : [
        {
          "name" : "prescriptionId",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "type" : "Identifier"
        },
        {
          "name" : "authoredOn",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "type" : "date"
        },
        {
          "name" : "operationOutcome",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "type" : "OperationOutcome"
        }
      ]
    }
  ]
}