eHealth-CardLink Prescription Communication Interface 1.0.0

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.

Servers

  • wss://to.be.configured/wssproduction

    Websocket Server

Operations

  • RECEIVE /

    Receive request to list available prescriptions from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service

    Operation IDrequestPrescriptionListMessage

    Available only on servers:

    object

    Accepts the following message:

    Receive request to list available prescriptions

    Receive request to list available prescriptions from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service

    object allOf

    Examples

  • SEND /

    Send list of available prescriptions from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service

    Operation IDavailablePrescriptionListsMessage

    Available only on servers:

    object

    Accepts the following message:

    Send List of Available Prescriptions

    Send list of available prescriptions from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service

    object allOf

    Examples

  • RECEIVE /

    Receive list of prescriptions selected by the user for dispensation and delivery

    Operation IDselectedPrescriptionListMessage

    Available only on servers:

    object

    Accepts the following message:

    Send List of Prescriptions Selected for Dispensation

    Return list of prescriptions selected by user for dispensation from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service

    object allOf

    Examples

  • RECEIVE /

    Send confirmation of prescriptions selected by the user for dispensation and delivery

    Operation IDselectedPrescriptionListResponseMessage

    Available only on servers:

    object

    Accepts the following message:

    Receive confirmation for list of selected prescriptions

    Return confirmation of prescription selection by user from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service

    object allOf

    Examples

  • SEND /

    eH-CL encountered an error

    Operation IDsendGenericErrorMessage

    Available only on servers:

    object

    Accepts the following message:

    error
    object allOf

    Examples

Messages

  • #1Receive request to list available prescriptionsrequestPrescriptionListMessage

    Receive request to list available prescriptions from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service

    Message IDrequestPrescriptionListMessage
    object allOf
  • #2Send List of Available PrescriptionsavailablePrescriptionListsMessage

    Send list of available prescriptions from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service

    Message IDavailablePrescriptionListsMessage
    object allOf
  • #3Send List of Prescriptions Selected for DispensationselectedPrescriptionListMessage

    Return list of prescriptions selected by user for dispensation from the Pharmacy App to the Pharmacy System via the eHealth-CardLink service

    Message IDselectedPrescriptionListMessage
    object allOf
  • #4Receive confirmation for list of selected prescriptionsselectedPrescriptionListResponseMessage

    Return confirmation of prescription selection by user from the Pharmacy System to the Pharmacy App via the eHealth-CardLink service

    Message IDselectedPrescriptionListResponseMessage
    object allOf
  • #5errorgenericErrorMessage
    Message IDgenericErrorMessage
    object allOf

Schemas

  • object

    List of available prescriptions

  • object

    List of available prescription lists

  • object

    Medication, which is defined by a specific recipe.

  • object

    Medication, which is defined by its ingredients.

  • correlationId
    string

    Message identifier

  • object
  • object
  • object

    This element contains information about the health insurance of the patient. See section A.3.1 of specification.

  • object

    Base type for error messages

  • object allOf

    Base type for error messages

  • genericErrorResultType
    string
      Allowed values:
    • "INVALID_MESSAGE_DATA"
    • "TI_UNAVAILABLE"
    • "TI_SERVICE_ERROR"
    • "UNKNOWN_ERROR"
  • ICCSN
    string
    format: byte

    ICCSN (Integrated Circuit Card Serial Number) of the eHealth card

  • object

    Element containing a medication item, whereas the medication element may either be medicationPZN, medicationIngredient, medicationCompounding, medicationFreeText. See section A.3.2 of specification.

  • object
  • object allOf

    Prescription of medication, which is defined by a specific recipe. See section A.3.2.3 of specification.

  • object allOf

    Prescription of a medication, which is described by a free text. See section A.3.2.4 of specification.

  • object allOf

    Prescription of standardised medication, which is identified by PZN. See section A.3.2.1 of specification.

  • object allOf

    Prescription of medication, which is defined by its ingredients. See section A.3.2.2 of specification.

  • messageId
    string

    Message identifier

  • object
  • object

    Element containing the data of an organization. See section A.3.3 of specification.

  • object

    Element containing the data of a patient. See section A.3.4 of specification.

  • object

    Element containing the mailbox address of the respective person. See section A.3.5 of specification.

  • object

    Element containing information about a person (e.g. patient or practitioner). See section A.3.6 of specification.

  • object

    The practiceSupply element is used to prescribe practice supplies. See section A.3.7 of specification.

  • object

    The practitioner element contains information about the issuer of a prescription (e.g. medical doctor). See section A.3.8 of specification.

  • object

    The prescription element represents the technically and medically relevant components of a drug prescription. See section A.3.9 of specification.

  • object

    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.

  • prescriptionId
    string

    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.

  • array<string>
    non-empty

    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.

  • object

    Element containing the street address of the respective person. See section A.3.12 of specification.

  • object

    List of available prescriptions

  • object

    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).

  • object
  • supplyOptionsType
    string
      Allowed values:
    • "onPremise"
    • "shipment"
    • "delivery"
  • webSocketId
    string

    Identifier for the established web socket connection