C_12870_Anlage - E-Rezept: Communications v3 - Vereinheitlichung der Afos und JSON Schemas

Inhaltsverzeichnis

1 Änderungsbeschreibung

Die Nachrichten zwischen Versicherten und Apotheken beinhalten einen JSON-Payload, der den Inhalt der Nachricht enthält.

Es wurden Abweichungen zwischen den Anforderungen, die Inhalt und Struktur des JSON-Payloads beschreiben, und den bereitgestellten JSON-Schemas festgestellt, die zur Unterstützung der Validierung dienen. Die JSON-Schemas werden daher angepasst, damit sie den Anforderungen entsprechen.

Zusätzlich werden kleinere Optimierungen vorgenommen, in Form von Definitions für verschiedene Felder. Sie sollten jedoch keine Auswirkungen auf die Validierung haben.

Die vollständige JSON-Dateien sind im Änderungseintrag zu finden.

2 Änderung in CommunicationDispReqPayload

2.1 Nachrichtentypen delivery und shipment

Für die Nachrichtentypen delivery und shipment sind die Felder supplyOptionsType und transactionID verpflichtend.

Alt:

"title": "Delivery & Shipment",
            "properties": {
                "version": { "$ref": "#/definitions/version" },
                "communicationType": {
                    "$ref": "#/definitions/communicationType",
                    "value": "order"
                },
                "supplyOptionsType": { "enum": ["delivery", "shipment"] },
                "firstname": {
                    "type": "string",
                    "maxLength": 45
                },
                "lastname": {
                    "type": "string",
                    "maxLength": 45
                },
                "address": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 100
                },
                "postcode": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 10
                },
                "city": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 100
                },
                "country": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 3,
                    "description": "2-letter country code as defined in ISO 3166-1."
                },
                "hint": { "$ref": "#/definitions/hint" },
                "text": { "$ref": "#/definitions/text" },
                "phone": { "$ref": "#/definitions/phone" },
                "email": { "$ref": "#/definitions/email" },
                "transactionID": { "$ref": "#/definitions/transactionID" }
            },
            "required": ["version", "communicationType", "firstname", "lastname", "address", "postcode", "city", "country", "phone"],
            "additionalProperties": false
        },

Neu:

"title": "Delivery & Shipment",
            "properties": {
                "version": { "$ref": "#/definitions/version" },
                "communicationType": {
                    "$ref": "#/definitions/communicationType",
                    "value": "order"
                    "allOf": [
                        { "$ref": "#/definitions/communicationType" },
                        { "const": "order" }
                    ]

                },
                "supplyOptionsType": { "enum": ["delivery", "shipment"] },
                "firstname": {
                    "type": "string",
                    "maxLength": 45
                },
                "lastname": {
                    "type": "string",
                    "maxLength": 45
                },
                "address": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 100
                },
                "postcode": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 10
                },
                "city": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 100
                },
                "country": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 3,
                    "description": "2-letter country code as defined in ISO 3166-1."
                },
                "firstname": { "$ref": "#/definitions/firstname" },
                "lastname": { "$ref": "#/definitions/lastname" },
                "address": { "$ref": "#/definitions/address" },
                "postcode": { "$ref": "#/definitions/postcode" },
                "city": { "$ref": "#/definitions/city" },
                "country": { "$ref": "#/definitions/country" },

                "hint": { "$ref": "#/definitions/hint" },
                "text": { "$ref": "#/definitions/text" },
                "phone": { "$ref": "#/definitions/phone" },
                "email": { "$ref": "#/definitions/email" },
                "transactionID": { "$ref": "#/definitions/transactionID" }
            },
            "required": ["version", "communicationType", "supplyOptionsType", "firstname", "lastname", "address", "postcode", "city", "country", "phone", "transactionID"],
            "additionalProperties": false
        },

2.2 Nachrichtentyp order

Für den Nachrichtentyp order sind die Felder supplyOptionsType und transactionID verpflichtend. Die Felder firstname, lastname, address, postcode, city und country sind optional.

Alt:

{
            "title": "Reservation",
            "properties": {
                "version": { "$ref": "#/definitions/version" },
                "communicationType": {
                    "$ref": "#/definitions/communicationType",
                    "value": "order"
                },
                "supplyOptionsType": { "enum": ["onPremise"] },
                "hint": { "$ref": "#/definitions/hint" },
                "text": { "$ref": "#/definitions/text" },
                "phone": { "$ref": "#/definitions/phone" },
                "email": { "$ref": "#/definitions/email" },
                "transactionID": { "$ref": "#/definitions/transactionID" }
            },
            "required": ["version", "communicationType", "phone"],
            "additionalProperties": false
        },

Neu:

{
            "title": "Reservation",
            "properties": {
                "version": { "$ref": "#/definitions/version" },
                "communicationType": {
                    "$ref": "#/definitions/communicationType",
                    "value": "order"
                    "allOf": [
                        { "$ref": "#/definitions/communicationType" },
                        { "const": "order" }
                    ]

                },
                "supplyOptionsType": { "enum": ["onPremise"] },
                "firstname": { "$ref": "#/definitions/firstname" },
                "lastname": { "$ref": "#/definitions/lastname" },
                "address": { "$ref": "#/definitions/address" },
                "postcode": { "$ref": "#/definitions/postcode" },
                "city": { "$ref": "#/definitions/city" },
                "country": { "$ref": "#/definitions/country" },

                "hint": { "$ref": "#/definitions/hint" },
                "text": { "$ref": "#/definitions/text" },
                "phone": { "$ref": "#/definitions/phone" },
                "email": { "$ref": "#/definitions/email" },
                "transactionID": { "$ref": "#/definitions/transactionID" }
            },
            "required": ["version", "communicationType", "supplyOptionsType", "phone", "transactionID"],
            "additionalProperties": false
        },

2.3 Nachrichtentyp text

Für den Nachrichtentyp text ist das Feld hint nicht zulässig. Die Felder firstname, lastname, address, postcode, city und country sind optional.

Alt:

{
            "title": "Message",
            "properties": {
                "version": { "$ref": "#/definitions/version" },
                "communicationType": {
                    "$ref": "#/definitions/communicationType",
                    "value": "text"
                },
                "hint": { "$ref": "#/definitions/hint" },
                "text": { "$ref": "#/definitions/text" },
                "phone": { "$ref": "#/definitions/phone" },
                "email": { "$ref": "#/definitions/email" },
                "transactionID": { "$ref": "#/definitions/transactionID" }
            },
            "required": ["version", "communicationType", "text", "transactionID"],
            "additionalProperties": false
        }

Neu:

{
            "title": "Message",
            "properties": {
                "version": { "$ref": "#/definitions/version" },
                "communicationType": {
                    "$ref": "#/definitions/communicationType",
                    "value": "text"
                    "allOf": [
                        { "$ref": "#/definitions/communicationType" },
                        { "const": "text" }
                    ]

                },
                "firstname": { "$ref": "#/definitions/firstname" },
                "lastname": { "$ref": "#/definitions/lastname" },
                "address": { "$ref": "#/definitions/address" },
                "postcode": { "$ref": "#/definitions/postcode" },
                "city": { "$ref": "#/definitions/city" },
                "country": { "$ref": "#/definitions/country" },
                "hint": { "$ref": "#/definitions/hint" },
                "text": { "$ref": "#/definitions/text" },
                "phone": { "$ref": "#/definitions/phone" },
                "email": { "$ref": "#/definitions/email" },
                "transactionID": { "$ref": "#/definitions/transactionID" }
            },
            "required": ["version", "communicationType", "text", "transactionID"],
            "additionalProperties": false
        }

2.4 Definitions

Alt:

...

"email": {
            "type": "string",
            "pattern": "^.+@.{1,}\\..{1,}$"
        }

...

Neu:

...

"firstname": {
            "type": "string",
            "maxLength": 45
        },
        "lastname": {
            "type": "string",
            "maxLength": 45
        },
        "address": {
            "type": "string",
            "minLength": 3,
            "maxLength": 100
        },
        "postcode": {
            "type": "string",
            "minLength": 3,
            "maxLength": 10
        },
        "city": {
            "type": "string",
            "minLength": 2,
            "maxLength": 100
        },
        "country": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "description": "2-letter country code as defined in ISO 3166-1."
        },

...

"email": {
            "type": "string",
            "maxLength": 70,
            "pattern": "^.+@.{1,}\\..{1,}$"
        }

...

3 Änderung in CommunicationReplyPayload

Das Feld paymentMethods ist für den Nachrichttyp paymentInfo nicht mehr verpflichtend.

Alt:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "CommunicationReplyPayload",
    "title": "Payload of CommunicationReplyPayload",
    "type": "object",
    "oneOf": [

...

            "title": "paymentInfo",
            "properties": {
                "version": { "$ref": "#/definitions/version" },
                "transactionID": { "$ref": "#/definitions/transactionID" },
                "communicationType": {
                    "type": "string",
                    "const": "paymentInfo"
                },
                "text": {
                    "$ref": "#/definitions/text"
                },
                "totalAmount": { "$ref": "#/definitions/totalAmount"},
                "paymentMethods": { "$ref": "#/definitions/paymentMethods" }
            },
            "required": ["totalAmount", "paymentMethods"],
            "additionalProperties": false
        }
    ],

Neu:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "CommunicationReplyPayload",
    "title": "Payload of CommunicationReplyPayload",
    "type": "object",
    "oneOf": [

...

            "title": "paymentInfo",
            "properties": {
                "version": { "$ref": "#/definitions/version" },
                "transactionID": { "$ref": "#/definitions/transactionID" },
                "communicationType": {
                    "type": "string",
                    "const": "paymentInfo"
                },
                "text": {
                    "$ref": "#/definitions/text"
                },
                "totalAmount": { "$ref": "#/definitions/totalAmount"},
                "paymentMethods": { "$ref": "#/definitions/paymentMethods" }
            },
            "required": ["totalAmount", "paymentMethods"],
            "additionalProperties": false
        }
    ],