eHealth-CardLink Card Communication Interface 1.0.0

This API defines an interface between a client (i.e. application which has access to a smartcard of type eHC (electronic Health Card = eGK = elektronische Gesundheitskarte) on one side and a server (i.e. application of type eHealth-CardLink) on the other side.

Servers

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

    Websocket Server

Operations

  • SEND /

    Send Session Information for the opened connection to the client (app)

    Operation IDsendSessionStatusMessage

    Available only on servers:

    object

    Accepts the following message:

    Session Status Message

    Status about the (re-)established session

    object allOf

    Examples

  • RECEIVE /

    Receive request SMS Code for the opened connection from the client (app)

    Operation IDreceiveRequestSMSCodeMessage

    Available only on servers:

    object

    Accepts the following message:

    Request SMS Code Message

    Request SMS code validation for a given phone number

    object allOf

    Examples

  • SEND /

    Send request SMS Code Response for the opened connection to the client (app)

    Operation IDsendRequestSMSCodeResponseMessage

    Available only on servers:

    object

    Accepts the following message:

    Request SMS Code Response Message

    Response for requesting an SMS code validation for a given phone number

    object allOf

    Examples

  • RECEIVE /

    Receive confirm SMS Code for the opened connection from the client (app)

    Operation IDreceiveConfirmSMSCodeMessage

    Available only on servers:

    object

    Accepts the following message:

    Confirm SMS Code Message

    Confirm SMS code validation for a given phone number

    object allOf

    Examples

  • SEND /

    Send confirm SMS Code Response for the opened connection to the client (app)

    Operation IDsendConfirmSMSCodeResponseMessage

    Available only on servers:

    object

    Accepts the following message:

    Confirm SMS Code Response Message

    Response for confirming an SMS code for a given phone number

    object allOf

    Examples

  • SEND /

    Send ICCSN Reassignment for the opened connection to the client (app)

    Operation IDsendICCSNReassignmentMessage

    Available only on servers:

    object

    Accepts the following message:

    Notify user af reassigned ICCSN

    Notification for the user that the previously paired Phone Number is used with a new eGK. This message is correlated to the registerEGK message.

    object allOf

    Examples

  • RECEIVE /

    Receive eGK message from client (app)

    Operation IDreceiveRegisterEGKMessage

    Available only on servers:

    object

    Accepts the following message:

    send

    Card data

    object allOf

    Examples

  • SEND /

    Send eGK finished message to client (app)

    Operation IDsendRegisterEGKFinishMessage

    Available only on servers:

    object

    Accepts the following message:

    Register eGK Finish Message

    Finish message for eGK registration

    object allOf

    Examples

  • SEND /

    Send APDU to app (INTERNAL AUTHENTICATE)

    Operation IDsendSendAPDUMessage

    Available only on servers:

    object

    Accepts the following message:

    receive

    Token to be signed

    object allOf

    Examples

  • RECEIVE /

    INTERNAL AUTHENTICATE response

    Operation IDreceiveSendAPDUResponseMessage

    Available only on servers:

    object

    Accepts the following message:

    send

    APDU from card to processing component

    object allOf

    Examples

  • SEND /

    Error in the course of card plugging or ReadVSD

    Operation IDsendTasklistErrorMessage

    Available only on servers:

    object

    Accepts the following message:

    receive

    Error retrieving PN

    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

  • #1Session Status MessagesessionStatusMessage

    Status about the (re-)established session

    Message IDsessionStatusMessage
    object allOf
  • #2Request SMS Code MessagerequestSMSCodeMessage

    Request SMS code validation for a given phone number

    Message IDrequestSMSCodeMessage
    object allOf
  • #3Request SMS Code Response MessagerequestSMSCodeResponseMessage

    Response for requesting an SMS code validation for a given phone number

    Message IDrequestSMSCodeResponseMessage
    object allOf
  • #4Confirm SMS Code MessageconfirmSMSCodeMessage

    Confirm SMS code validation for a given phone number

    Message IDconfirmSMSCodeMessage
    object allOf
  • #5Confirm SMS Code Response MessageconfirmSMSCodeResponseMessage

    Response for confirming an SMS code for a given phone number

    Message IDconfirmSMSCodeResponseMessage
    object allOf
  • #6Notify user af reassigned ICCSNICCSNReassignmentMessage

    Notification for the user that the previously paired Phone Number is used with a new eGK. This message is correlated to the registerEGK message.

    Message IDICCSNReassignmentMessage
    object allOf
  • #7sendregisterEGKMessage

    Card data

    Message IDregisterEGKMessage
    object allOf
  • #8Register eGK Finish MessageregisterEGKFinishMessage

    Finish message for eGK registration

    Message IDregisterEGKFinishMessage
    object allOf
  • #9receivesendAPDUMessage

    Token to be signed

    Message IDsendAPDUMessage
    object allOf
  • #10sendsendAPDUResponseMessage

    APDU from card to processing component

    Message IDsendAPDUResponseMessage
    object allOf
  • #11receivetasklistErrorMessage

    Error retrieving PN

    Message IDtasklistErrorMessage
    object allOf
  • #12errorgenericErrorMessage
    Message IDgenericErrorMessage
    object allOf

Schemas

  • webSocketId
    string

    Identifier for the established web socket connection

  • cardSessionId
    string

    Card session identifier

  • object
  • messageId
    string

    Message identifier

  • object
  • correlationId
    string

    Message identifier

  • object
  • object
  • object allOf

    Base type for error messages

  • object

    Base type for error messages

  • genericErrorResultType
    string
      Allowed values:
    • "INVALID_MESSAGE_DATA"
    • "TI_UNAVAILABLE"
    • "TI_SERVICE_ERROR"
    • "CARD_EXPIRED"
    • "CARD_REVOKED"
    • "CARD_INVALID"
    • "CARD_ERROR"
    • "UNKNOWN_ERROR"
  • object

    Session Information object

  • object

    Request SMS Code Payload object

  • object

    Request SMS Code Payload Response object

  • object

    Confirm SMS Code Payload object

  • object

    Confirm SMS Code Payload Response object

  • smsCodeResultType
    string
      Allowed values:
    • "SUCCESS"
    • "NUMBER_FROM_WRONG_COUNTRY"
    • "TAN_EXPIRED"
    • "TAN_INCORRECT"
    • "TAN_RETRY_LIMIT_EXCEEDED"
    • "UNKNOWN_ERROR"
  • object

    ICCSN Reassignment object, indicating to the user, that the ICCSN-Phone association has changed.

  • object

    Registration message type containing eGK data.

  • object

    Conclusion message type of the eGK registration.

  • object

    Type for sending an APDU to the card

  • object

    Type for receiving a Response APDU from the card

  • object allOf