検証操作: 概要

Azure API for FHIR の ストア プロファイル 記事では、FHIR プロファイルの基本と格納について説明しました。 この記事では、プロファイルに対してリソースを検証するために $validate を使用する方法について説明します。 プロファイルに対してリソースを検証することは、 Resource.meta.profile または実装ガイドに記載されている仕様を含め、リソースがプロファイルに準拠しているかどうかを確認することを意味します。

$validate は、FHIR リソースが基本リソースの要件または指定されたプロファイルに準拠していることを確認できる、Fast Healthcare Interoperability Resources (FHIR®) の操作です。 この操作により、Azure API for FHIR のデータに期待される属性と値が確実に含まれます。 検証操作の詳細については、 HL7 FHIR 仕様を参照してください。 仕様に従って、モードは作成や更新などの $validateで指定できます。

• create: Azure API for FHIR は、プロファイルコンテンツが既存のリソースから一意であり、新しいリソースとして作成可能であることを確認します。
• update: プロファイルが、指定された既存のリソースに対する更新であることを確認します (変更できないフィールドに対する変更は行われません)。

リソースを検証するには、さまざまな方法が用意されています。

• 検証操作を使用して既存のリソースを検証します。
• 検証操作を使用して新しいリソースを検証します。
• ヘッダーを使用してリソース CREATE/UPDATE を検証します。

Azure API for FHIR は、$validate操作の検証結果として常に OperationOutcome を返します。 Azure API for FHIR サービスでは、リソースがエンドポイント$validate渡されると、2 つの手順の検証が実行されます。最初の手順は、リソースを解析できるようにするための基本的な検証です。 リソースの解析中は、次の手順に進む前に、個々のエラーを修正する必要があります。 リソースが正常に解析されると、完全な検証が 2 番目の手順として実行されます。

既存のリソースの検証

既存のリソースを検証するには、GET 要求で $validate を使用します。

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

次に例を示します。

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

この例では、ベースの Patient リソースに対して既存の Patient リソース a6e11662-def8-4dde-9ebc-4429e68d130e を検証しています。 有効な場合は、次のコード例のような OperationOutcome が表示されます。

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

リソースが有効でない場合は、エラー コードと、リソースが無効な理由の詳細を示すエラー メッセージが表示されます。 OperationOutcomeの例は、エラー メッセージと共に返され、次のコード例のようになります。

{
    "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"
            ]
        }
    ]
}

この例では、リソースは提供された Patient プロファイルに準拠していません。これには、患者識別子の値と性別が必要でした。

プロファイルをパラメーターとして指定する場合は、検証対象のプロファイルの正規 URL を指定できます。たとえば、 heartrateの HL7 基本プロファイルの例を次に示します。

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

新しいリソースの検証

Azure API for FHIR にアップロードする新しいリソースを検証する場合は、 POST 要求を実行できます。サーバーは常に OperationOutcome を結果として返します。

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

次に例を示します。

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

この要求により、リソースが検証されます。 検証リソースが FHIR サービスで作成されていない場合は、リソースを作成する$validateなしで POST 要求を送信する必要があります。

ヘッダーを使用してリソース CREATE/UPDATE を検証します。

既定では、Azure API for FHIR はリソース Create/Updateの検証をオプトアウトするように構成されています。 この機能を使用すると、x-ms-profile-validation ヘッダーを使用して、Create/Updateを検証できます。 検証の場合は、'x-ms-profile-validation' を true に設定します。

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

次のステップ

この記事では、 $validateを使用してプロファイルに対してリソースを検証する方法について説明しました。 その他の Azure API for FHIR でサポートされている機能については、以下を参照してください。

FHIR® は HL7 の登録商標であり、HL7 の許可を得て使用しています。