次の方法で共有

イベント メッセージの構造

  • [アーティクル]

この記事では、イベント メッセージの構造、必須要素と必須でない要素について説明し、イベント メッセージ ペイロードのサンプルを参照してください。

重要

イベントは現在、次の操作をサポートしています。

  • FhirResourceCreated - FHIR リソースが正常に作成された後に生成されるイベント。

  • FhirResourceUpdated - FHIR リソースが正常に更新された後に生成されるイベント。

  • FhirResourceDeleted - FHIR リソースが正常に論理的に削除された後に生成されるイベント。

  • DicomImageCreated - DICOM イメージが正常に作成された後に生成されるイベント。

  • DicomImageDeleted - DICOM イメージが正常に削除された後に生成されるイベント。

  • DicomImageUpdated - DICOM イメージが正常に更新された後に生成されるイベント。

FHIR サービスの削除の種類の詳細については、Azure Health Data Services の FHIR サービスの REST API 機能に関するページを参照してください 。

FHIR イベントのメッセージ構造

名前 タイプ 必須 Description
topic string はい このトピックは、Azure Health Data Services ワークスペースの Azure リソース ID です。
subject string はい 変更された FHIR リソースの URI (Uniform Resource Identifier)。 顧客は、https:// スキームを使用してサブジェクトを使用してリソースにアクセスできます。 お客様は、dataVersion または data.resourceVersionId を使用して、このイベントに関する特定のデータ バージョンにアクセスする必要があります。
eventType string(enum) はい FHIR リソースの変更の種類。
eventTime string(datetime) はい FHIR リソースの変更がコミットされた UTC 時刻。
id string はい イベントの一意識別子。
data オブジェクト はい FHIR リソース変更イベントの詳細。
data.resourceType string(enum) はい FHIR リソースの種類。
data.resourceFhirAccount string はい Azure Health Data Services ワークスペース内の FHIR アカウントのサービス名。
data.resourceFhirId string はい FHIR アカウントのリソース ID。 FHIR サービスは、顧客がリソースを作成するときに ID をランダムに生成します。 お客様は、FHIR リソースの作成でカスタマイズされた ID を使用することもできます。ただし、ID には PHI/PII 情報を含めたり推論したりしないでください。 個人データの内容に固有ではなく、システム メタデータにする必要があります。
data.resourceVersionId string(number) はい FHIR リソースのデータ バージョン。
dataVersion string いいえ data.resourceVersionId と同じ。
metadataVersion string いいえ イベント メタデータのスキーマ バージョン。 これは Azure Event Grid によって定義され、ほとんどの場合一定である必要があります。

FHIR イベント メッセージのサンプル

FhirResourceCreated イベント

{
  "id": "e4c7f556-d72c-e7f7-1069-1e82ac76ab41",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
  "subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902",
  "data": {
    "resourceType": "Patient",
    "resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
    "resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902",
    "resourceVersionId": 1
  },
  "eventType": "Microsoft.HealthcareApis.FhirResourceCreated",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2021-09-08T01:14:04.5613214Z"
}

FhirResourceCreated イベント

{
  "id": "634bd421-8467-f23c-b8cb-f6a31e41c32a",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
  "subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902",
  "data": {
    "resourceType": "Patient",
    "resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
    "resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902",
    "resourceVersionId": 2
  },
  "eventType": "Microsoft.HealthcareApis.FhirResourceUpdated",
  "dataVersion": "2",
  "metadataVersion": "1",
  "eventTime": "2021-09-08T01:29:12.0618739Z"
}

FhirResourceCreated イベント

{
  "id": "ef289b93-3159-b833-3a44-dc6b86ed1a8a",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
  "subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902",
  "data": {
    "resourceType": "Patient",
    "resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
    "resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902",
    "resourceVersionId": 3
  },
  "eventType": "Microsoft.HealthcareApis.FhirResourceDeleted",
  "dataVersion": "3",
  "metadataVersion": "1",
  "eventTime": "2021-09-08T01:31:58.5175837Z"
}

DICOM イベント のメッセージ構造

名前 タイプ 必須 Description
topic string はい このトピックは、Azure Health Data Services ワークスペースの Azure リソース ID です。
subject string はい 変更された DICOM イメージの UNIFORM Resource Identifier (URI)。 お客様は、https:// スキームを使用して、サブジェクトを使用して画像にアクセスできます。 お客様は、dataVersion または data.resourceVersionId を使用して、このイベントに関する特定のデータ バージョンにアクセスする必要があります。
eventType string(enum) はい DICOM イメージの変更の種類。
eventTime string(datetime) はい DICOM イメージの変更がコミットされた UTC 時刻。
id string はい イベントの一意識別子。
data オブジェクト はい DICOM イメージ変更イベントの詳細。
data.partitionName string いいえ データ パーティション名。
data.imageStudyInstanceUid string はい 画像の Study Instance UID。
data.imageSeriesInstanceUid string はい イメージの Series Instance UID。
data.imageSopInstanceUid string はい イメージの SOP インスタンス UID。
data.serviceHostName string はい 変更が発生した DICOM サービスのホスト名。
data.sequenceNumber int はい DICOM サービスでの変更のシーケンス番号。 イメージの作成と削除はすべて、サービス内で一意のシーケンスを持ちます。 この番号は、DICOM サービスの変更フィードのシーケンス番号に関連付けられます。 このシーケンス番号を使用して DICOM サービス変更フィードのクエリを実行すると、このイベントを作成した変更が得られます。
dataVersion string いいえ DICOM イメージのデータ バージョン。
metadataVersion string いいえ イベント メタデータのスキーマ バージョン。 これは Azure Event Grid によって定義され、ほとんどの場合一定である必要があります。

DICOM イベント メッセージのサンプル

DicomImageCreated

{
  "id": "d621839d-958b-4142-a638-bb966b4f7dfd",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
  "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
  "data": {
    "partitionName": "Microsoft.Default",
    "imageStudyInstanceUid": "1.2.3.4.3",
    "imageSeriesInstanceUid": "1.2.3.4.3.9423673",
    "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
    "serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
    "sequenceNumber": 1
  },
  "eventType": "Microsoft.HealthcareApis.DicomImageCreated",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2022-09-15T01:14:04.5613214Z"
}

DicomImageDeleted

{
  "id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
  "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
  "data": {
    "partitionName": "Microsoft.Default",
    "imageStudyInstanceUid": "1.2.3.4.3",
    "imageSeriesInstanceUid": "1.2.3.4.3.9423673",
    "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
    "serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
    "sequenceNumber": 2
  },
  "eventType": "Microsoft.HealthcareApis.DicomImageDeleted",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2022-09-15T01:16:07.5692209Z"
}

DicomImageUpdated

{
  "id": "83cb0f51-af41-e58c-3c6c-46344b349bc5",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
  "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
  "data": {
    "partitionName": "Microsoft.Default",
    "imageStudyInstanceUid": "1.2.3.4.3",
    "imageSeriesInstanceUid": "1.2.3.4.3.9423673",
    "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
    "serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
    "sequenceNumber": 2
  },
  "eventType": "Microsoft.HealthcareApis.DicomImageUpdated",
  "dataVersion": "1",
  "metadataVersion": "1",
  "eventTime": "2023-06-09T16:55:44.7197137Z"
}

次のステップ

この記事では、イベント メッセージの構造について説明しました。

Azure portal を使用してイベントをデプロイする方法については、

Azure portal 使用してイベントをデプロイする

FHIR®は、米国商標庁に登録されている Health Level Seven International の登録商標であり、その許可を得て使用しています。