Überprüfungsvorgang: Übersicht

In den Store-Profilen in der Azure-API für FHIR-Artikel haben Sie die Grundlagen von FHIR-Profilen durchlaufen und gespeichert. In diesem Artikel erfahren Sie, wie $validate Sie Ressourcen anhand von Profilen überprüfen können. Das Überprüfen einer Ressource anhand eines Profils bedeutet, dass überprüft wird, ob die Ressource dem Profil entspricht, einschließlich der in Resource.meta.profile oder in einem Implementierungshandbuch aufgeführten Spezifikationen.

$validate ist ein Vorgang in Fast Healthcare Interoperability Resources (FHIR®), mit dem Sie sicherstellen können, dass eine FHIR-Ressource den Basisressourcenanforderungen oder einem angegebenen Profil entspricht. Dieser Vorgang stellt sicher, dass die Daten in der Azure-API für FHIR über die erwarteten Attribute und Werte verfügen. Informationen zum Überprüfen des Vorgangs finden Sie unter HL7 FHIR Specification. Pro Spezifikation kann der Modus mit $validateangegeben werden, z. B. erstellen und aktualisieren:

• create: Die Azure-API für FHIR überprüft, ob der Profilinhalt von den vorhandenen Ressourcen eindeutig ist und dass es akzeptabel ist, als neue Ressource erstellt zu werden.
• update: Überprüft, ob das Profil eine Aktualisierung der nominierten vorhandenen Ressource ist (d. h. es werden keine Änderungen an den unveränderlichen Feldern vorgenommen).

Es gibt verschiedene Möglichkeiten, wie Sie die Ressource überprüfen können:

• Überprüfen Einer vorhandenen Ressource mit Überprüfungsvorgang.
• Überprüfen Einer neuen Ressource mit Überprüfungsvorgang.
• Überprüfen Sie die Ressource CREATE/UPDATE mithilfe des Headers.

Die Azure-API für FHIR gibt immer die OperationOutcome Validierungsergebnisse für $validate Vorgang zurück. Die Azure-API für den FHIR-Dienst führt eine Überprüfung in zwei Schritten durch, sobald eine Ressource an $validate Endpunkt übergeben wird – der erste Schritt ist eine grundlegende Überprüfung, um sicherzustellen, dass die Ressource analysiert werden kann. Während der Ressourcenanalyse müssen einzelne Fehler behoben werden, bevor Sie mit dem nächsten Schritt fortfahren. Sobald die Ressource erfolgreich analysiert wurde, wird die vollständige Überprüfung im zweiten Schritt durchgeführt.

Überprüfen einer vorhandenen Ressource

Verwenden Sie $validate zum Überprüfen einer vorhandenen Ressource in einer GET Anforderung:

GET http://<your Azure API for FHIR base URL>/{resource}/{resource ID}/$validate

Zum Beispiel:

GET https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Patient/a6e11662-def8-4dde-9ebc-4429e68d130e/$validate

In diesem Beispiel überprüfen Sie die vorhandene Patient-Ressource a6e11662-def8-4dde-9ebc-4429e68d130e für die Basis-Patient-Ressource. Wenn dies gültig ist, erhalten Sie ein OperationOutcome Beispiel wie das folgende Codebeispiel:

{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "information",
            "code": "informational",
            "diagnostics": "All OK"
        }
    ]
}

Wenn die Ressource ungültig ist, erhalten Sie einen Fehlercode und eine Fehlermeldung mit Details dazu, warum die Ressource ungültig ist. Ein Beispiel OperationOutcome wird mit Fehlermeldungen zurückgegeben und könnte wie im folgenden Codebeispiel aussehen:

{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "error",
            "code": "invalid",
            "details": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/dotnet-api-operation-outcome",
                        "code": "1028"
                    }
                ],
                "text": "Instance count for 'Patient.identifier.value' is 0, which is not within the specified cardinality of 1..1"
            },
            "location": [
                "Patient.identifier[1]"
            ]
        },
        {
            "severity": "error",
            "code": "invalid",
            "details": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/dotnet-api-operation-outcome",
                        "code": "1028"
                    }
                ],
                "text": "Instance count for 'Patient.gender' is 0, which is not within the specified cardinality of 1..1"
            },
            "location": [
                "Patient"
            ]
        }
    ]
}

In diesem Beispiel stimmte die Ressource nicht mit dem bereitgestellten Patientenprofil überein, das einen Patientenbezeichnerwert und ein Geschlecht erforderte.

Wenn Sie ein Profil als Parameter angeben möchten, können Sie die kanonische URL für das Zu überprüfende Profil angeben, z. B. das folgende Beispiel für das HL7-Basisprofil für heartrate:

GET https://myAzureAPIforFHIR.azurehealthcareapis.com/Observation/12345678/$validate?profile=http://hl7.org/fhir/StructureDefinition/heartrate

Überprüfen einer neuen Ressource

Wenn Sie eine neue Ressource überprüfen möchten, die Sie in die Azure-API für FHIR hochladen, können Sie eine POST Anforderung ausführen: Der Server gibt immer einen OperationOutcome als Ergebnis zurück.

POST http://<your Azure API for FHIR base URL>/{Resource}/$validate

Zum Beispiel:

POST https://myAzureAPIforFHIR.azurehealthcareapis.com/Patient/$validate

Diese Anforderung überprüft die Ressource. Bei Überprüfungsressourcen wird im FHIR-Dienst nicht erstellt, Sie müssen eine POST-Anforderung senden, ohne $validate, um eine Ressource zu erstellen.

Überprüfen Sie die Ressource CREATE/UPDATE mithilfe des Headers.

Standardmäßig ist die Azure-API für FHIR so konfiguriert, dass die Überprüfung für die Ressource Create/Updatedeaktiviert wird. Diese Funktion ermöglicht die Überprüfung Create/Updateauf , mithilfe der x-ms-profile-validation Kopfzeile. Legen Sie für die Überprüfung "x-ms-profile-validation" auf "true" fest.

{
   "FhirServer": {
      "CoreFeatures": {
            "ProfileValidationOnCreate": true,
            "ProfileValidationOnUpdate": false
        }
}

Nächste Schritte

In diesem Artikel haben Sie erfahren, wie Sie Ressourcen anhand von Profilen mithilfe von $validateProfilen überprüfen. Weitere Informationen zu den anderen unterstützten Features der Azure-API für FHIR finden Sie unter

FHIR® ist eine eingetragene Marke von HL7 und wird mit Genehmigung von HL7 verwendet.