Operation API: Übergreifende Hinweise für Medikationsplan entfernen

Die FHIR Operation $remove-medication-plan-note MUSS verwendet werden, um komplett übergreifende Hinweise für den Medikationsplan zu entfernen. Diese übergreifenden Hinweise werden über eine Observation-Ressource abgebildet. Im Gegensatz zur Operation zum Hinzufügen von übergreifenden Hinweisen (Übergreifenden Hinweis für Medikationsplan hinzufügen) dient diese Operation der Entfernung von übergreifenden Hinweisen.

OperationDefinition

Operation Definition: Remove Medication Plan Management Notes

Geschäftslogik

Überprüfung der Telematik-ID bei einem Schreibvorgang

Jeder Lese- und Schreibvorgang erfordert die Authentifizierung der Leistungserbringerinstitution mittels OpenID Connect. Das signierte ID-Token des Identity Providers (IDP-Dienst) MUSS die Telematik-ID des zugreifenden Nutzers enthalten. Bei einem Schreibvorgang MUSS die Übereinstimmung der Telematik-ID des Nutzers überprüft und sichergestellt werden.

Herkunftsnachweis

Der Herkunftsnachweis für die Werte aus den Input-Parametern (performer, enterer, author, unconfirmedAuthor und informant) MUSS in einer Provenance-Instanz mit dem Profil EPAProvenance gespeichert werden. Der Wert für den target Parameter MUSS auf die spezifische Version der Ressourceninstanz verweisen.

Detaillierte Informationen zur Durchführung der Erstellung der Provenance-Instanz

Voraussetzungen

Dem Medication Service MÜSSEN zur Auswertung in Operationen für jede Aktivität die folgenden Informationen bereitstehen:

  • Name des Nutzers
  • Nutzergruppe/Rolle ((profession-)oid)
  • Kennung (Telematik-ID oder KVNR)
  • Hinweis auf eine gültige Befugnis des aktuellen Benutzers (requestor)

HTTP Header-Parameter

Ein ePA-Client MUSS die folgenden HTTP Header bei einer Anfrage an den Medication Service setzen:

Name Anforderung Datentyp Beschreibung
x-insurantid MUSS String Health Record Identifier
x-useragent KANN String User Agent Information
X-Request-ID MUSS String UUID der Nachricht

Wiederholungsintervalle

Die folgenden Wiederholungsintervalle werden im Falle einer Fehlerantwort definiert:

  • '409' Conflict (statusMismatch)
    • etwa 24 Stunden
  • '500' Internal Error
    • etwa 10 Minuten

Erlaubte Nutzergruppen

professionOID
oid_versicherter
oid_praxis_arzt
oid_krankenhaus
oid_institution
oid_krankenhaus
oid_institution-vorsorge-reha
oid_zahnarztpraxis
oid_praxis_psychotherapeut
oid_institution-oegd
oid_öffentliche_apotheke
oid_institution-pflege
oid_institution-geburtshilfe
oid_praxis-physiotherapeut
oid_institution-arbeitsmedizin

Interaktion ($remove-medication-plan-note)

POST [base]/epa/medication/api/v1/fhir/$remove-medication-plan-note

OperationId: removeMedicationPlanNote_MedicationSvc

Beispielanfrage

{
    "resourceType": "Parameters",
    "id": "example-epa-op-remove-plan-management-note-in-parameters-1",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-remove-medication-plan-management-note-in-parameters"
        ]
    },
    "parameter":  [
        {
            "name": "performer",
            "part":  [
                {
                    "name": "organization",
                    "resource": {
                        "resourceType": "Organization",
                        "id": "be51e0d2-783d-4e21-b16b-1a4cd7403515",
                        "meta": {
                            "tag":  [
                                {
                                    "system": "https://gematik.de/fhir/directory/CodeSystem/Origin",
                                    "code": "ldap"
                                }
                            ],
                            "profile":  [
                                "https://gematik.de/fhir/directory/StructureDefinition/OrganizationDirectory"
                            ]
                        },
                        "identifier":  [
                            {
                                "system": "https://gematik.de/fhir/sid/telematik-id",
                                "value": "9-2.58.00000040"
                            }
                        ],
                        "active": true,
                        "type":  [
                            {
                                "coding":  [
                                    {
                                        "code": "1.2.276.0.76.4.58",
                                        "system": "https://gematik.de/fhir/directory/CodeSystem/OrganizationProfessionOID",
                                        "display": "Betriebsstätte gematik"
                                    }
                                ]
                            }
                        ],
                        "name": "gematik GmbH",
                        "alias":  [
                            "gematik"
                        ],
                        "address":  [
                            {
                                "text": "gematik GmbH\nFriedrichstr. 136, \n10117 Berlin",
                                "line":  [
                                    "Friedrichstr. 136"
                                ],
                                "city": "Berlin",
                                "district": "Mitte",
                                "state": "Berlin",
                                "postalCode": "10117",
                                "country": "DE"
                            }
                        ],
                        "contact":  [
                            {
                                "purpose": {
                                    "coding":  [
                                        {
                                            "code": "ADMIN",
                                            "system": "http://terminology.hl7.org/CodeSystem/contactentity-type"
                                        }
                                    ]
                                },
                                "name": {
                                    "text": "gematik ITSM"
                                },
                                "telecom":  [
                                    {
                                        "system": "email",
                                        "value": "betrieb@gematik.de"
                                    }
                                ]
                            }
                        ]
                    }
                }
            ]
        }
    ]
}
{
    "resourceType": "Parameters",
    "id": "example-epa-op-remove-plan-management-note-in-parameters-1",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-op-remove-medication-plan-management-note-in-parameters"
        ]
    },
    "parameter":  [
        {
            "name": "performer",
            "part":  [
                {
                    "name": "organization",
                    "resource": {
                        "resourceType": "Organization",
                        "id": "be51e0d2-783d-4e21-b16b-1a4cd7403515",
                        "meta": {
                            "tag":  [
                                {
                                    "system": "https://gematik.de/fhir/directory/CodeSystem/Origin",
                                    "code": "ldap"
                                }
                            ],
                            "profile":  [
                                "https://gematik.de/fhir/directory/StructureDefinition/OrganizationDirectory"
                            ]
                        },
                        "identifier":  [
                            {
                                "system": "https://gematik.de/fhir/sid/telematik-id",
                                "value": "9-2.58.00000040"
                            }
                        ],
                        "active": true,
                        "type":  [
                            {
                                "coding":  [
                                    {
                                        "code": "1.2.276.0.76.4.58",
                                        "system": "https://gematik.de/fhir/directory/CodeSystem/OrganizationProfessionOID",
                                        "display": "Betriebsstätte gematik"
                                    }
                                ]
                            }
                        ],
                        "name": "gematik GmbH",
                        "alias":  [
                            "gematik"
                        ],
                        "address":  [
                            {
                                "text": "gematik GmbH\nFriedrichstr. 136, \n10117 Berlin",
                                "line":  [
                                    "Friedrichstr. 136"
                                ],
                                "city": "Berlin",
                                "district": "Mitte",
                                "state": "Berlin",
                                "postalCode": "10117",
                                "country": "DE"
                            }
                        ],
                        "contact":  [
                            {
                                "purpose": {
                                    "coding":  [
                                        {
                                            "code": "ADMIN",
                                            "system": "http://terminology.hl7.org/CodeSystem/contactentity-type"
                                        }
                                    ]
                                },
                                "name": {
                                    "text": "gematik ITSM"
                                },
                                "telecom":  [
                                    {
                                        "system": "email",
                                        "value": "betrieb@gematik.de"
                                    }
                                ]
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Beispielantwort

{
    "resourceType": "OperationOutcome",
    "id": "255002c7-aa1b-4163-bdd4-ede482453cca",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome"
        ]
    },
    "issue":  [
        {
            "severity": "information",
            "code": "informational",
            "details": {
                "coding":  [
                    {
                        "code": "MEDICATIONSVC_OPERATION_SUCCESS",
                        "system": "https://gematik.de/fhir/epa/CodeSystem/epa-operation-outcome-codes-cs",
                        "display": "Operation Successfully Completed in Medication Service"
                    }
                ]
            }
        }
    ]
}
<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="255002c7-aa1b-4163-bdd4-ede482453cca" />
    <meta>
        <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome" />
    </meta>
    <issue>
        <severity value="information" />
        <code value="informational" />
        <details>
            <coding>
                <system value="https://gematik.de/fhir/epa/CodeSystem/epa-operation-outcome-codes-cs" />
                <code value="MEDICATIONSVC_OPERATION_SUCCESS" />
                <display value="Operation Successfully Completed in Medication Service" />
            </coding>
        </details>
    </issue>
</OperationOutcome>

Antwort-Status-Codes

Status Code Bedingung Error Code Bemerkung
200 Successful operation EPA OperationOutcome
400 Invalid request EPA OperationOutcome
403 Requestor role is not in the list of allowed user groups invalidOid
403 Requestor is not entitled notEntitled
403 ID-Token or Insurant-ID mismatch EPA OperationOutcome
404 Health record is in state UNKNOWN or INITIALIZED noHealthRecord (siehe 'Wiederholungsintervalle')
409 Health record is in state SUSPENDED statusMismatch (siehe 'Wiederholungsintervalle')
423 If the insurant objected to the medication process or objected to the submission of prescription and dispensation data into the ePA system, the Medication Service is locked. locked
500 Any other error internalError (siehe 'Wiederholungsintervalle')

Serviceübergreifende Error Codes ohne Verweis auf EPA OperationOutcome MÜSSEN mit dem entsprechenden HTTP Status Code vom Medication Service mit dem Media Type application/json nach folgendem Schema zurückgegeben werden:

{
  "errorCode": "statusMismatch"
}