The RED telematik API connects systems to E-Rezept-Fachdienst and provides functions to retrieve stored electronic prescriptions and to send dispense requests.
If a physician creates an electronic prescription the system sends prescription data to E-Rezept-Fachdienst. If data was received successfully E-Rezept-Fachdienst returns a PrescriptionID for each prescription. The PrescriptionID is represented by the datamatrix-barcode on the Patientenausdruck.
Example for a Patientenausdruck for a single prescription. The barcode represents a PrescriptionID and AccessCode for each prescription. The barcode contains a string containing an array of urls; each url is represented by a string with this format:
Task/<Prescription ID>/$accept?ac=<AccessCode>
The barcode for the example Patientenausdruck above contains a single prescription with this content:
{"urls":["Task/160.000.165.685.331.97/$accept?ac=ba7aa9a32005be428e644dd86ed2e09ac297ba352967354db4a348ccbbc6e1b2"]}
In this example the prescriptionID is 160.000.165.685.331.97 and AccessCode is ba7aa9a32005be428e644dd86ed2e09ac297ba352967354db4a348ccbbc6e1b2.
Accept prescription To fetch the prescription data from E-Rezept-Fachdienst and to lock the prescription an accept pescription request (GET) is sent to RED. A successful request requires
A SMC-B card for a pharmacy must be available in a card terminal accessible to RED and the card must have been authorized using the PIN code (see RED telematik API - Card Operations ) Routes to the E-Rezept-Fachdienst must have been set on the computer (10.30.0.0, 10.30.10.0, 10.30.11.0) The accept prescription request can be used for the initial fetch of prescription data as well as later requests to retrieve the same data. When the FHIR bundle initially is returned from Fachdienst a second access code (“secret”) is added. All further requests to Fachdienst (in order to retrieve prescription data again, cancel or dispense the prescription) must include this secret to prove the requesters authorization to access the data. RED stores the secret in its database and adds it automatically for every further processing action of this request.
The accept prescription request has this format
{{baseURL}}/{{tenant}}/Task?action=$accept&prescriptionid=prescriptionid&accesscode=accesscode
This request returns a FHIR bundle with several items.
Composition : contains summary information and references to all items in the bundle MedicationRequest : refers to Medication, patient, requester and insurance. Includes administrative information such as copayment, emergencyFee, substitution (aut-idem) or payer (BVG). Also contains the dosage and quantity Medication : contains data of prescribed product (e.g. PZN ID, flag vaccine, Normgröße, form and amount) Patient : person the prescription was created for, including insurance ID, name and address Practitioner : physician who created and signed the prescription, including LANR, name and qualification Organization : practice which created the prescription, including BSNR, address and contact Coverage : payer and insurance information, including insurance status, WOP, person group, copayment status, payer identification
Example for the prescriptionID from Patientenausdruck
{{baseURL}}/{{tenant}}/Task?action=$accept&prescriptionid=160.000.165.685.331.97&accesscode=ba7aa9a32005be428e644dd86ed2e09ac297ba352967354db4a348ccbbc6e1b2
FHIR response for the example request
<Bundle xmlns="http://hl7.org/fhir">
<id value="578fe7e8-292f-a038-32a4-d8374e7213b4"/>
<meta>
<lastUpdated value="2022-07-08T14:02:47+00:00"/>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle|1.0.2"/>
</meta>
<identifier>
<system value="https://gematik.de/fhir/NamingSystem/PrescriptionID"/>
<value value="160.000.165.685.331.97"/>
</identifier>
<type value="document"/>
<timestamp value="2022-07-08T14:02:47+00:00"/>
<entry>
<fullUrl value="https://localhost:8443/redclient/fhir/Composition/440bc108-c3ef-5f78-71e7-cdd9b2e7437d"/>
<resource>
<Composition>
<id value="440bc108-c3ef-5f78-71e7-cdd9b2e7437d"/>
<meta>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Composition|1.0.2"/>
</meta>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_FOR_Legal_basis">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_STATUSKENNZEICHEN"/>
<code value="00"/>
</valueCoding>
</extension>
<status value="final"/>
<type>
<coding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_FORMULAR_ART"/>
<code value="e16A"/>
</coding>
</type>
<subject>
<reference value="Patient/xmZOxwufC836v0iHirR7fPAxeuNAAdVA"/>
</subject>
<date value="2022-07-08"/>
<author>
<reference value="Practitioner/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB"/>
<type value="Practitioner"/>
</author>
<author>
<type value="Device"/>
<identifier>
<system value="https://fhir.kbv.de/NamingSystem/KBV_NS_FOR_Pruefnummer"/>
<value value="Y/400/1904/36/456"/>
</identifier>
</author>
<title value="elektronische Arzneimittelverordnung"/>
<custodian>
<reference value="Organization/yYJ1iAwyEocr1h2HJM0HWzGeWJMcjJrM"/>
</custodian>
<section>
<code>
<coding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_ERP_Section_Type"/>
<code value="Prescription"/>
</coding>
</code>
<entry>
<reference value="MedicationRequest/TqdFG59cm6UlMxOfVyCwqOgFPhamysb7"/>
</entry>
</section>
<section>
<code>
<coding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_ERP_Section_Type"/>
<code value="Coverage"/>
</coding>
</code>
<entry>
<reference value="Coverage/GQbsTANrFZRh2M12qP3SbH9Q2qFVGOfD"/>
</entry>
</section>
</Composition>
</resource>
</entry>
<entry>
<fullUrl value="https://localhost:8443/redclient/fhir/MedicationRequest/TqdFG59cm6UlMxOfVyCwqOgFPhamysb7"/>
<resource>
<MedicationRequest>
<id value="TqdFG59cm6UlMxOfVyCwqOgFPhamysb7"/>
<meta>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Prescription|1.0.2"/>
</meta>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_StatusCoPayment">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_ERP_StatusCoPayment"/>
<code value="0"/>
</valueCoding>
</extension>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_EmergencyServicesFee">
<valueBoolean value="false"/>
</extension>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_BVG">
<valueBoolean value="false"/>
</extension>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_Multiple_Prescription">
<extension url="Kennzeichen">
<valueBoolean value="false"/>
</extension>
</extension>
<status value="active"/>
<intent value="order"/>
<medicationReference>
<reference value="Medication/AzfmlAdvgT3xNMrZogYE3xBAUa3bCZgN"/>
</medicationReference>
<subject>
<reference value="Patient/xmZOxwufC836v0iHirR7fPAxeuNAAdVA"/>
</subject>
<authoredOn value="2022-07-08"/>
<requester>
<reference value="Practitioner/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB"/>
</requester>
<insurance>
<reference value="Coverage/GQbsTANrFZRh2M12qP3SbH9Q2qFVGOfD"/>
</insurance>
<dosageInstruction>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_DosageFlag">
<valueBoolean value="true"/>
</extension>
<text value="0-1-1-0"/>
</dosageInstruction>
<dispenseRequest>
<quantity>
<value value="1"/>
<system value="http://unitsofmeasure.org"/>
<code value="{Package}"/>
</quantity>
</dispenseRequest>
<substitution>
<allowedBoolean value="true"/>
</substitution>
</MedicationRequest>
</resource>
</entry>
<entry>
<fullUrl value="https://localhost:8443/redclient/fhir/Medication/AzfmlAdvgT3xNMrZogYE3xBAUa3bCZgN"/>
<resource>
<Medication>
<id value="AzfmlAdvgT3xNMrZogYE3xBAUa3bCZgN"/>
<meta>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_PZN|1.0.2"/>
</meta>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_Medication_Category">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_ERP_Medication_Category"/>
<code value="00"/>
</valueCoding>
</extension>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_Medication_Vaccine">
<valueBoolean value="false"/>
</extension>
<extension url="http://fhir.de/StructureDefinition/normgroesse">
<valueCode value="N1"/>
</extension>
<code>
<coding>
<system value="http://fhir.de/CodeSystem/ifa/pzn"/>
<code value="00634845"/>
</coding>
<text value="OMEPRAZOL 1A PHARMA 10MG 30St N1"/>
</code>
<form>
<coding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM"/>
<code value="HKM"/>
</coding>
</form>
<amount>
<numerator>
<value value="30"/>
<unit value="St"/>
</numerator>
<denominator>
<value value="1"/>
</denominator>
</amount>
</Medication>
</resource>
</entry>
<entry>
<fullUrl value="https://localhost:8443/redclient/fhir/Patient/xmZOxwufC836v0iHirR7fPAxeuNAAdVA"/>
<resource>
<Patient>
<id value="xmZOxwufC836v0iHirR7fPAxeuNAAdVA"/>
<meta>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_FOR_Patient|1.0.3"/>
</meta>
<identifier>
<type>
<coding>
<system value="http://fhir.de/CodeSystem/identifier-type-de-basis"/>
<code value="GKV"/>
</coding>
</type>
<system value="http://fhir.de/NamingSystem/gkv/kvid-10"/>
<value value="X574647564"/>
</identifier>
<name>
<use value="official"/>
<family value="Naumann">
<extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
<valueString value="Naumann"/>
</extension>
</family>
<given value="Luca"/>
</name>
<birthDate value="2008-05-22"/>
<address>
<type value="both"/>
<line value="Anhalter Strasse 27">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
<valueString value="Anhalter Strasse"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
<valueString value="27"/>
</extension>
</line>
<city value="Neuleiningen"/>
<postalCode value="67271"/>
<country value="D"/>
</address>
</Patient>
</resource>
</entry>
<entry>
<fullUrl value="https://localhost:8443/redclient/fhir/Practitioner/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB"/>
<resource>
<Practitioner>
<id value="wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB"/>
<meta>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_FOR_Practitioner|1.0.3"/>
</meta>
<identifier>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="LANR"/>
</coding>
</type>
<system value="https://fhir.kbv.de/NamingSystem/KBV_NS_Base_ANR"/>
<value value="362364901"/>
</identifier>
<name>
<use value="official"/>
<family value="More">
<extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
<valueString value="More"/>
</extension>
</family>
<given value="Annie"/>
<prefix value="Dr. med.">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier">
<valueCode value="AC"/>
</extension>
</prefix>
</name>
<qualification>
<code>
<coding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_FOR_Qualification_Type"/>
<code value="00"/>
</coding>
</code>
</qualification>
<qualification>
<code>
<text value="Allgemeinmedizin"/>
</code>
</qualification>
</Practitioner>
</resource>
</entry>
<entry>
<fullUrl value="https://localhost:8443/redclient/fhir/Organization/yYJ1iAwyEocr1h2HJM0HWzGeWJMcjJrM"/>
<resource>
<Organization>
<id value="yYJ1iAwyEocr1h2HJM0HWzGeWJMcjJrM"/>
<meta>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_FOR_Organization|1.0.3"/>
</meta>
<identifier>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="BSNR"/>
</coding>
</type>
<system value="https://fhir.kbv.de/NamingSystem/KBV_NS_Base_BSNR"/>
<value value="478818100"/>
</identifier>
<name value="RED Medical Systems"/>
<telecom>
<system value="phone"/>
<value value="0171 1014211"/>
</telecom>
<telecom>
<system value="fax"/>
<value value="06431 44672"/>
</telecom>
<telecom>
<system value="email"/>
<value value="aw@redmedical.de"/>
</telecom>
<address>
<type value="both"/>
<line value="Hauptstrasse 180">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
<valueString value="Hauptstrasse"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
<valueString value="180"/>
</extension>
</line>
<city value="Bendorf"/>
<postalCode value="56170"/>
<country value="D"/>
</address>
</Organization>
</resource>
</entry>
<entry>
<fullUrl value="https://localhost:8443/redclient/fhir/Coverage/GQbsTANrFZRh2M12qP3SbH9Q2qFVGOfD"/>
<resource>
<Coverage>
<id value="GQbsTANrFZRh2M12qP3SbH9Q2qFVGOfD"/>
<meta>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_FOR_Coverage|1.0.3"/>
</meta>
<extension url="http://fhir.de/StructureDefinition/gkv/versichertenart">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_VERSICHERTENSTATUS"/>
<code value="1"/>
</valueCoding>
</extension>
<extension url="http://fhir.de/StructureDefinition/gkv/wop">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_ITA_WOP"/>
<code value="51"/>
</valueCoding>
</extension>
<extension url="http://fhir.de/StructureDefinition/gkv/besondere-personengruppe">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_PERSONENGRUPPE"/>
<code value="00"/>
</valueCoding>
</extension>
<extension url="http://fhir.de/StructureDefinition/gkv/dmp-kennzeichen">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DMP"/>
<code value="00"/>
</valueCoding>
</extension>
<status value="active"/>
<type>
<coding>
<system value="http://fhir.de/CodeSystem/versicherungsart-de-basis"/>
<code value="GKV"/>
</coding>
</type>
<beneficiary>
<reference value="Patient/xmZOxwufC836v0iHirR7fPAxeuNAAdVA"/>
</beneficiary>
<period>
<end value="2022-09-30"/>
</period>
<payor>
<identifier>
<system value="http://fhir.de/NamingSystem/arge-ik/iknr"/>
<value value="103067994"/>
</identifier>
<display value="DAK-GESUNDHEIT"/>
</payor>
</Coverage>
</resource>
</entry>
<entry>
<fullUrl value="https://erp-ref.zentral.erp.splitdns.ti-dienste.de/Task/160.000.165.685.331.97"/>
<resource>
<Task>
<id value="160.000.165.685.331.97"/>
<meta>
<profile value="https://gematik.de/fhir/StructureDefinition/ErxTask|1.1.1"/>
</meta>
<extension url="https://gematik.de/fhir/StructureDefinition/PrescriptionType">
<valueCoding>
<system value="https://gematik.de/fhir/CodeSystem/Flowtype"/>
<code value="160"/>
<display value="Muster 16 (Apothekenpflichtige Arzneimittel)"/>
</valueCoding>
</extension>
<extension url="https://gematik.de/fhir/StructureDefinition/ExpiryDate">
<valueDate value="2022-10-08"/>
</extension>
<extension url="https://gematik.de/fhir/StructureDefinition/AcceptDate">
<valueDate value="2022-08-05"/>
</extension>
<identifier>
<use value="official"/>
<system value="https://gematik.de/fhir/NamingSystem/PrescriptionID"/>
<value value="160.000.165.685.331.97"/>
</identifier>
<identifier>
<use value="official"/>
<system value="https://gematik.de/fhir/NamingSystem/AccessCode"/>
<value value="ba7aa9a32005be428e644dd86ed2e09ac297ba352967354db4a348ccbbc6e1b2"/>
</identifier>
<identifier>
<use value="official"/>
<system value="https://gematik.de/fhir/NamingSystem/Secret"/>
<value value="19e68f8669533dc16048fe09c55e01bb3cf0f7178f013e92cb23bb5a2826e723"/>
</identifier>
<status value="in-progress"/>
<intent value="order"/>
<for>
<identifier>
<system value="http://fhir.de/NamingSystem/gkv/kvid-10"/>
<value value="X574647564"/>
</identifier>
</for>
<authoredOn value="2022-07-08T12:02:46.764+00:00"/>
<lastModified value="2022-08-05T11:36:34.950+00:00"/>
<performerType>
<coding>
<system value="urn:ietf:rfc:3986"/>
<code value="urn:oid:1.2.276.0.76.4.54"/>
<display value="Öffentliche Apotheke"/>
</coding>
<text value="Öffentliche Apotheke"/>
</performerType>
<input>
<type>
<coding>
<system value="https://gematik.de/fhir/CodeSystem/Documenttype"/>
<code value="1"/>
</coding>
</type>
<valueReference>
<reference value="a05328e0-0900-0000-0001-000000000000"/>
</valueReference>
</input>
</Task>
</resource>
</entry>
<entry>
<fullUrl value="urn:uuid:a05328e0-0900-0000-0001-000000000000"/>
<resource>
<Binary>
<id value="a05328e0-0900-0000-0001-000000000000"/>
<meta>
<versionId value="1"/>
<profile value="https://gematik.de/fhir/StructureDefinition/ErxBinary|1.1.1"/>
</meta>
<contentType value="application/pkcs7-mime"/>
<data value="MIAGCSqGSIb3DQEHAqCAMIACAQUxDzANBglghkgBZQMEA...DVuCBBsKBdM3nJBv5euhAAAAAAAAAA== "/>
</Binary>
</resource>
</entry>
</Bundle>
Reject Prescription After the pharmacy has requested an electronic prescription from Fachdienst and received the FHIR bundle the Fachdienst locks the prescription to prevent others from fetching and claiming the same data. If the pharmacy is not able to deliver the prescribed products the prescription must be rejected in order to allow others to access the prescription.
To return a prescription a reject prescription request (GET) is sent. RED automatically includes the secret in addition to PrescriptionID and AccessCode.
{{baseURL}}/{{tenant}}/Task?action=$reject&prescriptionid=prescriptionid&accesscode=accesscode
A successful rejection returns a status 204.
Example for the prescriptionID from Patientenausdruck
{{baseURL}}/{{tenant}}/Task?action=$reject&prescriptionid=160.000.165.685.331.97&accesscode=ba7aa9a32005be428e644dd86ed2e09ac297ba352967354db4a348ccbbc6e1b2
Dispense a prescription After a pharmacy has dispenses the prescription a dispense request (POST) must be created and sent to the Fachdienst. The dispense request contains a FHIR bundle of type MedicationDispense.
{{baseURL}}/{{tenant}}/Bundle
Example for a FHIR medication dispense bundle
<Bundle xmlns="http://hl7.org/fhir">
<id value="10000"/>
<type value="history"/>
<entry>
<resource>
<MedicationDispense xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://gematik.de/fhir/StructureDefinition/ErxMedicationDispense|1.1.1" />
</meta>
<contained>
<Medication>
<id value="med0314"/>
<meta>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_PZN|1.0.2" />
</meta>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_Medication_Category">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_ERP_Medication_Category" />
<code value="00" />
</valueCoding>
</extension>
<extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_ERP_Medication_Vaccine">
<valueBoolean value="false" />
</extension>
<code>
<coding>
<system value="http://fhir.de/CodeSystem/ifa/pzn" />
<code value="10203626" />
</coding>
<text value="ASPIRIN 500MG UEBERZ TABL UTA 40 St" />
</code>
<form>
<coding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" />
<code value="UTA" />
</coding>
</form>
<amount>
<numerator>
<value value="40"/>
<unit value="St"/>
</numerator>
<denominator>
<value value="1"/>
</denominator>
</amount>
</Medication>
</contained>
<identifier>
<system value="https://gematik.de/fhir/NamingSystem/PrescriptionID" />
<value value="4148e6c9-1dde-11b2-8184-2b73493abeca" />
</identifier>
<status value="completed"/>
<medicationReference>
<reference value="#med0314"/>
<display value="ASPIRIN 500MG UEBERZ TABL UTA 40 St"/>
</medicationReference>
<subject>
<identifier>
<system value="http://fhir.de/NamingSystem/gkv/kvid-10" />
<value value="F852380883" />
</identifier>
</subject>
<performer>
<actor>
<identifier>
<system value="https://gematik.de/fhir/NamingSystem/TelematikID" />
<value value="SMBC" />
</identifier>
</actor>
</performer>
<quantity>
<value value="1" />
<system value="http://unitsofmeasure.org" />
<code value="{Package}" />
</quantity>
<whenHandedOver value="2020-03-23"/>
<dosageInstruction>
<text value="1-0-1-0" />
</dosageInstruction>
</MedicationDispense>
</resource>
</entry>
</Bundle>
