Partilhar via

Estruturas de mensagens de eventos

  • Artigo

Neste artigo, saiba mais sobre as estruturas de mensagens de eventos, elementos obrigatórios e não obrigatórios e veja exemplos de cargas úteis de mensagens de eventos.

Importante

Atualmente, o Events suporta estas operações:

  • FhirResourceCreated - O evento emitido depois que um recurso FHIR é criado com êxito.

  • FhirResourceUpdated - O evento emitido depois que um recurso FHIR é atualizado com êxito.

  • FhirResourceDeleted - O evento emitido depois que um recurso FHIR é excluído com êxito.

  • DicomImageCreated - O evento emitido depois que uma imagem DICOM é criada com êxito.

  • DicomImageDeleted - O evento emitido depois que uma imagem DICOM é excluída com êxito.

  • DicomImageUpdated - O evento emitido depois que uma imagem DICOM é atualizada com êxito.

Para obter mais informações sobre os tipos de exclusão do serviço FHIR, consulte Recursos da API REST no serviço FHIR nos Serviços de Dados de Integridade do Azure

Estrutura da mensagem de eventos FHIR

Nome Type Obrigatório Description
topic string Sim O tópico é a ID do Recurso do Azure do seu espaço de trabalho dos Serviços de Dados de Saúde do Azure.
subject string Sim O URI (Uniform Resource Identifier) do recurso FHIR que foi alterado. O cliente pode acessar o recurso com o assunto com https:// esquema. O Cliente deve usar o dataVersion ou data.resourceVersionId para visitar a versão de dados específica referente a esse evento.
eventType string(enum) Sim O tipo de alteração no recurso FHIR.
eventTime string(datetime) Sim A hora UTC em que a alteração de recurso FHIR foi confirmada.
id string Sim Identificador exclusivo do evento.
data objeto Sim Detalhes do evento de alteração de recursos FHIR.
data.resourceType string(enum) Sim O tipo de recurso FHIR.
data.resourceFhirAccount string Sim O nome de serviço da conta FHIR no espaço de trabalho Serviços de Dados de Saúde do Azure.
data.resourceFhirId string Sim O ID do recurso da conta FHIR. O serviço FHIR gera aleatoriamente a ID quando um cliente cria o recurso. O cliente também pode usar ID personalizado na criação de recursos FHIR; no entanto, o ID não deve incluir ou inferir qualquer informação de PHI/PII. Devem ser metadados do sistema, não específicos de qualquer conteúdo de dados pessoais.
data.resourceVersionId string(número) Sim A versão de dados do recurso FHIR.
dataVersion string Não O mesmo que data.resourceVersionId.
metadataVersion string Não A versão do esquema dos metadados do evento. Isso é definido pela Grade de Eventos do Azure e deve ser constante na maioria das vezes.

Exemplos de mensagens de eventos FHIR

Evento 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"
}

Evento FhirResourceUpdated

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

Evento FhirResourceDeleted

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

Estrutura de mensagens de eventos DICOM

Nome Type Obrigatório Description
topic string Sim O tópico é a ID do Recurso do Azure do seu espaço de trabalho dos Serviços de Dados de Saúde do Azure.
subject string Sim O URI (Uniform Resource Identifier) da imagem DICOM que foi alterada. O cliente pode acessar a imagem com o assunto com https:// esquema. O Cliente deve usar o dataVersion ou data.resourceVersionId para visitar a versão de dados específica referente a esse evento.
eventType string(enum) Sim O tipo de alteração na imagem DICOM.
eventTime string(datetime) Sim A hora UTC em que a alteração da imagem DICOM foi confirmada.
id string Sim Identificador exclusivo do evento.
data objeto Sim Detalhes do evento de alteração de imagem DICOM.
data.partitionName string Não Nome da partição de dados.
data.imageStudyInstanceUid string Sim UID da instância de estudo da imagem.
data.imageSeriesInstanceUid string Sim UID da instância de série da imagem.
data.imageSopInstanceUid string Sim UID da instância SOP da imagem.
data.serviceHostName string Sim O nome do host do serviço DICOM onde a alteração ocorreu.
data.sequenceNumber número inteiro Sim O número de sequência da alteração no serviço DICOM. Cada criação e exclusão de imagens tem uma sequência única dentro do serviço. Este número está correlacionado com o número sequencial do Change Feed do serviço DICOM. Consultar o DICOM Service Change Feed com esse número de sequência fornece a alteração que criou esse evento.
dataVersion string Não A versão de dados da imagem DICOM.
metadataVersion string Não A versão do esquema dos metadados do evento. Isso é definido pela Grade de Eventos do Azure e deve ser constante na maioria das vezes.

Exemplos de mensagens de eventos 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"
}

Próximos passos

Neste artigo, você aprendeu sobre as estruturas de mensagem de eventos.

Para saber como implantar eventos usando o portal do Azure, consulte

Implantar eventos usando o portal do Azure

FHIR® é uma marca registada da Health Level Seven International, registada no U.S. Trademark Office e é utilizada com a sua permissão.