This API defines an interface between a Pharmacy System and a Pharmacy App with eHealth-CardLink service as intermediary, which is used to present the essential parts of a set of available prescriptions and allows to select electronic prescriptions for dispensation and delivery.
Websocket Server
Receive request to list available prescriptions from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service
Available only on servers:
webSocketId
Version of the API required by the client
Additional properties are allowed.
Accepts the following message:
Receive request to list available prescriptions from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service
List of available prescriptions
The ICCSNs for which to request prescriptions, or all ICCNs known to the server if the array is empty or absent.
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
requestPrescriptionList with a single eHealth card (ICCSN) message
{
"type": "requestPrescriptionList",
"ICCSN": [
"MTIzNDU2Nzg5"
],
"messageId": "df094bd9-4669-458a-b47f-8330e8254306"
}
requestPrescriptionList with all connected eHealth cards (ICCSNs) message
{
"type": "requestPrescriptionList",
"messageId": "df094bd9-4669-458a-b47f-8330e8254306"
}
Send list of available prescriptions from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service
Available only on servers:
webSocketId
Version of the API required by the client
Additional properties are allowed.
Accepts the following message:
Send list of available prescriptions from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service
List of available prescription lists
List of available prescriptions
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
The prescriptionBundle element is the bundling element used for electronic prescriptions, which is derived from the Bundle resource and contains all other data elements. See section A.3.10 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Indicates the time at which the e-prescription bundle was created.
Contains the status code of the electronic prescription. The intended values can be found in the key table S_KBV_STATUSKENNZEICHEN.
In the case of a private prescription, contains information on the PKV tariff according to KBV_EX_FOR_PKV_Tariff.
This element contains information about the health insurance of the patient. See section A.3.1 of specification.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are admissible: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institutional code (IK) of the responsible health insurance company, e.g. according to the electronic health card (eGK).
This field contains the institutional code (IK) of the cost carrier and is used if the cost carrier is not the responsible health insurance fund, e.g. a professional association (BG) or an accident insurance fund (UK).
Name of the cost carrier.
This field contains the place of residence code according to the place of residence principle (WOP) for fee agreements (BMV-Ä Annex 21). The intended values can be found in the key table S_ITA_WOP.
This element contains information on the insured person's status. According to the German Basis Guide (STU3), the following values are provided: "1" (members), "3" (family members), "5" (pensioners).}
This field contains the special group of people to which the insured person belongs (§ 264 SGB V). The corresponding values can be found in the key table S_KBV_PERSONENGRUPPE.
This field contains the disease management program (DMP) in which the insured person is enrolled (Section 284, Paragraph 1, Sentence 1, No. 14 SGB V). The intended values can be found in the key table S_KBV_DMP.
In this field, the date of the end of insurance coverage can be entered if the date is stored on the insurance card and has been read.
Additional properties are allowed.
Element containing the data of a patient. See section A.3.4 of specification.
This field contains the insured person ID of the statutory health insurance (unchangeable part of the uniform health insurance number of the GKV according to Section 290 SGB V).
This field contains the insured ID of the private health insurance (unchangeable part of the uniform health insurance number according to Section 290 SGB V).
This field contains the insurance number of the health insurance card (Krankenversichertenkarte).
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
This field contains either the street address (streetAddress) or the postal box address (pobAddress) of the patient.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Element containing the mailbox address of the respective person. See section A.3.5 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The mailbox can be specified in this field.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
This field contains a type to identify the prescribing person, e.g. doctor, doctor in training. The intended values can be found in the key table KBV_CS_FOR_Qualification_Type.
This field contains free text information about the job title, e.g. specialist in general medicine, general practitioner, midwife.
This field contains the ASV specialist group number (ASV-FGN, Fachgruppen-Nummer für Ambulante Spezialärztliche Versorgung) according to the Agreement on Outpatient Specialist Medical Care (ASV) (ASV-AV) Section 9 Paragraph 5. According to the ASV-AV, this must be stated by hospital doctors instead of the doctor number.
This field contains a doctor number (lifetime doctor number, LANR, Lebenslange Arztnummer) as an identifier for the practitioner.
This field contains a dentist number (ZANR) as an identifier for the person.
This field contains a telematics ID as an identifier for the person.
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
Additional properties are allowed.
Contains the verification number of the practice management system with which the electronic prescription was created.
Element containing the data of an organization. See section A.3.3 of specification.
This field contains a business location number (Betriebsstättennummer, BSNR) to identify a facility. In the statutory health insurance sector, the field is a prerequisite for billing between service providers and cost bearers. The BSNR must be specified for hospitals. In the context of hospital treatment, this field can show the place of issue.
This field contains an institutional code (IK), which is assigned by the ARGE IK and is a unique identifier for billing with the social insurance providers.
This field contains a billing number from the Association of Statutory Health Insurance Dentists (KZV).
This field contains a hospital location number.
This field contains a telematics ID of the facility.
This field contains the name of the facility (practice / hospital).
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
This field contains the phone number of the facility.
This field contains the fax number of the facility.
This field contains the email address of the institution. This must be provided when redeeming a drug prescription across borders.
Additional properties are allowed.
This element can be used to indicate whether the prescribing physician has another role in the area of outpatient specialist care (Ambulante Spezialärztliche Versorgung, ASV). This field must be used in the context of outpatient specialist medical care. Each ASV team receives an ASV team number (ASV-TN) from the ASV service center. ASV doctors use this number to identify the services or prescriptions they provide in the ASV. The team number consists of nine digits and is structured like a business location number (BSNR). It is assigned as soon as the doctors have ASV authorization - in addition to the BSNR and the lifelong doctor number.
Contains further information on the electronic prescription. The prescription element is specified in section A.3.10 and the practiceSupply element is specified in section A.3.7.
The prescription element represents the technically and medically relevant components of a drug prescription. See section A.3.9 of specification.
This field contains the date of issue of the regulation.
This field contains the indication whether this prescription should also be delivered during general store closing times, combined with the collection of the Noctu fee (emergency service fee) at the expense of the health insurance company in accordance with the Drug Price Ordinance.
This field indicates whether this regulation is issued for persons entitled to benefits under the Federal Compensation Act (Bundesentschädigungsgesetz, BEG) or for persons entitled to benefits under the Federal Social Security Act (Bundesversorgungsgesetz, BVG).
This field specifies the co-payment status for the prescription. According to KBV_CS_FOR_StatusCoPayment the following options are available: 0 (not exempt from co-payment / subject to fees), 1 (exempt from co-payment / free of charge), 2 (artificial insemination (regulation according to Section 27a SGB V)).
This field indicates whether the medicine is interchangeable or not. If an exchange is allowed in the pharmacy, this field is set to true.
This field contains additional / other dispensing instructions for the pharmacy beyond the dosage.
This field contains the number of packs prescribed.
This field contains a dosage identifier and describes whether a dosage instruction or a medication plan is being transmitted.
This field contains dosing instructions.
This field contains the instructions for use of the recipe.
This field contains the information about the context in which the prescription was issued, e.g. accident. The possible values are specified in KBV_VS_ERP_Accident_Type. The following cases are provided: 1 (accident), 2 (work accident (professional association/accident insurance fund)), 4 (occupational disease (professional association/accident insurance fund)).
Day of accident.
Accident organisation.
This field indicates whether the prescription is a multiple prescription (Mehrfachverordnung, MFV).
This field contains a unique ID which is identical across all partial prescriptions of a multiple prescription.
This field contains the information about the partial prescription of a multiple prescription (series). Example: "2" in "2 of 4".
This field contains the length of this series, i.e. the total number of partial prescriptions of the multiple prescription. Example: "4" in "2 of 4".
This field contains the date from which the partial prescription of the multiple prescription can be redeemed.
This field contains the date of the last redemption day of the partial prescription of the multiple prescription. The issuing person can specify a redemption period that differs from the Drug Prescription Ordinance (Arzneimittelverschreibungsverordnung, AMVV).
Additional properties are allowed.
The practiceSupply element is used to prescribe practice supplies. See section A.3.7 of specification.
This field contains the date of issue of the prescription for practice supply.
This field contains the number of packs prescribed.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are expected: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institution code (IK) according to the electronic health card (eGK). See the transfer rule according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.2).
This field contains the name of the cost carrier. The correct name is derived from the defined rules according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.3).
Additional properties are allowed.
Additional properties are allowed.
Element containing a medication item, whereas the medication element may either be medicationPZN, medicationIngredient, medicationCompounding, medicationFreeText. See section A.3.2 of specification.
Prescription of standardised medication, which is identified by PZN. See section A.3.2.1 of specification.
This field contains the information on the dosage form according to the data in § 131 (4) SGB V, and must always be used when a finished medicinal product is prescribed in accordance with the price and product list. The key table for displaying the coded values is maintained by the KBV and is available in the coding table S_KBV_DARREICHUNGSFORM.
Contains the norm size of the prescription.
Is the identifier of the standardised prescription (Pharmazentralnummer, PZN).
Is the name of the standardised prescription.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by its ingredients. See section A.3.2.2 of specification.
Contains the norm size of the prescription.
This field contains the dosage form as free text and can be used if the product is not a finished medicinal product.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
List of ingredients
Medication, which is defined by its ingredients.
ASK-Number (Arzneimittelkatalog-Nummer).
Name of the ingredient.
Contains the strength of the ingredient.
Unit of strength of the ingredient.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by a specific recipe. See section A.3.2.3 of specification.
Contains instructions for the preparation of the recipe.
Describes the packaging of the medication.
Contains the name of the recipe.
This field contains the dosage form of the prescription as free text and can be used if the component of the prescription is not a finished medicinal product.
Contains the total quantity of the prescription.
Unit corresponding to the total quantity of the prescription.
List of ingredients
Medication, which is defined by a specific recipe.
Contains the description how to apply the specific part of the medication.
Name of the specific part of the medication.
Identifier (Pharmazentralnummer, PZN) of the specific part of the medication.
Quantity of the specific part of the medication.
Unit corresponding to the specific part of the medication.
Contains a free text to describe the quantity of the specific part of the medication including its unit.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of a medication, which is described by a free text. See section A.3.2.4 of specification.
Contains a free text, which describes the prescribed medication.
This field contains the dosage form of the prescription as free text.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
availablePrescriptionLists message
{
"type": "availablePrescriptionLists",
"availablePrescriptionLists": [
{
"type": "availablePrescriptionList",
"ICCSN": "MTIzNDU2Nzg5",
"prescriptionBundleList": [
{
"prescriptionId": "160.000.764.737.300.50",
"erstellungszeitpunkt": "2024-06-30T09:30:00.000Z",
"status": "final",
"krankenversicherung": {
"kostentraegertyp": "GKV",
"ikKrankenkasse": 104212059,
"kostentraeger": "AOK Baden-Württemberg",
"wop": 52,
"versichertenstatus": 1,
"besonderePersonengruppe": 0,
"dmpKz": 0
},
"patient": {
"gkvVersichertenId": "X234567891",
"person": {
"vorname": "Tina",
"name": "Tester"
},
"geburtsdatum": "1985-05-05T00:00:00.000Z",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 42
}
},
"arzt": {
"typ": 0,
"berufsbezeichnung": "Hausarzt",
"arztnummer": 838382202,
"person": {
"vorname": "Hans",
"nachname": "Gesundmacher",
"titel": "Dr. med."
}
},
"pruefnummer": "Y/400/1910/36/346",
"organisation": {
"bsnr": 31234567,
"name": "Hausarztpraxis Dr. Gesundmacher",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 200
},
"telefon": "+49 711 1234567",
"fax": "+49 711 1234599",
"eMail": "hans@praxis-gesundmacher.de"
},
"verordnung": {
"ausstellungsdatum": "2024-06-30T00:00:00.000Z",
"noctu": false,
"bvg": false,
"zuzahlungsstatus": 0,
"autidem": true,
"abgabehinweis": "Vor Zugriff durch Kinder schützen.",
"anzahl": 1,
"dosierung": true,
"dosieranweisung": "1-0-1"
},
"arzneimittel": {
"type": "medicationPZN",
"kategorie": 0,
"impfstoff": false,
"normgroesse": "N3",
"pzn": 38706,
"handelsname": "Amoxicillin Al 1000",
"darreichungsform": "TAB",
"packungsgroesseNachMenge": 30,
"einheit": "TAB"
}
},
{
"prescriptionId": "160.100.000.000.012.06",
"erstellungszeitpunkt": "2024-06-30T09:35:00.000Z",
"status": "final",
"krankenversicherung": {
"kostentraegertyp": "GKV",
"ikKrankenkasse": 104212059,
"kostentraeger": "AOK Baden-Württemberg",
"wop": 52,
"versichertenstatus": 1,
"besonderePersonengruppe": 0,
"dmpKz": 0
},
"patient": {
"gkvVersichertenId": "X234567891",
"person": {
"vorname": "Tina",
"name": "Tester"
},
"geburtsdatum": "1985-05-05T00:00:00.000Z",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 42
}
},
"arzt": {
"typ": 0,
"berufsbezeichnung": "Hausarzt",
"arztnummer": 838382202,
"person": {
"vorname": "Hans",
"nachname": "Gesundmacher",
"titel": "Dr. med."
}
},
"pruefnummer": "Y/400/1910/36/346",
"organisation": {
"bsnr": 31234567,
"name": "Hausarztpraxis Dr. Gesundmacher",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 200
},
"telefon": "+49 711 1234567",
"fax": "+49 711 1234599",
"eMail": "hans@praxis-gesundmacher.de"
},
"verordnung": {
"ausstellungsdatum": "2024-06-30T00:00:00.000Z",
"noctu": false,
"bvg": false,
"zuzahlungsstatus": 0,
"autidem": true,
"abgabehinweis": "Vor Zugriff durch Kinder schützen.",
"anzahl": 1,
"dosierung": true,
"dosieranweisung": "1-0-1"
},
"arzneimittel": {
"type": "medicationPZN",
"kategorie": 0,
"impfstoff": false,
"normgroesse": "N3",
"pzn": 232199,
"handelsname": "Simva Basics 10mg",
"darreichungsform": "TAB",
"packungsgroesseNachMenge": 100,
"einheit": "TAB"
}
},
{
"prescriptionId": "160.100.000.000.004.30",
"erstellungszeitpunkt": "2024-06-30T09:40:00.000Z",
"status": "final",
"krankenversicherung": {
"kostentraegertyp": "GKV",
"ikKrankenkasse": 104212059,
"kostentraeger": "AOK Baden-Württemberg",
"wop": 52,
"versichertenstatus": 1,
"besonderePersonengruppe": 0,
"dmpKz": 0
},
"patient": {
"gkvVersichertenId": "X234567891",
"person": {
"vorname": "Tina",
"name": "Tester"
},
"geburtsdatum": "1985-05-05T00:00:00.000Z",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 42
}
},
"arzt": {
"typ": 0,
"berufsbezeichnung": "Hausarzt",
"arztnummer": 838382202,
"person": {
"vorname": "Hans",
"nachname": "Gesundmacher",
"titel": "Dr. med."
}
},
"pruefnummer": "Y/400/1910/36/346",
"organisation": {
"bsnr": 31234567,
"name": "Hausarztpraxis Dr. Gesundmacher",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 200
},
"telefon": "+49 711 1234567",
"fax": "+49 711 1234599",
"eMail": "hans@praxis-gesundmacher.de"
},
"verordnung": {
"ausstellungsdatum": "2024-06-30T00:00:00.000Z",
"noctu": false,
"bvg": false,
"zuzahlungsstatus": 0,
"autidem": true,
"abgabehinweis": "Vor Zugriff durch Kinder schützen.",
"anzahl": 1,
"dosierung": true,
"dosieranweisung": "1-0-0"
},
"arzneimittel": {
"type": "medicationIngredient",
"kategorie": 0,
"impfstoff": false,
"normgroesse": "N3",
"darreichungsform": "Tabletten",
"packungsgroesseNachMenge": 100,
"einheit": "Stück",
"listeBestandteilWirkstoffverordnung": [
{
"type": "bestandteilWirkstoffverordnung",
"wirkstoffnummer": 22686,
"wirkstoffname": "Ramipril",
"wirkstaerke": 5,
"wirkstaerkeneinheit": "mg"
}
]
}
},
{
"prescriptionId": "160.100.000.000.014.97",
"erstellungszeitpunkt": "2024-06-30T09:45:00.000Z",
"status": "final",
"krankenversicherung": {
"kostentraegertyp": "GKV",
"ikKrankenkasse": 104212059,
"kostentraeger": "AOK Baden-Württemberg",
"wop": 52,
"versichertenstatus": 1,
"besonderePersonengruppe": 0,
"dmpKz": 0
},
"patient": {
"gkvVersichertenId": "X234567891",
"person": {
"vorname": "Tina",
"name": "Tester"
},
"geburtsdatum": "1985-05-05T00:00:00.000Z",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 42
}
},
"arzt": {
"typ": 0,
"berufsbezeichnung": "Hausarzt",
"arztnummer": 838382202,
"person": {
"vorname": "Hans",
"nachname": "Gesundmacher",
"titel": "Dr. med."
}
},
"pruefnummer": "Y/400/1910/36/346",
"organisation": {
"bsnr": 31234567,
"name": "Hausarztpraxis Dr. Gesundmacher",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 200
},
"telefon": "+49 711 1234567",
"fax": "+49 711 1234599",
"eMail": "hans@praxis-gesundmacher.de"
},
"verordnung": {
"ausstellungsdatum": "2024-06-30T00:00:00.000Z",
"noctu": false,
"bvg": false,
"zuzahlungsstatus": 0,
"autidem": true,
"abgabehinweis": "Vor Zugriff durch Kinder schützen.",
"anzahl": 1
},
"arzneimittel": {
"type": "medicationCompounding",
"kategorie": 0,
"impfstoff": false,
"herstellungsanweisung": "Lösung",
"verpackung": null,
"rezepturname": null,
"darreichungsform": null,
"gesamtmenge": 100,
"einheit": "ml",
"listeBestandteilRezepturverordnung": [
{
"type": "bestandteilRezepturverordnung",
"name": "Salicylsäure",
"menge": 5,
"einheit": "g"
},
{
"name": "2-propanol 70 %",
"mengeUndEinheit": "Ad 100 g"
}
]
}
},
{
"prescriptionId": "160.100.000.000.006.24",
"erstellungszeitpunkt": "2024-06-30T09:50:00.000Z",
"status": "final",
"krankenversicherung": {
"kostentraegertyp": "GKV",
"ikKrankenkasse": 104212059,
"kostentraeger": "AOK Baden-Württemberg",
"wop": 52,
"versichertenstatus": 1,
"besonderePersonengruppe": 0,
"dmpKz": 0
},
"patient": {
"gkvVersichertenId": "X234567891",
"person": {
"vorname": "Tina",
"name": "Tester"
},
"geburtsdatum": "1985-05-05T00:00:00.000Z",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 42
}
},
"arzt": {
"typ": 0,
"berufsbezeichnung": "Hausarzt",
"arztnummer": 838382202,
"person": {
"vorname": "Hans",
"nachname": "Gesundmacher",
"titel": "Dr. med."
}
},
"pruefnummer": "Y/400/1910/36/346",
"organisation": {
"bsnr": 31234567,
"name": "Hausarztpraxis Dr. Gesundmacher",
"adresse": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 200
},
"telefon": "+49 711 1234567",
"fax": "+49 711 1234599",
"eMail": "hans@praxis-gesundmacher.de"
},
"verordnung": {
"ausstellungsdatum": "2024-06-30T00:00:00.000Z",
"noctu": false,
"bvg": false,
"zuzahlungsstatus": 0,
"autidem": true,
"abgabehinweis": "Vor Zugriff durch Kinder schützen.",
"anzahl": 1
},
"arzneimittel": {
"type": "medicationFreeText",
"kategorie": 0,
"impfstoff": false,
"freitextverordnung": "Metformin 850mg Tabletten N3"
}
}
],
"messageId": "e9a148b9-e70a-498e-af0e-358c8226cae8",
"correlationId": "df094bd9-4669-458a-b47f-8330e8254306"
}
]
}
Receive list of prescriptions selected by the user for dispensation and delivery
Available only on servers:
webSocketId
Version of the API required by the client
Additional properties are allowed.
Accepts the following message:
Return list of prescriptions selected by user for dispensation from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service
The selectedPrescriptionList message specifies exactly which electronic prescriptions should be dispensed and how the prescribed medication should be delivered. The selectedPrescriptionList message is based on the structures from gemSpec_DM_eRp (section 2.6.3).
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
The prescriptionIndexList element is contained in the selectedPrescriptionList message and specifies which of the available electronic prescriptions should be redeemed. See section A.3.11 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Specifies the version of the JSON. Currently always 2. Can be changed later in the life cycle.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Note that the insured person can provide.
Free text that the user can enter using the app.
Telephone number of the insured person.
E-Mail-Adresse des Versicherten.
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
selectedPrescriptionList message
{
"type": "selectedPrescriptionList",
"selectedPrescriptionListMessage": {
"ICCSN": "MTIzNDU2Nzg5",
"prescriptionIndexList": [
"160.000.764.737.300.50",
"160.100.000.000.012.06",
"160.100.000.000.004.30",
"160.100.000.000.014.97",
"160.100.000.000.006.24"
],
"version": 2,
"supplyOptionsType": "delivery",
"name": "Der Nachbar ist Heinz Müller und wohnt im 2. OG.",
"address": {
"plz": 70372,
"ort": "Stuttgart",
"strasse": "Musterstrasse",
"hausnummer": 42
},
"hint": "Bitte beim Nachbarn (Heinz Müller (2. OG)) abgeben und bei Belieferung anrufen.",
"phone": "+49 711 123 9876543",
"mail": "tina.tester@gmail.com"
},
"messageId": "e9a148b9-e70a-498e-af0e-358c8226cae8"
}
Send confirmation of prescriptions selected by the user for dispensation and delivery
Available only on servers:
webSocketId
Version of the API required by the client
Additional properties are allowed.
Accepts the following message:
Return confirmation of prescription selection by user from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service
Specifies the version of the JSON. Currently always 1. Can be changed later in the life cycle.
Human-readable pickup code only for supplyOptionsType "onPremise". If set, the content of the "pickUpCodeHR" is displayed to the user in a visually highlighted manner.
Machine-readable pickup code (data matrix code) that is only used with supplyOptionsType "onPremise". If set, the user can display the content as a data matrix code. The content is converted into a DMC by the app in accordance with ISO/IEC 16022:2006. If the interpretation is missing, the code is displayed as free text.
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
selectedPrescriptionListResponse message
{
"type": "selectedPrescriptionListResponse",
"version": 1,
"supplyOptionsType": "delivery",
"infoText": "Der Bote ist auf dem Weg zu Ihnen und wird voraussichtlich um 10:30 Uhr bei Ihnen sein.",
"messageId": "48482e8c-fb65-4931-a737-60008521bf50",
"correlationId": "e9a148b9-e70a-498e-af0e-358c8226cae8"
}
eH-CL encountered an error
Available only on servers:
webSocketId
Version of the API required by the client
Additional properties are allowed.
Accepts the following message:
Base type for error messages
Base type for error messages
Error message describing the error in more detail
Additional properties are allowed.
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
generic Error message example
{
"messageId": "54200292-c442-4b1a-a1c1-83cfb596b72c",
"correlationId": "f1f7bdb6-7562-4152-b636-9f75ca5fb7b1",
"type": "genericError",
"errorCode": "INVALID_MESSAGE_DATA",
"errorMessage": "Received payload is missing field XYZ."
}
Receive request to list available prescriptions from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service
List of available prescriptions
The ICCSNs for which to request prescriptions, or all ICCNs known to the server if the array is empty or absent.
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
Send list of available prescriptions from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service
List of available prescription lists
List of available prescriptions
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
The prescriptionBundle element is the bundling element used for electronic prescriptions, which is derived from the Bundle resource and contains all other data elements. See section A.3.10 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Indicates the time at which the e-prescription bundle was created.
Contains the status code of the electronic prescription. The intended values can be found in the key table S_KBV_STATUSKENNZEICHEN.
In the case of a private prescription, contains information on the PKV tariff according to KBV_EX_FOR_PKV_Tariff.
This element contains information about the health insurance of the patient. See section A.3.1 of specification.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are admissible: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institutional code (IK) of the responsible health insurance company, e.g. according to the electronic health card (eGK).
This field contains the institutional code (IK) of the cost carrier and is used if the cost carrier is not the responsible health insurance fund, e.g. a professional association (BG) or an accident insurance fund (UK).
Name of the cost carrier.
This field contains the place of residence code according to the place of residence principle (WOP) for fee agreements (BMV-Ä Annex 21). The intended values can be found in the key table S_ITA_WOP.
This element contains information on the insured person's status. According to the German Basis Guide (STU3), the following values are provided: "1" (members), "3" (family members), "5" (pensioners).}
This field contains the special group of people to which the insured person belongs (§ 264 SGB V). The corresponding values can be found in the key table S_KBV_PERSONENGRUPPE.
This field contains the disease management program (DMP) in which the insured person is enrolled (Section 284, Paragraph 1, Sentence 1, No. 14 SGB V). The intended values can be found in the key table S_KBV_DMP.
In this field, the date of the end of insurance coverage can be entered if the date is stored on the insurance card and has been read.
Additional properties are allowed.
Element containing the data of a patient. See section A.3.4 of specification.
This field contains the insured person ID of the statutory health insurance (unchangeable part of the uniform health insurance number of the GKV according to Section 290 SGB V).
This field contains the insured ID of the private health insurance (unchangeable part of the uniform health insurance number according to Section 290 SGB V).
This field contains the insurance number of the health insurance card (Krankenversichertenkarte).
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
This field contains either the street address (streetAddress) or the postal box address (pobAddress) of the patient.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Element containing the mailbox address of the respective person. See section A.3.5 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The mailbox can be specified in this field.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
This field contains a type to identify the prescribing person, e.g. doctor, doctor in training. The intended values can be found in the key table KBV_CS_FOR_Qualification_Type.
This field contains free text information about the job title, e.g. specialist in general medicine, general practitioner, midwife.
This field contains the ASV specialist group number (ASV-FGN, Fachgruppen-Nummer für Ambulante Spezialärztliche Versorgung) according to the Agreement on Outpatient Specialist Medical Care (ASV) (ASV-AV) Section 9 Paragraph 5. According to the ASV-AV, this must be stated by hospital doctors instead of the doctor number.
This field contains a doctor number (lifetime doctor number, LANR, Lebenslange Arztnummer) as an identifier for the practitioner.
This field contains a dentist number (ZANR) as an identifier for the person.
This field contains a telematics ID as an identifier for the person.
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
Additional properties are allowed.
Contains the verification number of the practice management system with which the electronic prescription was created.
Element containing the data of an organization. See section A.3.3 of specification.
This field contains a business location number (Betriebsstättennummer, BSNR) to identify a facility. In the statutory health insurance sector, the field is a prerequisite for billing between service providers and cost bearers. The BSNR must be specified for hospitals. In the context of hospital treatment, this field can show the place of issue.
This field contains an institutional code (IK), which is assigned by the ARGE IK and is a unique identifier for billing with the social insurance providers.
This field contains a billing number from the Association of Statutory Health Insurance Dentists (KZV).
This field contains a hospital location number.
This field contains a telematics ID of the facility.
This field contains the name of the facility (practice / hospital).
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
This field contains the phone number of the facility.
This field contains the fax number of the facility.
This field contains the email address of the institution. This must be provided when redeeming a drug prescription across borders.
Additional properties are allowed.
This element can be used to indicate whether the prescribing physician has another role in the area of outpatient specialist care (Ambulante Spezialärztliche Versorgung, ASV). This field must be used in the context of outpatient specialist medical care. Each ASV team receives an ASV team number (ASV-TN) from the ASV service center. ASV doctors use this number to identify the services or prescriptions they provide in the ASV. The team number consists of nine digits and is structured like a business location number (BSNR). It is assigned as soon as the doctors have ASV authorization - in addition to the BSNR and the lifelong doctor number.
Contains further information on the electronic prescription. The prescription element is specified in section A.3.10 and the practiceSupply element is specified in section A.3.7.
The prescription element represents the technically and medically relevant components of a drug prescription. See section A.3.9 of specification.
This field contains the date of issue of the regulation.
This field contains the indication whether this prescription should also be delivered during general store closing times, combined with the collection of the Noctu fee (emergency service fee) at the expense of the health insurance company in accordance with the Drug Price Ordinance.
This field indicates whether this regulation is issued for persons entitled to benefits under the Federal Compensation Act (Bundesentschädigungsgesetz, BEG) or for persons entitled to benefits under the Federal Social Security Act (Bundesversorgungsgesetz, BVG).
This field specifies the co-payment status for the prescription. According to KBV_CS_FOR_StatusCoPayment the following options are available: 0 (not exempt from co-payment / subject to fees), 1 (exempt from co-payment / free of charge), 2 (artificial insemination (regulation according to Section 27a SGB V)).
This field indicates whether the medicine is interchangeable or not. If an exchange is allowed in the pharmacy, this field is set to true.
This field contains additional / other dispensing instructions for the pharmacy beyond the dosage.
This field contains the number of packs prescribed.
This field contains a dosage identifier and describes whether a dosage instruction or a medication plan is being transmitted.
This field contains dosing instructions.
This field contains the instructions for use of the recipe.
This field contains the information about the context in which the prescription was issued, e.g. accident. The possible values are specified in KBV_VS_ERP_Accident_Type. The following cases are provided: 1 (accident), 2 (work accident (professional association/accident insurance fund)), 4 (occupational disease (professional association/accident insurance fund)).
Day of accident.
Accident organisation.
This field indicates whether the prescription is a multiple prescription (Mehrfachverordnung, MFV).
This field contains a unique ID which is identical across all partial prescriptions of a multiple prescription.
This field contains the information about the partial prescription of a multiple prescription (series). Example: "2" in "2 of 4".
This field contains the length of this series, i.e. the total number of partial prescriptions of the multiple prescription. Example: "4" in "2 of 4".
This field contains the date from which the partial prescription of the multiple prescription can be redeemed.
This field contains the date of the last redemption day of the partial prescription of the multiple prescription. The issuing person can specify a redemption period that differs from the Drug Prescription Ordinance (Arzneimittelverschreibungsverordnung, AMVV).
Additional properties are allowed.
The practiceSupply element is used to prescribe practice supplies. See section A.3.7 of specification.
This field contains the date of issue of the prescription for practice supply.
This field contains the number of packs prescribed.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are expected: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institution code (IK) according to the electronic health card (eGK). See the transfer rule according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.2).
This field contains the name of the cost carrier. The correct name is derived from the defined rules according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.3).
Additional properties are allowed.
Additional properties are allowed.
Element containing a medication item, whereas the medication element may either be medicationPZN, medicationIngredient, medicationCompounding, medicationFreeText. See section A.3.2 of specification.
Prescription of standardised medication, which is identified by PZN. See section A.3.2.1 of specification.
This field contains the information on the dosage form according to the data in § 131 (4) SGB V, and must always be used when a finished medicinal product is prescribed in accordance with the price and product list. The key table for displaying the coded values is maintained by the KBV and is available in the coding table S_KBV_DARREICHUNGSFORM.
Contains the norm size of the prescription.
Is the identifier of the standardised prescription (Pharmazentralnummer, PZN).
Is the name of the standardised prescription.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by its ingredients. See section A.3.2.2 of specification.
Contains the norm size of the prescription.
This field contains the dosage form as free text and can be used if the product is not a finished medicinal product.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
List of ingredients
Medication, which is defined by its ingredients.
ASK-Number (Arzneimittelkatalog-Nummer).
Name of the ingredient.
Contains the strength of the ingredient.
Unit of strength of the ingredient.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by a specific recipe. See section A.3.2.3 of specification.
Contains instructions for the preparation of the recipe.
Describes the packaging of the medication.
Contains the name of the recipe.
This field contains the dosage form of the prescription as free text and can be used if the component of the prescription is not a finished medicinal product.
Contains the total quantity of the prescription.
Unit corresponding to the total quantity of the prescription.
List of ingredients
Medication, which is defined by a specific recipe.
Contains the description how to apply the specific part of the medication.
Name of the specific part of the medication.
Identifier (Pharmazentralnummer, PZN) of the specific part of the medication.
Quantity of the specific part of the medication.
Unit corresponding to the specific part of the medication.
Contains a free text to describe the quantity of the specific part of the medication including its unit.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of a medication, which is described by a free text. See section A.3.2.4 of specification.
Contains a free text, which describes the prescribed medication.
This field contains the dosage form of the prescription as free text.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
Return list of prescriptions selected by user for dispensation from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service
The selectedPrescriptionList message specifies exactly which electronic prescriptions should be dispensed and how the prescribed medication should be delivered. The selectedPrescriptionList message is based on the structures from gemSpec_DM_eRp (section 2.6.3).
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
The prescriptionIndexList element is contained in the selectedPrescriptionList message and specifies which of the available electronic prescriptions should be redeemed. See section A.3.11 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Specifies the version of the JSON. Currently always 2. Can be changed later in the life cycle.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Note that the insured person can provide.
Free text that the user can enter using the app.
Telephone number of the insured person.
E-Mail-Adresse des Versicherten.
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
Return confirmation of prescription selection by user from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service
Specifies the version of the JSON. Currently always 1. Can be changed later in the life cycle.
Human-readable pickup code only for supplyOptionsType "onPremise". If set, the content of the "pickUpCodeHR" is displayed to the user in a visually highlighted manner.
Machine-readable pickup code (data matrix code) that is only used with supplyOptionsType "onPremise". If set, the user can display the content as a data matrix code. The content is converted into a DMC by the app in accordance with ISO/IEC 16022:2006. If the interpretation is missing, the code is displayed as free text.
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
Base type for error messages
Base type for error messages
Error message describing the error in more detail
Additional properties are allowed.
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Message identifier
Additional properties are allowed.
Additional properties are allowed.
List of available prescriptions
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
The prescriptionBundle element is the bundling element used for electronic prescriptions, which is derived from the Bundle resource and contains all other data elements. See section A.3.10 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Indicates the time at which the e-prescription bundle was created.
Contains the status code of the electronic prescription. The intended values can be found in the key table S_KBV_STATUSKENNZEICHEN.
In the case of a private prescription, contains information on the PKV tariff according to KBV_EX_FOR_PKV_Tariff.
This element contains information about the health insurance of the patient. See section A.3.1 of specification.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are admissible: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institutional code (IK) of the responsible health insurance company, e.g. according to the electronic health card (eGK).
This field contains the institutional code (IK) of the cost carrier and is used if the cost carrier is not the responsible health insurance fund, e.g. a professional association (BG) or an accident insurance fund (UK).
Name of the cost carrier.
This field contains the place of residence code according to the place of residence principle (WOP) for fee agreements (BMV-Ä Annex 21). The intended values can be found in the key table S_ITA_WOP.
This element contains information on the insured person's status. According to the German Basis Guide (STU3), the following values are provided: "1" (members), "3" (family members), "5" (pensioners).}
This field contains the special group of people to which the insured person belongs (§ 264 SGB V). The corresponding values can be found in the key table S_KBV_PERSONENGRUPPE.
This field contains the disease management program (DMP) in which the insured person is enrolled (Section 284, Paragraph 1, Sentence 1, No. 14 SGB V). The intended values can be found in the key table S_KBV_DMP.
In this field, the date of the end of insurance coverage can be entered if the date is stored on the insurance card and has been read.
Additional properties are allowed.
Element containing the data of a patient. See section A.3.4 of specification.
This field contains the insured person ID of the statutory health insurance (unchangeable part of the uniform health insurance number of the GKV according to Section 290 SGB V).
This field contains the insured ID of the private health insurance (unchangeable part of the uniform health insurance number according to Section 290 SGB V).
This field contains the insurance number of the health insurance card (Krankenversichertenkarte).
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
This field contains either the street address (streetAddress) or the postal box address (pobAddress) of the patient.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Element containing the mailbox address of the respective person. See section A.3.5 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The mailbox can be specified in this field.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
This field contains a type to identify the prescribing person, e.g. doctor, doctor in training. The intended values can be found in the key table KBV_CS_FOR_Qualification_Type.
This field contains free text information about the job title, e.g. specialist in general medicine, general practitioner, midwife.
This field contains the ASV specialist group number (ASV-FGN, Fachgruppen-Nummer für Ambulante Spezialärztliche Versorgung) according to the Agreement on Outpatient Specialist Medical Care (ASV) (ASV-AV) Section 9 Paragraph 5. According to the ASV-AV, this must be stated by hospital doctors instead of the doctor number.
This field contains a doctor number (lifetime doctor number, LANR, Lebenslange Arztnummer) as an identifier for the practitioner.
This field contains a dentist number (ZANR) as an identifier for the person.
This field contains a telematics ID as an identifier for the person.
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
Additional properties are allowed.
Contains the verification number of the practice management system with which the electronic prescription was created.
Element containing the data of an organization. See section A.3.3 of specification.
This field contains a business location number (Betriebsstättennummer, BSNR) to identify a facility. In the statutory health insurance sector, the field is a prerequisite for billing between service providers and cost bearers. The BSNR must be specified for hospitals. In the context of hospital treatment, this field can show the place of issue.
This field contains an institutional code (IK), which is assigned by the ARGE IK and is a unique identifier for billing with the social insurance providers.
This field contains a billing number from the Association of Statutory Health Insurance Dentists (KZV).
This field contains a hospital location number.
This field contains a telematics ID of the facility.
This field contains the name of the facility (practice / hospital).
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
This field contains the phone number of the facility.
This field contains the fax number of the facility.
This field contains the email address of the institution. This must be provided when redeeming a drug prescription across borders.
Additional properties are allowed.
This element can be used to indicate whether the prescribing physician has another role in the area of outpatient specialist care (Ambulante Spezialärztliche Versorgung, ASV). This field must be used in the context of outpatient specialist medical care. Each ASV team receives an ASV team number (ASV-TN) from the ASV service center. ASV doctors use this number to identify the services or prescriptions they provide in the ASV. The team number consists of nine digits and is structured like a business location number (BSNR). It is assigned as soon as the doctors have ASV authorization - in addition to the BSNR and the lifelong doctor number.
Contains further information on the electronic prescription. The prescription element is specified in section A.3.10 and the practiceSupply element is specified in section A.3.7.
The prescription element represents the technically and medically relevant components of a drug prescription. See section A.3.9 of specification.
This field contains the date of issue of the regulation.
This field contains the indication whether this prescription should also be delivered during general store closing times, combined with the collection of the Noctu fee (emergency service fee) at the expense of the health insurance company in accordance with the Drug Price Ordinance.
This field indicates whether this regulation is issued for persons entitled to benefits under the Federal Compensation Act (Bundesentschädigungsgesetz, BEG) or for persons entitled to benefits under the Federal Social Security Act (Bundesversorgungsgesetz, BVG).
This field specifies the co-payment status for the prescription. According to KBV_CS_FOR_StatusCoPayment the following options are available: 0 (not exempt from co-payment / subject to fees), 1 (exempt from co-payment / free of charge), 2 (artificial insemination (regulation according to Section 27a SGB V)).
This field indicates whether the medicine is interchangeable or not. If an exchange is allowed in the pharmacy, this field is set to true.
This field contains additional / other dispensing instructions for the pharmacy beyond the dosage.
This field contains the number of packs prescribed.
This field contains a dosage identifier and describes whether a dosage instruction or a medication plan is being transmitted.
This field contains dosing instructions.
This field contains the instructions for use of the recipe.
This field contains the information about the context in which the prescription was issued, e.g. accident. The possible values are specified in KBV_VS_ERP_Accident_Type. The following cases are provided: 1 (accident), 2 (work accident (professional association/accident insurance fund)), 4 (occupational disease (professional association/accident insurance fund)).
Day of accident.
Accident organisation.
This field indicates whether the prescription is a multiple prescription (Mehrfachverordnung, MFV).
This field contains a unique ID which is identical across all partial prescriptions of a multiple prescription.
This field contains the information about the partial prescription of a multiple prescription (series). Example: "2" in "2 of 4".
This field contains the length of this series, i.e. the total number of partial prescriptions of the multiple prescription. Example: "4" in "2 of 4".
This field contains the date from which the partial prescription of the multiple prescription can be redeemed.
This field contains the date of the last redemption day of the partial prescription of the multiple prescription. The issuing person can specify a redemption period that differs from the Drug Prescription Ordinance (Arzneimittelverschreibungsverordnung, AMVV).
Additional properties are allowed.
The practiceSupply element is used to prescribe practice supplies. See section A.3.7 of specification.
This field contains the date of issue of the prescription for practice supply.
This field contains the number of packs prescribed.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are expected: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institution code (IK) according to the electronic health card (eGK). See the transfer rule according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.2).
This field contains the name of the cost carrier. The correct name is derived from the defined rules according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.3).
Additional properties are allowed.
Additional properties are allowed.
Element containing a medication item, whereas the medication element may either be medicationPZN, medicationIngredient, medicationCompounding, medicationFreeText. See section A.3.2 of specification.
Prescription of standardised medication, which is identified by PZN. See section A.3.2.1 of specification.
This field contains the information on the dosage form according to the data in § 131 (4) SGB V, and must always be used when a finished medicinal product is prescribed in accordance with the price and product list. The key table for displaying the coded values is maintained by the KBV and is available in the coding table S_KBV_DARREICHUNGSFORM.
Contains the norm size of the prescription.
Is the identifier of the standardised prescription (Pharmazentralnummer, PZN).
Is the name of the standardised prescription.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by its ingredients. See section A.3.2.2 of specification.
Contains the norm size of the prescription.
This field contains the dosage form as free text and can be used if the product is not a finished medicinal product.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
List of ingredients
Medication, which is defined by its ingredients.
ASK-Number (Arzneimittelkatalog-Nummer).
Name of the ingredient.
Contains the strength of the ingredient.
Unit of strength of the ingredient.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by a specific recipe. See section A.3.2.3 of specification.
Contains instructions for the preparation of the recipe.
Describes the packaging of the medication.
Contains the name of the recipe.
This field contains the dosage form of the prescription as free text and can be used if the component of the prescription is not a finished medicinal product.
Contains the total quantity of the prescription.
Unit corresponding to the total quantity of the prescription.
List of ingredients
Medication, which is defined by a specific recipe.
Contains the description how to apply the specific part of the medication.
Name of the specific part of the medication.
Identifier (Pharmazentralnummer, PZN) of the specific part of the medication.
Quantity of the specific part of the medication.
Unit corresponding to the specific part of the medication.
Contains a free text to describe the quantity of the specific part of the medication including its unit.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of a medication, which is described by a free text. See section A.3.2.4 of specification.
Contains a free text, which describes the prescribed medication.
This field contains the dosage form of the prescription as free text.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
List of available prescription lists
List of available prescriptions
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
The prescriptionBundle element is the bundling element used for electronic prescriptions, which is derived from the Bundle resource and contains all other data elements. See section A.3.10 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Indicates the time at which the e-prescription bundle was created.
Contains the status code of the electronic prescription. The intended values can be found in the key table S_KBV_STATUSKENNZEICHEN.
In the case of a private prescription, contains information on the PKV tariff according to KBV_EX_FOR_PKV_Tariff.
This element contains information about the health insurance of the patient. See section A.3.1 of specification.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are admissible: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institutional code (IK) of the responsible health insurance company, e.g. according to the electronic health card (eGK).
This field contains the institutional code (IK) of the cost carrier and is used if the cost carrier is not the responsible health insurance fund, e.g. a professional association (BG) or an accident insurance fund (UK).
Name of the cost carrier.
This field contains the place of residence code according to the place of residence principle (WOP) for fee agreements (BMV-Ä Annex 21). The intended values can be found in the key table S_ITA_WOP.
This element contains information on the insured person's status. According to the German Basis Guide (STU3), the following values are provided: "1" (members), "3" (family members), "5" (pensioners).}
This field contains the special group of people to which the insured person belongs (§ 264 SGB V). The corresponding values can be found in the key table S_KBV_PERSONENGRUPPE.
This field contains the disease management program (DMP) in which the insured person is enrolled (Section 284, Paragraph 1, Sentence 1, No. 14 SGB V). The intended values can be found in the key table S_KBV_DMP.
In this field, the date of the end of insurance coverage can be entered if the date is stored on the insurance card and has been read.
Additional properties are allowed.
Element containing the data of a patient. See section A.3.4 of specification.
This field contains the insured person ID of the statutory health insurance (unchangeable part of the uniform health insurance number of the GKV according to Section 290 SGB V).
This field contains the insured ID of the private health insurance (unchangeable part of the uniform health insurance number according to Section 290 SGB V).
This field contains the insurance number of the health insurance card (Krankenversichertenkarte).
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
This field contains either the street address (streetAddress) or the postal box address (pobAddress) of the patient.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Element containing the mailbox address of the respective person. See section A.3.5 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The mailbox can be specified in this field.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
This field contains a type to identify the prescribing person, e.g. doctor, doctor in training. The intended values can be found in the key table KBV_CS_FOR_Qualification_Type.
This field contains free text information about the job title, e.g. specialist in general medicine, general practitioner, midwife.
This field contains the ASV specialist group number (ASV-FGN, Fachgruppen-Nummer für Ambulante Spezialärztliche Versorgung) according to the Agreement on Outpatient Specialist Medical Care (ASV) (ASV-AV) Section 9 Paragraph 5. According to the ASV-AV, this must be stated by hospital doctors instead of the doctor number.
This field contains a doctor number (lifetime doctor number, LANR, Lebenslange Arztnummer) as an identifier for the practitioner.
This field contains a dentist number (ZANR) as an identifier for the person.
This field contains a telematics ID as an identifier for the person.
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
Additional properties are allowed.
Contains the verification number of the practice management system with which the electronic prescription was created.
Element containing the data of an organization. See section A.3.3 of specification.
This field contains a business location number (Betriebsstättennummer, BSNR) to identify a facility. In the statutory health insurance sector, the field is a prerequisite for billing between service providers and cost bearers. The BSNR must be specified for hospitals. In the context of hospital treatment, this field can show the place of issue.
This field contains an institutional code (IK), which is assigned by the ARGE IK and is a unique identifier for billing with the social insurance providers.
This field contains a billing number from the Association of Statutory Health Insurance Dentists (KZV).
This field contains a hospital location number.
This field contains a telematics ID of the facility.
This field contains the name of the facility (practice / hospital).
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
This field contains the phone number of the facility.
This field contains the fax number of the facility.
This field contains the email address of the institution. This must be provided when redeeming a drug prescription across borders.
Additional properties are allowed.
This element can be used to indicate whether the prescribing physician has another role in the area of outpatient specialist care (Ambulante Spezialärztliche Versorgung, ASV). This field must be used in the context of outpatient specialist medical care. Each ASV team receives an ASV team number (ASV-TN) from the ASV service center. ASV doctors use this number to identify the services or prescriptions they provide in the ASV. The team number consists of nine digits and is structured like a business location number (BSNR). It is assigned as soon as the doctors have ASV authorization - in addition to the BSNR and the lifelong doctor number.
Contains further information on the electronic prescription. The prescription element is specified in section A.3.10 and the practiceSupply element is specified in section A.3.7.
The prescription element represents the technically and medically relevant components of a drug prescription. See section A.3.9 of specification.
This field contains the date of issue of the regulation.
This field contains the indication whether this prescription should also be delivered during general store closing times, combined with the collection of the Noctu fee (emergency service fee) at the expense of the health insurance company in accordance with the Drug Price Ordinance.
This field indicates whether this regulation is issued for persons entitled to benefits under the Federal Compensation Act (Bundesentschädigungsgesetz, BEG) or for persons entitled to benefits under the Federal Social Security Act (Bundesversorgungsgesetz, BVG).
This field specifies the co-payment status for the prescription. According to KBV_CS_FOR_StatusCoPayment the following options are available: 0 (not exempt from co-payment / subject to fees), 1 (exempt from co-payment / free of charge), 2 (artificial insemination (regulation according to Section 27a SGB V)).
This field indicates whether the medicine is interchangeable or not. If an exchange is allowed in the pharmacy, this field is set to true.
This field contains additional / other dispensing instructions for the pharmacy beyond the dosage.
This field contains the number of packs prescribed.
This field contains a dosage identifier and describes whether a dosage instruction or a medication plan is being transmitted.
This field contains dosing instructions.
This field contains the instructions for use of the recipe.
This field contains the information about the context in which the prescription was issued, e.g. accident. The possible values are specified in KBV_VS_ERP_Accident_Type. The following cases are provided: 1 (accident), 2 (work accident (professional association/accident insurance fund)), 4 (occupational disease (professional association/accident insurance fund)).
Day of accident.
Accident organisation.
This field indicates whether the prescription is a multiple prescription (Mehrfachverordnung, MFV).
This field contains a unique ID which is identical across all partial prescriptions of a multiple prescription.
This field contains the information about the partial prescription of a multiple prescription (series). Example: "2" in "2 of 4".
This field contains the length of this series, i.e. the total number of partial prescriptions of the multiple prescription. Example: "4" in "2 of 4".
This field contains the date from which the partial prescription of the multiple prescription can be redeemed.
This field contains the date of the last redemption day of the partial prescription of the multiple prescription. The issuing person can specify a redemption period that differs from the Drug Prescription Ordinance (Arzneimittelverschreibungsverordnung, AMVV).
Additional properties are allowed.
The practiceSupply element is used to prescribe practice supplies. See section A.3.7 of specification.
This field contains the date of issue of the prescription for practice supply.
This field contains the number of packs prescribed.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are expected: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institution code (IK) according to the electronic health card (eGK). See the transfer rule according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.2).
This field contains the name of the cost carrier. The correct name is derived from the defined rules according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.3).
Additional properties are allowed.
Additional properties are allowed.
Element containing a medication item, whereas the medication element may either be medicationPZN, medicationIngredient, medicationCompounding, medicationFreeText. See section A.3.2 of specification.
Prescription of standardised medication, which is identified by PZN. See section A.3.2.1 of specification.
This field contains the information on the dosage form according to the data in § 131 (4) SGB V, and must always be used when a finished medicinal product is prescribed in accordance with the price and product list. The key table for displaying the coded values is maintained by the KBV and is available in the coding table S_KBV_DARREICHUNGSFORM.
Contains the norm size of the prescription.
Is the identifier of the standardised prescription (Pharmazentralnummer, PZN).
Is the name of the standardised prescription.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by its ingredients. See section A.3.2.2 of specification.
Contains the norm size of the prescription.
This field contains the dosage form as free text and can be used if the product is not a finished medicinal product.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
List of ingredients
Medication, which is defined by its ingredients.
ASK-Number (Arzneimittelkatalog-Nummer).
Name of the ingredient.
Contains the strength of the ingredient.
Unit of strength of the ingredient.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by a specific recipe. See section A.3.2.3 of specification.
Contains instructions for the preparation of the recipe.
Describes the packaging of the medication.
Contains the name of the recipe.
This field contains the dosage form of the prescription as free text and can be used if the component of the prescription is not a finished medicinal product.
Contains the total quantity of the prescription.
Unit corresponding to the total quantity of the prescription.
List of ingredients
Medication, which is defined by a specific recipe.
Contains the description how to apply the specific part of the medication.
Name of the specific part of the medication.
Identifier (Pharmazentralnummer, PZN) of the specific part of the medication.
Quantity of the specific part of the medication.
Unit corresponding to the specific part of the medication.
Contains a free text to describe the quantity of the specific part of the medication including its unit.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of a medication, which is described by a free text. See section A.3.2.4 of specification.
Contains a free text, which describes the prescribed medication.
This field contains the dosage form of the prescription as free text.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Medication, which is defined by a specific recipe.
Contains the description how to apply the specific part of the medication.
Name of the specific part of the medication.
Identifier (Pharmazentralnummer, PZN) of the specific part of the medication.
Quantity of the specific part of the medication.
Unit corresponding to the specific part of the medication.
Contains a free text to describe the quantity of the specific part of the medication including its unit.
Additional properties are allowed.
Medication, which is defined by its ingredients.
ASK-Number (Arzneimittelkatalog-Nummer).
Name of the ingredient.
Contains the strength of the ingredient.
Unit of strength of the ingredient.
Additional properties are allowed.
Message identifier
Message identifier
Additional properties are allowed.
Message identifier
Additional properties are allowed.
This element contains information about the health insurance of the patient. See section A.3.1 of specification.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are admissible: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institutional code (IK) of the responsible health insurance company, e.g. according to the electronic health card (eGK).
This field contains the institutional code (IK) of the cost carrier and is used if the cost carrier is not the responsible health insurance fund, e.g. a professional association (BG) or an accident insurance fund (UK).
Name of the cost carrier.
This field contains the place of residence code according to the place of residence principle (WOP) for fee agreements (BMV-Ä Annex 21). The intended values can be found in the key table S_ITA_WOP.
This element contains information on the insured person's status. According to the German Basis Guide (STU3), the following values are provided: "1" (members), "3" (family members), "5" (pensioners).}
This field contains the special group of people to which the insured person belongs (§ 264 SGB V). The corresponding values can be found in the key table S_KBV_PERSONENGRUPPE.
This field contains the disease management program (DMP) in which the insured person is enrolled (Section 284, Paragraph 1, Sentence 1, No. 14 SGB V). The intended values can be found in the key table S_KBV_DMP.
In this field, the date of the end of insurance coverage can be entered if the date is stored on the insurance card and has been read.
Additional properties are allowed.
Base type for error messages
Error message describing the error in more detail
Additional properties are allowed.
Base type for error messages
Base type for error messages
Error message describing the error in more detail
Additional properties are allowed.
Additional properties are allowed.
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
Element containing a medication item, whereas the medication element may either be medicationPZN, medicationIngredient, medicationCompounding, medicationFreeText. See section A.3.2 of specification.
Prescription of standardised medication, which is identified by PZN. See section A.3.2.1 of specification.
This field contains the information on the dosage form according to the data in § 131 (4) SGB V, and must always be used when a finished medicinal product is prescribed in accordance with the price and product list. The key table for displaying the coded values is maintained by the KBV and is available in the coding table S_KBV_DARREICHUNGSFORM.
Contains the norm size of the prescription.
Is the identifier of the standardised prescription (Pharmazentralnummer, PZN).
Is the name of the standardised prescription.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by its ingredients. See section A.3.2.2 of specification.
Contains the norm size of the prescription.
This field contains the dosage form as free text and can be used if the product is not a finished medicinal product.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
List of ingredients
Medication, which is defined by its ingredients.
ASK-Number (Arzneimittelkatalog-Nummer).
Name of the ingredient.
Contains the strength of the ingredient.
Unit of strength of the ingredient.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by a specific recipe. See section A.3.2.3 of specification.
Contains instructions for the preparation of the recipe.
Describes the packaging of the medication.
Contains the name of the recipe.
This field contains the dosage form of the prescription as free text and can be used if the component of the prescription is not a finished medicinal product.
Contains the total quantity of the prescription.
Unit corresponding to the total quantity of the prescription.
List of ingredients
Medication, which is defined by a specific recipe.
Contains the description how to apply the specific part of the medication.
Name of the specific part of the medication.
Identifier (Pharmazentralnummer, PZN) of the specific part of the medication.
Quantity of the specific part of the medication.
Unit corresponding to the specific part of the medication.
Contains a free text to describe the quantity of the specific part of the medication including its unit.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of a medication, which is described by a free text. See section A.3.2.4 of specification.
Contains a free text, which describes the prescribed medication.
This field contains the dosage form of the prescription as free text.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Prescription of medication, which is defined by a specific recipe. See section A.3.2.3 of specification.
Contains instructions for the preparation of the recipe.
Describes the packaging of the medication.
Contains the name of the recipe.
This field contains the dosage form of the prescription as free text and can be used if the component of the prescription is not a finished medicinal product.
Contains the total quantity of the prescription.
Unit corresponding to the total quantity of the prescription.
List of ingredients
Medication, which is defined by a specific recipe.
Contains the description how to apply the specific part of the medication.
Name of the specific part of the medication.
Identifier (Pharmazentralnummer, PZN) of the specific part of the medication.
Quantity of the specific part of the medication.
Unit corresponding to the specific part of the medication.
Contains a free text to describe the quantity of the specific part of the medication including its unit.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of a medication, which is described by a free text. See section A.3.2.4 of specification.
Contains a free text, which describes the prescribed medication.
This field contains the dosage form of the prescription as free text.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of standardised medication, which is identified by PZN. See section A.3.2.1 of specification.
This field contains the information on the dosage form according to the data in § 131 (4) SGB V, and must always be used when a finished medicinal product is prescribed in accordance with the price and product list. The key table for displaying the coded values is maintained by the KBV and is available in the coding table S_KBV_DARREICHUNGSFORM.
Contains the norm size of the prescription.
Is the identifier of the standardised prescription (Pharmazentralnummer, PZN).
Is the name of the standardised prescription.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by its ingredients. See section A.3.2.2 of specification.
Contains the norm size of the prescription.
This field contains the dosage form as free text and can be used if the product is not a finished medicinal product.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
List of ingredients
Medication, which is defined by its ingredients.
ASK-Number (Arzneimittelkatalog-Nummer).
Name of the ingredient.
Contains the strength of the ingredient.
Unit of strength of the ingredient.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Message identifier
Message identifier
Additional properties are allowed.
Element containing the data of an organization. See section A.3.3 of specification.
This field contains a business location number (Betriebsstättennummer, BSNR) to identify a facility. In the statutory health insurance sector, the field is a prerequisite for billing between service providers and cost bearers. The BSNR must be specified for hospitals. In the context of hospital treatment, this field can show the place of issue.
This field contains an institutional code (IK), which is assigned by the ARGE IK and is a unique identifier for billing with the social insurance providers.
This field contains a billing number from the Association of Statutory Health Insurance Dentists (KZV).
This field contains a hospital location number.
This field contains a telematics ID of the facility.
This field contains the name of the facility (practice / hospital).
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
This field contains the phone number of the facility.
This field contains the fax number of the facility.
This field contains the email address of the institution. This must be provided when redeeming a drug prescription across borders.
Additional properties are allowed.
Element containing the data of a patient. See section A.3.4 of specification.
This field contains the insured person ID of the statutory health insurance (unchangeable part of the uniform health insurance number of the GKV according to Section 290 SGB V).
This field contains the insured ID of the private health insurance (unchangeable part of the uniform health insurance number according to Section 290 SGB V).
This field contains the insurance number of the health insurance card (Krankenversichertenkarte).
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
This field contains either the street address (streetAddress) or the postal box address (pobAddress) of the patient.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Element containing the mailbox address of the respective person. See section A.3.5 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The mailbox can be specified in this field.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Element containing the mailbox address of the respective person. See section A.3.5 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The mailbox can be specified in this field.
Additional properties are allowed.
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
The practiceSupply element is used to prescribe practice supplies. See section A.3.7 of specification.
This field contains the date of issue of the prescription for practice supply.
This field contains the number of packs prescribed.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are expected: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institution code (IK) according to the electronic health card (eGK). See the transfer rule according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.2).
This field contains the name of the cost carrier. The correct name is derived from the defined rules according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.3).
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
This field contains a type to identify the prescribing person, e.g. doctor, doctor in training. The intended values can be found in the key table KBV_CS_FOR_Qualification_Type.
This field contains free text information about the job title, e.g. specialist in general medicine, general practitioner, midwife.
This field contains the ASV specialist group number (ASV-FGN, Fachgruppen-Nummer für Ambulante Spezialärztliche Versorgung) according to the Agreement on Outpatient Specialist Medical Care (ASV) (ASV-AV) Section 9 Paragraph 5. According to the ASV-AV, this must be stated by hospital doctors instead of the doctor number.
This field contains a doctor number (lifetime doctor number, LANR, Lebenslange Arztnummer) as an identifier for the practitioner.
This field contains a dentist number (ZANR) as an identifier for the person.
This field contains a telematics ID as an identifier for the person.
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
Additional properties are allowed.
The prescription element represents the technically and medically relevant components of a drug prescription. See section A.3.9 of specification.
This field contains the date of issue of the regulation.
This field contains the indication whether this prescription should also be delivered during general store closing times, combined with the collection of the Noctu fee (emergency service fee) at the expense of the health insurance company in accordance with the Drug Price Ordinance.
This field indicates whether this regulation is issued for persons entitled to benefits under the Federal Compensation Act (Bundesentschädigungsgesetz, BEG) or for persons entitled to benefits under the Federal Social Security Act (Bundesversorgungsgesetz, BVG).
This field specifies the co-payment status for the prescription. According to KBV_CS_FOR_StatusCoPayment the following options are available: 0 (not exempt from co-payment / subject to fees), 1 (exempt from co-payment / free of charge), 2 (artificial insemination (regulation according to Section 27a SGB V)).
This field indicates whether the medicine is interchangeable or not. If an exchange is allowed in the pharmacy, this field is set to true.
This field contains additional / other dispensing instructions for the pharmacy beyond the dosage.
This field contains the number of packs prescribed.
This field contains a dosage identifier and describes whether a dosage instruction or a medication plan is being transmitted.
This field contains dosing instructions.
This field contains the instructions for use of the recipe.
This field contains the information about the context in which the prescription was issued, e.g. accident. The possible values are specified in KBV_VS_ERP_Accident_Type. The following cases are provided: 1 (accident), 2 (work accident (professional association/accident insurance fund)), 4 (occupational disease (professional association/accident insurance fund)).
Day of accident.
Accident organisation.
This field indicates whether the prescription is a multiple prescription (Mehrfachverordnung, MFV).
This field contains a unique ID which is identical across all partial prescriptions of a multiple prescription.
This field contains the information about the partial prescription of a multiple prescription (series). Example: "2" in "2 of 4".
This field contains the length of this series, i.e. the total number of partial prescriptions of the multiple prescription. Example: "4" in "2 of 4".
This field contains the date from which the partial prescription of the multiple prescription can be redeemed.
This field contains the date of the last redemption day of the partial prescription of the multiple prescription. The issuing person can specify a redemption period that differs from the Drug Prescription Ordinance (Arzneimittelverschreibungsverordnung, AMVV).
Additional properties are allowed.
The prescriptionBundle element is the bundling element used for electronic prescriptions, which is derived from the Bundle resource and contains all other data elements. See section A.3.10 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Indicates the time at which the e-prescription bundle was created.
Contains the status code of the electronic prescription. The intended values can be found in the key table S_KBV_STATUSKENNZEICHEN.
In the case of a private prescription, contains information on the PKV tariff according to KBV_EX_FOR_PKV_Tariff.
This element contains information about the health insurance of the patient. See section A.3.1 of specification.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are admissible: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institutional code (IK) of the responsible health insurance company, e.g. according to the electronic health card (eGK).
This field contains the institutional code (IK) of the cost carrier and is used if the cost carrier is not the responsible health insurance fund, e.g. a professional association (BG) or an accident insurance fund (UK).
Name of the cost carrier.
This field contains the place of residence code according to the place of residence principle (WOP) for fee agreements (BMV-Ä Annex 21). The intended values can be found in the key table S_ITA_WOP.
This element contains information on the insured person's status. According to the German Basis Guide (STU3), the following values are provided: "1" (members), "3" (family members), "5" (pensioners).}
This field contains the special group of people to which the insured person belongs (§ 264 SGB V). The corresponding values can be found in the key table S_KBV_PERSONENGRUPPE.
This field contains the disease management program (DMP) in which the insured person is enrolled (Section 284, Paragraph 1, Sentence 1, No. 14 SGB V). The intended values can be found in the key table S_KBV_DMP.
In this field, the date of the end of insurance coverage can be entered if the date is stored on the insurance card and has been read.
Additional properties are allowed.
Element containing the data of a patient. See section A.3.4 of specification.
This field contains the insured person ID of the statutory health insurance (unchangeable part of the uniform health insurance number of the GKV according to Section 290 SGB V).
This field contains the insured ID of the private health insurance (unchangeable part of the uniform health insurance number according to Section 290 SGB V).
This field contains the insurance number of the health insurance card (Krankenversichertenkarte).
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
This field contains either the street address (streetAddress) or the postal box address (pobAddress) of the patient.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Element containing the mailbox address of the respective person. See section A.3.5 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The mailbox can be specified in this field.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
This field contains a type to identify the prescribing person, e.g. doctor, doctor in training. The intended values can be found in the key table KBV_CS_FOR_Qualification_Type.
This field contains free text information about the job title, e.g. specialist in general medicine, general practitioner, midwife.
This field contains the ASV specialist group number (ASV-FGN, Fachgruppen-Nummer für Ambulante Spezialärztliche Versorgung) according to the Agreement on Outpatient Specialist Medical Care (ASV) (ASV-AV) Section 9 Paragraph 5. According to the ASV-AV, this must be stated by hospital doctors instead of the doctor number.
This field contains a doctor number (lifetime doctor number, LANR, Lebenslange Arztnummer) as an identifier for the practitioner.
This field contains a dentist number (ZANR) as an identifier for the person.
This field contains a telematics ID as an identifier for the person.
Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.
This field contains the person's first name; multiple first names are separated by a space or hyphen.
This field contains the person's last name.
This field contains the person’s academic degree, e.g. "Dr. med.", "Dr.rer.nat.".
This field contains the suffix as part of the person’s last name, e.g. "Freiherr", "Gräfin"; multiple suffixes are separated by a blank.
This field contains the prefix as part of the person's last name, e.g. "von", "von der", "zu"; multiple prefixes are separated by a space.
Additional properties are allowed.
The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.
Additional properties are allowed.
Contains the verification number of the practice management system with which the electronic prescription was created.
Element containing the data of an organization. See section A.3.3 of specification.
This field contains a business location number (Betriebsstättennummer, BSNR) to identify a facility. In the statutory health insurance sector, the field is a prerequisite for billing between service providers and cost bearers. The BSNR must be specified for hospitals. In the context of hospital treatment, this field can show the place of issue.
This field contains an institutional code (IK), which is assigned by the ARGE IK and is a unique identifier for billing with the social insurance providers.
This field contains a billing number from the Association of Statutory Health Insurance Dentists (KZV).
This field contains a hospital location number.
This field contains a telematics ID of the facility.
This field contains the name of the facility (practice / hospital).
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
This field contains the phone number of the facility.
This field contains the fax number of the facility.
This field contains the email address of the institution. This must be provided when redeeming a drug prescription across borders.
Additional properties are allowed.
This element can be used to indicate whether the prescribing physician has another role in the area of outpatient specialist care (Ambulante Spezialärztliche Versorgung, ASV). This field must be used in the context of outpatient specialist medical care. Each ASV team receives an ASV team number (ASV-TN) from the ASV service center. ASV doctors use this number to identify the services or prescriptions they provide in the ASV. The team number consists of nine digits and is structured like a business location number (BSNR). It is assigned as soon as the doctors have ASV authorization - in addition to the BSNR and the lifelong doctor number.
Contains further information on the electronic prescription. The prescription element is specified in section A.3.10 and the practiceSupply element is specified in section A.3.7.
The prescription element represents the technically and medically relevant components of a drug prescription. See section A.3.9 of specification.
This field contains the date of issue of the regulation.
This field contains the indication whether this prescription should also be delivered during general store closing times, combined with the collection of the Noctu fee (emergency service fee) at the expense of the health insurance company in accordance with the Drug Price Ordinance.
This field indicates whether this regulation is issued for persons entitled to benefits under the Federal Compensation Act (Bundesentschädigungsgesetz, BEG) or for persons entitled to benefits under the Federal Social Security Act (Bundesversorgungsgesetz, BVG).
This field specifies the co-payment status for the prescription. According to KBV_CS_FOR_StatusCoPayment the following options are available: 0 (not exempt from co-payment / subject to fees), 1 (exempt from co-payment / free of charge), 2 (artificial insemination (regulation according to Section 27a SGB V)).
This field indicates whether the medicine is interchangeable or not. If an exchange is allowed in the pharmacy, this field is set to true.
This field contains additional / other dispensing instructions for the pharmacy beyond the dosage.
This field contains the number of packs prescribed.
This field contains a dosage identifier and describes whether a dosage instruction or a medication plan is being transmitted.
This field contains dosing instructions.
This field contains the instructions for use of the recipe.
This field contains the information about the context in which the prescription was issued, e.g. accident. The possible values are specified in KBV_VS_ERP_Accident_Type. The following cases are provided: 1 (accident), 2 (work accident (professional association/accident insurance fund)), 4 (occupational disease (professional association/accident insurance fund)).
Day of accident.
Accident organisation.
This field indicates whether the prescription is a multiple prescription (Mehrfachverordnung, MFV).
This field contains a unique ID which is identical across all partial prescriptions of a multiple prescription.
This field contains the information about the partial prescription of a multiple prescription (series). Example: "2" in "2 of 4".
This field contains the length of this series, i.e. the total number of partial prescriptions of the multiple prescription. Example: "4" in "2 of 4".
This field contains the date from which the partial prescription of the multiple prescription can be redeemed.
This field contains the date of the last redemption day of the partial prescription of the multiple prescription. The issuing person can specify a redemption period that differs from the Drug Prescription Ordinance (Arzneimittelverschreibungsverordnung, AMVV).
Additional properties are allowed.
The practiceSupply element is used to prescribe practice supplies. See section A.3.7 of specification.
This field contains the date of issue of the prescription for practice supply.
This field contains the number of packs prescribed.
This field specifies the payer type. According to KBV_VS_FOR_Payor_type and KBV_CS_FOR_Payor_Type_KBV, the following values are expected: "GKV" (statutory health insurance), "PKV" (private health insurance), "BG" (professional association), "SEL" (self-payer), "SKT" (other payers), "UK" (accident insurance funds).
This field contains the institution code (IK) according to the electronic health card (eGK). See the transfer rule according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.2).
This field contains the name of the cost carrier. The correct name is derived from the defined rules according to "Technical Annex to Annex 4a BMV-Ä" (Section 2.3).
Additional properties are allowed.
Additional properties are allowed.
Element containing a medication item, whereas the medication element may either be medicationPZN, medicationIngredient, medicationCompounding, medicationFreeText. See section A.3.2 of specification.
Prescription of standardised medication, which is identified by PZN. See section A.3.2.1 of specification.
This field contains the information on the dosage form according to the data in § 131 (4) SGB V, and must always be used when a finished medicinal product is prescribed in accordance with the price and product list. The key table for displaying the coded values is maintained by the KBV and is available in the coding table S_KBV_DARREICHUNGSFORM.
Contains the norm size of the prescription.
Is the identifier of the standardised prescription (Pharmazentralnummer, PZN).
Is the name of the standardised prescription.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by its ingredients. See section A.3.2.2 of specification.
Contains the norm size of the prescription.
This field contains the dosage form as free text and can be used if the product is not a finished medicinal product.
Size of the package.
Unit corresponding to the package size.
Normal size of the package (e.g. N1).
List of ingredients
Medication, which is defined by its ingredients.
ASK-Number (Arzneimittelkatalog-Nummer).
Name of the ingredient.
Contains the strength of the ingredient.
Unit of strength of the ingredient.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of medication, which is defined by a specific recipe. See section A.3.2.3 of specification.
Contains instructions for the preparation of the recipe.
Describes the packaging of the medication.
Contains the name of the recipe.
This field contains the dosage form of the prescription as free text and can be used if the component of the prescription is not a finished medicinal product.
Contains the total quantity of the prescription.
Unit corresponding to the total quantity of the prescription.
List of ingredients
Medication, which is defined by a specific recipe.
Contains the description how to apply the specific part of the medication.
Name of the specific part of the medication.
Identifier (Pharmazentralnummer, PZN) of the specific part of the medication.
Quantity of the specific part of the medication.
Unit corresponding to the specific part of the medication.
Contains a free text to describe the quantity of the specific part of the medication including its unit.
Additional properties are allowed.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Prescription of a medication, which is described by a free text. See section A.3.2.4 of specification.
Contains a free text, which describes the prescribed medication.
This field contains the dosage form of the prescription as free text.
Category of prescription. Is "00" for regular prescriptions.
Indicates whether the prescription is a vaccine or not. Default is "false".
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
The prescriptionIndexList element is contained in the selectedPrescriptionList message and specifies which of the available electronic prescriptions should be redeemed. See section A.3.11 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
List of available prescriptions
The ICCSNs for which to request prescriptions, or all ICCNs known to the server if the array is empty or absent.
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
Additional properties are allowed.
The selectedPrescriptionList message specifies exactly which electronic prescriptions should be dispensed and how the prescribed medication should be delivered. The selectedPrescriptionList message is based on the structures from gemSpec_DM_eRp (section 2.6.3).
ICCSN (Integrated Circuit Card Serial Number) of the eHealth card
The prescriptionIndexList element is contained in the selectedPrescriptionList message and specifies which of the available electronic prescriptions should be redeemed. See section A.3.11 of specification.
This field contains the unique identifier of the electronic prescription over a period of 11 years according to GEM_ERP_PR_PrescriptionId and gemSpec_DM_eRp (section 2.2). It uniquely identifies an electronic prescription.
Specifies the version of the JSON. Currently always 2. Can be changed later in the life cycle.
Element containing the street address of the respective person. See section A.3.12 of specification.
This field contains the country code according to "Gemeinsames Rundschreiben DEÜV" (Anlage 8).
The postal code can be entered in this field.
The place name can be entered in this field. Multiple name components are separated by spaces/special characters.
The street name can be specified in this field.
The house number can be entered in this field.
In this field you can enter the additional address, e.g. rear building.
Additional properties are allowed.
Note that the insured person can provide.
Free text that the user can enter using the app.
Telephone number of the insured person.
E-Mail-Adresse des Versicherten.
Additional properties are allowed.
Specifies the version of the JSON. Currently always 1. Can be changed later in the life cycle.
Human-readable pickup code only for supplyOptionsType "onPremise". If set, the content of the "pickUpCodeHR" is displayed to the user in a visually highlighted manner.
Machine-readable pickup code (data matrix code) that is only used with supplyOptionsType "onPremise". If set, the user can display the content as a data matrix code. The content is converted into a DMC by the app in accordance with ISO/IEC 16022:2006. If the interpretation is missing, the code is displayed as free text.
Additional properties are allowed.
Identifier for the established web socket connection