Notifiche FHIR Pub/Sub

Questa pagina spiega come utilizzare Pub/Sub per ricevere notifiche quando si verifica un evento clinico in un datastore FHIR.

Puoi utilizzare le notifiche Pub/Sub per più casi d'uso, ad esempio che attivano l'elaborazione o l'analisi downstream di nuovi dati. Ad esempio, un di machine learning può ricevere notifiche quando sono disponibili nuovi dati per l'addestramento informazioni o previsioni per migliorare l'assistenza ai pazienti.

Panoramica

Puoi ricevere notifiche Pub/Sub quando una risorsa FHIR viene creato, aggiornato, con patch o eliminato in un datastore FHIR. L'API Cloud Healthcare non Invia notifiche quando una risorsa FHIR viene importata da Cloud Storage.

Per ricevere notifiche, devi creare un argomento Pub/Sub e e configurare il datastore FHIR per inviare notifiche per ogni argomento.

Il seguente diagramma mostra come vengono create le notifiche Pub/Sub e consegnato quando una risorsa FHIR viene creata in un datastore FHIR utilizzando fhir.create . I passaggi sono gli stessi quando una risorsa FHIR viene aggiornata, sottoposta a patch o eliminata.

Notifiche FHIR Pub/Sub.

Figura 1. Utilizzo delle notifiche Pub/Sub per le modifiche in un datastore FHIR.

La Figura 1 mostra i seguenti passaggi:

  1. Un chiamante effettua una richiesta fhirStores.fhir.create per creare una risorsa FHIR.
  2. Il datastore FHIR riceve la richiesta e crea un Pub/Sub e lo invia all'argomento Pub/Sub configurato nell'archivio FHIR.
  3. Pub/Sub inoltra il messaggio alle sottoscrizioni allegate all'argomento.
  4. Gli abbonati ricevono una notifica, sotto forma di messaggio Pub/Sub della sottoscrizione. Ogni abbonamento possono avere uno o più sottoscrittori per un maggiore parallelismo.

Configurazione delle notifiche

Puoi configurare le notifiche Pub/Sub e il loro comportamento in un FhirNotificationConfig in un datastore FHIR. Ogni datastore FHIR può avere un FhirNotificationConfig configurato.

La seguente tabella descrive i campi nella sezione FhirNotificationConfig .

Campo Descrizione Esempio
pubsubTopic L'argomento Pub/Sub da collegare al datastore FHIR. Le notifiche vengono inviate all'argomento specificato. projects/my-project/topics/my-topic
sendFullResource Indica se includere in una notifica i contenuti completi di una risorsa FHIR creata, aggiornata o con patch. Questo campo non ha alcun effetto sulle notifiche inviate quando le risorse FHIR vengono eliminate. Per includere l'intero contenuto di una risorsa eliminata, imposta sendPreviousResourceOnDelete su true. true
sendPreviousResourceOnDelete Indica se includere in una notifica i contenuti completi di una risorsa FHIR eliminata. Questo campo non ha alcun effetto sulle notifiche inviate quando le risorse FHIR vengono create, aggiornate o applicate. true

Formato e contenuto delle notifiche

Ogni notifica Pub/Sub contiene un oggetto message che contiene informazioni sull'evento clinico. L'oggetto message cerca simile al seguente:

{
  "message": {
    "attributes": {
      "action": "ACTION",
      "lastUpdatedTime": "RFC_1123_FORMAT_DATETIME",
      "payloadType": "PAYLOAD_TYPE",
      "resourceType": "FHIR_RESOURCE_TYPE",
      "storeName": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
      "versionId": "VERSION_ID"
    },
    "data": "BASE_64_ENCODED_DATA",
    "messageId": "MESSAGE_ID",
    "publishTime": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ"
  }
}

Per informazioni sui campi aggiuntivi inclusi in ogni messaggio Pub/Sub, vedi ReceivedMessage e PubsubMessage.

Nella tabella seguente sono descritti tutti i campi dell'oggetto attributes:

Attributo Descrizione Esempio
action L'azione che si è verificata su una risorsa FHIR. I valori possibili sono:
  • CreateResource
  • PatchResource
  • UpdateResource
  • DeleteResource
 CreateResource
resourceType Il tipo di risorsa FHIR che è stata modificata. I valori possibili includono qualsiasi tipo di risorsa FHIR supportato nell'API Cloud Healthcare. Patient
payloadType Il tipo di payload del messaggio, NameOnly o FullResource. FullResource
storeName Il nome completo della risorsa del datastore FHIR in cui si è verificata l'azione. projects/my-project/locations/us/datasets/my-dataset/fhirStores/my-fhir-store
lastUpdatedTime Timestamp dell'ultima modifica della risorsa FHIR. Il timestamp utilizza il formato RFC 1123. Mon, 01 Jan 2020 00:00:00 UTC
versionId L'ID della versione più recente della risorsa FHIR su cui si è verificata l'azione. Per ulteriori informazioni sugli ID versione, consulta la sezione Elenco delle versioni delle risorse FHIR. MTY4MzA2MDQzOTI5NjIxMDAwMA

Nella tabella seguente vengono descritti i campi rimanenti nell'oggetto message:

Campo Descrizione Esempio
data Una stringa con codifica base 64 del nome della risorsa FHIR o dei contenuti della risorsa FHIR, a seconda dei valori specificati in FhirNotificationConfig.
messageId Un identificatore per il messaggio Pub/Sub.
publishTime L'ora in cui il server Pub/Sub ha pubblicato il messaggio.

Specifica le informazioni da includere nelle notifiche

Notifiche Pub/Sub, come descritto in Formato e contenuti delle notifiche, tra cui: un insieme standard di campi. Puoi includere la risorsa FHIR completa o il nome in ogni notifica. Il nome della risorsa contiene il percorso completo della risorsa e l'ID risorsa in questo formato:

projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/RESOURCE_TYPE/RESOURCE_ID

Le informazioni sulle risorse FHIR vengono archiviate nel data come stringa codificata in base 64.

Includendo i contenuti completi di una risorsa FHIR, non è necessario eseguire separatamente query su Pub/Sub e l'API Cloud Healthcare per i dettagli.

recupera il nome della risorsa FHIR

Per includere solo il nome di una risorsa FHIR quando crei, aggiorni o una patch per la risorsa, imposta sendFullResource su false. Per includere il nome solo quando elimini una risorsa FHIR, imposta Da sendPreviousResourceOnDelete a false.

Quando visualizzi la notifica, l'oggetto message è simile al seguente:

{
  "message": {
    "attributes": {
      "action": "{CreateResource|PatchResource|UpdateResource|DeleteResource}",
      "lastUpdatedTime": "RFC_1123_FORMAT_DATETIME",
      "payloadType": "NameOnly",
      "resourceType": "FHIR_RESOURCE_TYPE",
      "storeName": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
      "versionId": "VERSION_ID"
    },
    "data": "BASE64_ENCODED_FHIR_RESOURCE_NAME",
    "messageId": "MESSAGE_ID",
    "publishTime": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ"
  }
}

Nella notifica, tieni presente quanto segue:

  • Il campo payloadType è impostato su NameOnly per indicare quanto segue: la richiesta:

    • Per le operazioni di creazione, aggiornamento e patch, il criterio sendFullResource è impostato su false.
    • Per le operazioni di eliminazione, il valore sendPreviousResourceOnDelete è impostato su false.

  • Nel campo data è incluso solo il nome della risorsa FHIR. Il nome è codificata come stringa con codifica Base64.

Ottieni i contenuti delle risorse FHIR create, aggiornate o con patch

per includere i contenuti completi di una risorsa FHIR quando crei, aggiorni o una patch per la risorsa, imposta sendFullResource su true.

Questo comportamento non si applica se elimini una risorsa FHIR. Se elimini un Risorsa FHIR e sendFullResource è impostato su true ma sendPreviousResourceOnDelete è impostato su false, la notifica è la stessa di quando recuperi solo Nome risorsa FHIR. per includere la risorsa FHIR quando una risorsa FHIR viene eliminata, consulta l'articolo su come ottenere l'eliminazione dei contenuti di una risorsa FHIR.

Quando visualizzi la notifica, l'oggetto message è simile al seguente:

{
  "message": {
    "attributes": {
      "action": "{CreateResource|PatchResource|UpdateResource}",
      "lastUpdatedTime": "RFC_1123_FORMAT_DATETIME",
      "payloadType": "FullResource",
      "resourceType": "FHIR_RESOURCE_TYPE",
      "storeName": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
      "versionId": "VERSION_ID"
    },
    "data": "BASE64_ENCODED_FHIR_RESOURCE_CONTENTS",
    "messageId": "MESSAGE_ID",
    "publishTime": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ"
  }
}

Nella notifica, tieni presente quanto segue:

  • payloadType è impostato su FullResource per indicare che sendFullResource è impostato su true. Tutti i contenuti della risorsa FHIR sono inclusi nel campo data come stringa codificata in base 64.
  • Il campo data contiene i contenuti della risorsa FHIR come stringa con codifica in base 64.

Ottieni contenuti delle risorse FHIR eliminati

Per includere i contenuti completi di una risorsa FHIR quando la elimini, imposta sendPreviousResourceOnDelete su true.

Quando visualizzi la notifica, l'oggetto message è simile al seguente:

{
  "message": {
    "attributes": {
      "action": "DeleteResource",
      "lastUpdatedTime": "RFC_1123_FORMAT_DATETIME",
      "payloadType": "FullResource",
      "resourceType": "FHIR_RESOURCE_TYPE",
      "storeName": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
      "versionId": "VERSION_ID"
    },
    "data": "BASE64_ENCODED_FHIR_RESOURCE_CONTENTS",
    "messageId": "MESSAGE_ID",
    "publishTime": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ"
  }
}

Prendi nota dei valori nei seguenti campi:

  • payloadType è impostato su FullResource anche se sendFullResource è impostato su false.

    Tutti i contenuti della risorsa FHIR sono inclusi nel campo data come stringa codificata in base 64.

  • Il campo data contiene i contenuti della risorsa FHIR come stringa con codifica in base 64 prima dell'eliminazione della risorsa.

Configura e visualizza le notifiche FHIR

I seguenti esempi mostrano come visualizzare il Pub/Sub generato quando viene creata una risorsa FHIR in un datastore FHIR.

Prima di iniziare

Prima di configurare e utilizzare le notifiche Pub/Sub, completa la sezioni seguenti:

Rivedi la quota Pub/Sub

Acquisisci familiarità con quote e limiti di Pub/Sub. Per informazioni su come visualizzare la quota, richiederne una e cosa succede Se esaurisci la quota, consulta Utilizzo delle quote.

Abilita l'API Pub/Sub

Nella console Google Cloud, abilita l'API Pub/Sub:

Abilitare l'API

Configura autorizzazioni Pub/Sub

Consentire la pubblicazione dei messaggi dall'API Cloud Healthcare in Pub/Sub, devi aggiungere il ruolo pubsub.publisher l'account di servizio dell'agente di servizio Cloud Healthcare del tuo progetto. Vedi le autorizzazioni Pub/Sub per datastore FHIR, FHIR e HL7v2 per istruzioni su come aggiungere il ruolo richiesto.

crea un argomento Pub/Sub

Per creare un argomento, consulta Creare un argomento.

I singoli datastore possono avere il proprio argomento Pub/Sub oppure più datastore possono lo stesso argomento.

Utilizza il formato seguente quando specifichi l'argomento Pub/Sub:

projects/PROJECT_ID/topics/TOPIC_NAME

PROJECT_ID è l'ID del tuo progetto Google Cloud TOPIC_NAME è il nome dell'argomento Pub/Sub.

crea una sottoscrizione Pub/Sub

Per ricevere messaggi pubblicati in un argomento, devi creare un Sottoscrizione Pub/Sub. Ogni evento L'argomento Pub/Sub richiede almeno un Pub/Sub abbonamento. La sottoscrizione collega l'argomento a un'applicazione del sottoscrittore che riceve ed elabora i messaggi pubblicati nell'argomento.

Per creare una sottoscrizione e collegarla a un argomento Pub/Sub, consulta Crea abbonamenti.

Crea o modifica un datastore FHIR

Crea o modifica un datastore FHIR con un oggetto FhirNotificationConfig configurato.

Gli esempi riportati di seguito mostrano come modificare un datastore FHIR esistente. I campi sendFullResource e sendPreviousResourceOnDelete sono impostati a true, il che significa che le notifiche contengono i contenuti completi della risorsa FHIR quando una risorsa viene creata, aggiornata, sottoposta a patch o eliminata.

REST

Per modificare il datastore FHIR, utilizza il metodo projects.locations.datasets.fhirStores.patch.

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

  • PROJECT_ID: l'ID del tuo progetto Google Cloud
  • LOCATION: la posizione del set di dati
  • DATASET_ID: il set di dati padre del datastore FHIR
  • FHIR_STORE_ID: l'ID del datastore FHIR
  • PUBSUB_TOPIC_ID: l'ID argomento Pub/Sub

Corpo JSON della richiesta: 

{
  "notificationConfigs": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/PUBSUB_TOPIC_ID",
      "sendFullResource": true,
      "sendPreviousResourceOnDelete": true
    }
  ]
}

Per inviare la richiesta, scegli una delle seguenti opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json. Esegui questo comando nel terminale per creare o sovrascrivere questo file nella directory corrente: 

cat > request.json << 'EOF'
{
  "notificationConfigs": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/PUBSUB_TOPIC_ID",
      "sendFullResource": true,
      "sendPreviousResourceOnDelete": true
    }
  ]
}
EOF

Quindi, esegui questo comando per inviare la richiesta REST: 

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=notificationConfigs"

PowerShell

Salva il corpo della richiesta in un file denominato request.json. Esegui questo comando nel terminale per creare o sovrascrivere questo file nella directory corrente: 

@'
{
  "notificationConfigs": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/PUBSUB_TOPIC_ID",
      "sendFullResource": true,
      "sendPreviousResourceOnDelete": true
    }
  ]
}
'@  | Out-File -FilePath request.json -Encoding utf8

Quindi, esegui questo comando per inviare la richiesta REST: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=notificationConfigs" | Select-Object -Expand Content

Dovresti ricevere una risposta JSON simile alla seguente:

crea una risorsa FHIR

Crea una risorsa FHIR nel datastore FHIR. La richiesta fa sì che l'API Cloud Healthcare pubblichi un nell'argomento Pub/Sub configurato.

Visualizza la notifica Pub/Sub

Visualizza il messaggio pubblicato nell'argomento Pub/Sub. Il seguente messaggio quando è stata creata una risorsa Patient in un datastore FHIR.

Nell'output di esempio, i contenuti della risorsa FHIR sono in un formato con codifica Base64 nel campo data. Devi decodificare il valore con codifica base64 per ottenere nei contenuti. La maggior parte delle piattaforme e dei sistemi operativi dispone di strumenti per la decodifica del testo in base64.

REST

Per visualizzare il messaggio pubblicato nell'argomento Pub/Sub, utilizza il projects.subscriptions.pull . Nell'esempio seguente viene utilizzato il parametro di query ?maxMessages=10 per specificare il numero massimo di messaggi da restituire nella richiesta. Puoi regolare il valore in base alle tue esigenze.

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

  • PROJECT_ID: l'ID del tuo progetto Google Cloud
  • PUBSUB_SUBSCRIPTION_ID: l'ID della sottoscrizione collegata all'argomento Pub/Sub configurato nell'archivio FHIR

Per inviare la richiesta, scegli una delle seguenti opzioni:

curl

Esegui questo comando: 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://pubsub.googleapis.com/v1/projects/PROJECT_ID/subscriptions/PUBSUB_SUBSCRIPTION_ID:pull?maxMessages=10"

PowerShell

Esegui questo comando: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://pubsub.googleapis.com/v1/projects/PROJECT_ID/subscriptions/PUBSUB_SUBSCRIPTION_ID:pull?maxMessages=10" | Select-Object -Expand Content

Dovresti ricevere una risposta JSON simile alla seguente:

gcloud

Per visualizzare il messaggio pubblicato nell'argomento Pub/Sub, esegui il gcloud pubsub subscriptions pull .

L'esempio utilizza i seguenti flag di Google Cloud CLI:

  • --format=json: esegue il rendering dell'output come JSON.
  • --auto-ack: conferma automaticamente ogni messaggio di cui è stato eseguito il pull.

Prima di utilizzare uno qualsiasi dei dati di comando riportati di seguito, effettua le seguenti sostituzioni:

  • PROJECT_ID: l'ID del tuo progetto Google Cloud
  • PUBSUB_SUBSCRIPTION_ID: l'ID della sottoscrizione collegata all'argomento Pub/Sub configurato nell'archivio FHIR

Esegui la persone che seguo :

Linux, macOS o Cloud Shell

gcloud pubsub subscriptions pull \
    projects/PROJECT_ID/subscriptions/PUBSUB_SUBSCRIPTION_ID \
    --auto-ack \
    --format=json

Windows (PowerShell)

gcloud pubsub subscriptions pull `
    projects/PROJECT_ID/subscriptions/PUBSUB_SUBSCRIPTION_ID `
    --auto-ack `
    --format=json

Windows (cmd.exe)

gcloud pubsub subscriptions pull ^
    projects/PROJECT_ID/subscriptions/PUBSUB_SUBSCRIPTION_ID ^
    --auto-ack ^
    --format=json

Dovresti ricevere una risposta simile alla seguente:

[
  {
    "ackId": "RFAGFixdRkhRNxkIaFEOT14jPzUgKEUaAggUBXx9cEFLdVhUcGhRDRlyfWB9bQ5GAgpGWixfURsHaE5tdR",
    "ackStatus": "SUCCESS",
    "message": {
      "attributes": {
        "action": "CreateResource",
        "lastUpdatedTime": "Mon, 01 Jan 2020 00:00:00 UTC",
        "payloadType": "FullResource",
        "resourceType": "Patient",
        "storeName": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
        "versionId": "MTY4MzA2MDQzOTI5NjIxMDAwMA"
      },
      "data": "wogICJiaXJ0aERhdGUiOiAiMTk3MC0wMS0wMSIsCiAgImdlbmRlciI6ICJmZW1hbGUiLAogICJpZCI6ICIyYmMwODg4Yi00MGRmLTQwYzctOWRhYi0wMzc4YTFiZWE0MGIiLAogICJtZXRhIjogewogICAgImxhc3RVcGRhdGVkIjogIjIwMjMtMDUtMDJUMjA6NDc6MTkuMjk2MjEwKzAwOjAwIiwKICAgICJ2ZXJzaW9uSWQiOiAiTVRZNE16QTJNRFF6T1RJNU5qSXhNREF3TUEiCiAgfSwKICAibmFtZSI6IFsKICAgIHsKICAgICAgImZhbWlseSI6ICJTbWl0aCIsCiAgICAgICJnaXZlbiI6IFsKICAgICAgICAiRGFyY3kiCiAgICAgIF0sCiAgICAgICJ1c2UiOiAib2ZmaWNpYWwiCiAgICB9CiAgXSwKICAicmVzb3VyY2VUeXBlIjogIlBhdGllbnQiCn0=",
      "messageId": "7586159156345265",
      "publishTime": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ"
    }
  }
]

Comportamento quando una risorsa FHIR è troppo grande o il traffico è elevato

Se la dimensione di una risorsa FHIR è troppo grande, oppure l'API Cloud Healthcare i server stanno riscontrando un traffico elevato, il campo attributes potrebbe che contengono solo il nome della risorsa e non i contenuti completi. Questo comportamento si verifica anche se sendFullResource e sendPreviousResourceOnDelete impostati su true.

Per verificare se una notifica Pub/Sub contiene la risorsa FHIR completa, controlla il campo payloadType nella risposta dopo la visualizzazione della notifica. Se il criterio payloadType è impostato su nameOnly, il valore Il campo attributes non ha compilato completamente i dati della risorsa FHIR. Devi quindi recupera manualmente i contenuti della risorsa FHIR dal datastore FHIR o dal messaggio Pub/Sub.

Criterio di archiviazione dei messaggi dell'API Cloud Healthcare e di Pub/Sub

assicurare che i dati dell'API Cloud Healthcare e i dati associati in Pub/Sub che i messaggi risiedono nella stessa regione, devi impostare un criterio di archiviazione dei messaggi.

Devi impostare esplicitamente il criterio di archiviazione dei messaggi in Pub/Sub configurato nel datastore per garantire che i dati rimangano negli stessi regione. Ad esempio, se il set di dati dell'API Cloud Healthcare e il datastore FHIR sono in us-central1, il criterio di archiviazione dei messaggi deve consentire solo la regione us-central1.

Per configurare un criterio di archiviazione dei messaggi, vedi Configurazione dei criteri dell'archivio messaggi.

Risolvere i problemi relativi ai messaggi Pub/Sub persi

Se una notifica non può essere pubblicata in Pub/Sub, viene restituito un errore e log in Cloud Logging. Per ulteriori informazioni, vedi Visualizzazione dei log degli errori in Cloud Logging.

Se la percentuale di generazione di errori supera un limite, gli errori che superano il limite non vengono inviate a Cloud Logging.

Visualizza le notifiche FHIR utilizzando la configurazione NotificationConfig (deprecata)

La FhirStore una risorsa contiene NotificationConfig in cui puoi specificare un argomento Pub/Sub. Le modifiche alle risorse FHIR contengono sempre il seguente identificatore nella Campo data del messaggio Pub/Sub:

projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/RESOURCE_TYPE/RESOURCE_ID

Il seguente set di coppie chiave:valore è sempre incluso nel campo Campo attributes:

Nome dell'attributo Valori possibili Esempio Descrizione
action
  • CreateResource
  • PatchResource
  • UpdateResource
  • DeleteResource
 CreateResource Il tipo di evento che si è verificato.
resourceType Qualsiasi tipo di risorsa FHIR. Patient Il tipo di risorsa modificata.

Passaggi successivi