Questa pagina illustra le istruzioni di base per cercare risorse FHIR in un archivio FHIR. La ricerca delle risorse FHIR è il modo principale per eseguire query e ottenere approfondimenti dai dati FHIR.
Puoi cercare risorse FHIR nell'API Cloud Healthcare nei seguenti modi:
- Utilizzo del visualizzatore FHIR nella console Google Cloud.
- Utilizza il metodo
projects.locations.datasets.fhirStores.fhir.search
. Il metodo fornisce i seguenti modi per cercare le risorse FHIR:- Richieste
GET
- Richieste
POST
- Richieste
Questa pagina riassume molte delle funzionalità di ricerca di uso comune, ma non è un elenco esaustivo delle parti della specifica di ricerca FHIR supportate dall'API Cloud Healthcare.
Utilizzo del visualizzatore FHIR
Il visualizzatore FHIR è una pagina della console Google Cloud che ti consente di cercare e visualizzare i contenuti delle risorse FHIR.
Per cercare risorse in un archivio FHIR, completa i seguenti passaggi:
Nella console Google Cloud, vai alla pagina Visualizzatore FHIR.
Nell'elenco a discesa Archivio FHIR, seleziona un set di dati, quindi seleziona un archivio FHIR nel set di dati.
Per filtrare l'elenco dei tipi di risorse, cerca i tipi di risorse che vuoi visualizzare:
Fai clic sul campo Tipo di risorsa.
Nell'elenco a discesa Proprietà visualizzato, seleziona Tipo di risorsa.
Inserisci un tipo di risorsa.
Per cercare un altro tipo di risorsa, seleziona OPPURE dall'elenco a discesa Operatori visualizzato e inserisci un altro tipo di risorsa.
Nell'elenco dei tipi di risorse, seleziona il tipo di risorsa su cui vuoi eseguire la ricerca.
Nella casella di ricerca della tabella delle risorse visualizzata, inserisci il valore che vuoi cercare.
Il visualizzatore FHIR mostra i risultati di ricerca in una tabella. Dopo aver selezionato una risorsa, il visualizzatore FHIR ne mostra i contenuti.
Quando visualizzi i contenuti di una risorsa, puoi cercare i dati al suo interno.
Per cercare i dati all'interno di una risorsa:
Seleziona una risorsa.
Nel riquadro del Visualizzatore FHIR, fai clic sulla scheda Elementi.
Nella casella di ricerca, inserisci il valore da cercare.
Download di dati binari all'interno delle risorse FHIR
Per scaricare i dati binari disponibili associati a una risorsa nello visualizzatore FHIR:
Seleziona una risorsa.
Nel riquadro del Visualizzatore FHIR, fai clic sulla scheda Elementi.
Se necessario, espandi gli elementi per accedere all'elemento della risorsa richiesto.
Fai clic su Scarica file per scaricare i dati disponibili.
Creare ed eseguire query di ricerca avanzate
Puoi utilizzare le query di ricerca avanzata per cercare risorse FHIR specifiche utilizzando la specifica di ricerca FHIR.
Per creare una query di ricerca avanzata, completa i seguenti passaggi:
Nella pagina del visualizzatore FHIR, fai clic sulla scheda Ricerca.
Per creare una query di ricerca, fai clic su Apri Query Builder.
Viene visualizzato il riquadro Selezione query.
Nell'elenco Seleziona un tipo di risorsa FHIR, scegli il tipo di risorsa FHIR che vuoi cercare.
Fai clic su Continua.
Nell'elenco Parametro, seleziona il parametro da utilizzare per cercare le risorse.
Nell'elenco Modificatore, seleziona il modificatore da applicare alla query. L'elenco include solo i modificatori compatibili con il tipo di dati del parametro selezionato.
Questa è una selezione facoltativa. Se non è selezionato alcun modificatore, viene eseguito un controllo di uguaglianza.
Nel campo Valore, inserisci il valore del parametro di query.
Per aggiungere più di un valore parametro, fai clic su OPPURE. In questo modo puoi includere più valori del parametro della risorsa nella query di ricerca.
Mentre crei la query di ricerca, questa viene visualizzata nel riquadro Anteprima query. Per visualizzare l'URL completo della query di ricerca, fai clic su Mostra percorso completo.
Per aggiungere più di un parametro, fai clic su E.
Fai clic su Continua.
Per includere le risorse a cui fanno riferimento le risorse restituite nella query di ricerca, scegli il parametro della risorsa dall'elenco a discesa Parametri inclusi.
Per includere risorse che fanno riferimento alle risorse restituite nella query di ricerca, scegli il parametro della risorsa dall'elenco a discesa Inverti parametri inclusi.
Fai clic su Fine per salvare la query di ricerca.
La query di ricerca salvata viene visualizzata nel campo Operazione di ricerca FHIR.
Per cercare le risorse con la query, fai clic su Esegui ricerca.
I risultati di ricerca vengono visualizzati nell'elenco Risultati di ricerca. Per visualizzare i dettagli di una risorsa restituita dalla ricerca, fai clic su una risorsa nell'elenco.
Per salvare la query come modello di query, fai clic su Salva modello e scegli Salva modello o Salva modello come. Ti viene chiesto di fornire un nome e una descrizione per la query. I parametri di ricerca vengono salvati in un modello, ma eventuali valori definiti vengono rimossi.
Query di ricerca di esempio
L'esempio seguente mostra una query di ricerca che cerca le risorse Claim di un fornitore di servizi sanitari specifico, Practitioner/12345, per il mese di agosto 2021:
- Parametro:
care-team
- Valore:
Practitioner/12345
- Valore:
- Operatore: AND
- Parametro:
created
- Prefisso:
lt (lesser than)
- Valore:
8/1/21, 12:00 AM
- Prefisso:
- Operatore: AND
- Parametro:
created
- Prefisso:
gt (greater than)
- Valore:
8/31/21, 11:59 PM
- Prefisso:
Questo viene configurato come segue nel riquadro Selezione query e la query viene visualizzata in anteprima nel riquadro Anteprima query. La query verrà visualizzata nel campo Operazione di ricerca FHIR.
Modificare le query di ricerca
Per modificare una query di ricerca, esegui una delle seguenti operazioni:
- Per modificare la query in Query Builder, fai clic su Apri Query Builder.
- Per modificare manualmente la query, modifica i valori dei parametri nella casella di testo.
Eseguire modelli di query
Per eseguire una query da un modello salvato:
Fai clic su Modelli salvati.
Viene visualizzata la scheda Modelli di ricerca del riquadro Selezione query, che mostra tutti i modelli di query salvati.
Seleziona il modello di query che vuoi eseguire e fai clic su Fine.
La query di ricerca del modello viene visualizzata nel campo Operazione di ricerca FHIR senza valori.
Per definire i valori della query di ricerca, modifica i valori del parametro nel campo.
Fai clic su Esegui ricerca per cercare le risorse con la query.
Utilizzo del metodo search
Per cercare risorse FHIR con l'API REST, utilizza il metodo
projects.locations.datasets.fhirStores.fhir.search
. Puoi chiamare il metodo utilizzando le richieste GET
o POST
.
Utilizzo del metodo search
con GET
Gli esempi riportati di seguito mostrano come cercare le risorse in un determinato archivio FHIR utilizzando il metodo projects.locations.datasets.fhirStores.fhir.search
con GET
.
curl
Per cercare le risorse in un archivio FHIR, effettua una richiesta GET
e specifica le seguenti informazioni:
- Il nome del set di dati
- Il nome del datastore FHIR
- Il tipo di risorsa da cercare
- Una stringa di query contenente le informazioni che stai cercando, come descritto nella sezione Creare una query di ricerca
- Un token di accesso
Il seguente esempio mostra una richiesta GET
che utilizza curl
per cercare tutti i pazienti con il cognome "Smith".
curl -X GET \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient?family:exact=Smith"
Se la richiesta riesce, il server restituisce la risposta come Bundle
FHIR in formato JSON. Bundle.type
è searchset
e i risultati di ricerca sono voci nell'array Bundle.entry
. In questo esempio, la richiesta restituisce una singola risorsa Patient, inclusi i dati al suo interno:
{ "entry": [ { "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_ID", "resource": { "birthDate": "1970-01-01", "gender": "female", "id": "PATIENT_ID", "meta": { "lastUpdated": "LAST_UPDATED", "versionId": "VERSION_ID" }, "name": [ { "family": "Smith", "given": [ "Darcy" ], "use": "official" } ], "resourceType": "Patient" }, "search": { "mode": "match" } } ], "link": [ { "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/?family%3Aexact=Smith" } ], "resourceType": "Bundle", "total": 1, "type": "searchset" }
PowerShell
Per cercare le risorse in un archivio FHIR, effettua una richiesta GET
e specifica le seguenti informazioni:
- Il nome del set di dati
- Il nome del datastore FHIR
- Il tipo di risorsa da cercare
- Una stringa di query contenente le informazioni che stai cercando, come descritto nella sezione Creare una query di ricerca
- Un token di accesso
Il seguente esempio mostra una richiesta GET
mediante Windows PowerShell per cercare tutti i pazienti con il cognome "Smith".
$cred = gcloud auth application-default print-access-token $headers = @{ Authorization = "Bearer $cred" } Invoke-RestMethod ` -Method Get ` -Headers $headers ` -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/RESOURCE_TYPE?family:exact=Smith" | ConvertTo-Json
Se la richiesta riesce, il server restituisce la risposta come Bundle
FHIR
in formato JSON. Bundle.type
è searchset
e i risultati di ricerca sono voci nell'array Bundle.entry
. In questo esempio, la richiesta restituisce una singola risorsa Patient, inclusi i dati al suo interno:
{ "entry": [ { "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_ID", "resource": { "birthDate": "1970-01-01", "gender": "female", "id": "PATIENT_ID", "meta": { "lastUpdated": "LAST_UPDATED", "versionId": "VERSION_ID" }, "name": [ { "family": "Smith", "given": [ "Darcy" ], "use": "official" } ], "resourceType": "Patient" }, "search": { "mode": "match" } } ], "link": [ { "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/?family%3Aexact=Smith" } ], "resourceType": "Bundle", "total": 1, "type": "searchset" }
Java
Node.js
Python
Utilizzo del metodo search
con POST
Gli esempi riportati di seguito mostrano come cercare le risorse in un determinato archivio FHIR utilizzando il metodo projects.locations.datasets.fhirStores.fhir.search
con POST
.
curl
Per cercare le risorse in un archivio FHIR, effettua una richiesta POST
e specifica le seguenti informazioni:
- Il nome del set di dati
- Il nome del datastore FHIR
- Il tipo di risorsa da cercare
- Una stringa di query contenente le informazioni che stai cercando, come descritto nella sezione Creare una query di ricerca
- Un token di accesso
Il seguente esempio mostra una richiesta POST
che utilizza curl
per cercare tutti i pazienti con il cognome "Smith".
curl -X POST \ --data "" \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/fhir+json; charset=utf-8" \ "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/_search?family:exact=Smith"
Se la richiesta riesce, il server restituisce la risposta come Bundle
FHIR in formato JSON. Bundle.type
è searchset
e i risultati di ricerca sono voci nell'array Bundle.entry
. In questo esempio, la richiesta restituisce una singola risorsa Patient, inclusi i dati al suo interno:
{ "entry": [ { "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_ID", "resource": { "birthDate": "1970-01-01", "gender": "female", "id": "PATIENT_ID", "meta": { "lastUpdated": "LAST_UPDATED", "versionId": "VERSION_ID" }, "name": [ { "family": "Smith", "given": [ "Darcy" ], "use": "official" } ], "resourceType": "Patient" }, "search": { "mode": "match" } } ], "link": [ { "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/?family%3Aexact=Smith" } ], "resourceType": "Bundle", "total": 1, "type": "searchset" }
PowerShell
Per cercare le risorse in un archivio FHIR, effettua una richiesta POST
e specifica le seguenti informazioni:
- Il nome del set di dati
- Il nome del datastore FHIR
- Il tipo di risorsa da cercare
- Una stringa di query contenente le informazioni che stai cercando, come descritto nella sezione Creare una query di ricerca
- Un token di accesso
Il seguente esempio mostra una richiesta POST
mediante Windows PowerShell per cercare tutti i pazienti con il cognome "Smith".
$cred = gcloud auth application-default print-access-token $headers = @{ Authorization = "Bearer $cred" } Invoke-RestMethod ` -Method Post ` -Headers $headers ` -ContentType: "application/fhir+json; charset=utf-8" ` -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/_search?family:exact=Smith" | ConvertTo-Json
Se la richiesta riesce, il server restituisce la risposta come Bundle
FHIR in formato JSON. Bundle.type
è searchset
e i risultati di ricerca sono voci nell'array Bundle.entry
. In questo esempio, la richiesta restituisce una singola risorsa Patient, inclusi i dati al suo interno:
{ "entry": [ { "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_ID", "resource": { "birthDate": "1970-01-01", "gender": "female", "id": "PATIENT_ID", "meta": { "lastUpdated": "LAST_UPDATED", "versionId": "VERSION_ID" }, "name": [ { "family": "Smith", "given": [ "Darcy" ], "use": "official" } ], "resourceType": "Patient" }, "search": { "mode": "match" } } ], "link": [ { "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/?family%3Aexact=Smith" } ], "resourceType": "Bundle", "total": 1, "type": "searchset" }
Java
Node.js
Python
Creazione di una query di ricerca
La stringa di query è una serie di coppie name=value
codificate in formato URL. Una ricerca
combina tutte le coppie con un AND
logico. Ogni valore può essere un
elenco di valori separati da virgole, che vengono trattati come un OR
logico di questi
valori. Ad esempio, Patient?key1=value1&key2=value2,value3
è una ricerca nelle risorse per i pazienti utilizzando i seguenti criteri:
(key1 = value1) AND (key2 = value2 OR key2 = value3)
Non esiste una sintassi per eseguire un OR
di due coppie di name=value
.
Ogni tipo di risorsa FHIR definisce i propri parametri di ricerca in ogni versione di FHIR. I parametri disponibili sono documentati nella specifica FHIR per ogni risorsa. Per un esempio, consulta Paziente FHIR R4. Puoi recuperare i parametri in modo programmatico tramite l'istruzione di abilitazione. L'API Cloud Healthcare supporta la maggior parte dei parametri di ricerca. Puoi trovare le esclusioni tramite la dichiarazione delle funzionalità o la dichiarazione di conformità FHIR.
Paginazione e ordinamento
Il numero di risorse restituite in ogni pagina dei risultati di ricerca FHIR dipende dai seguenti fattori:
- Il parametro
_count
. Controlla il numero massimo di risorse riportate dal metodo di ricerca. Ad esempio,_count=10
restituisce al massimo 10 risorse corrispondenti alla query. Il valore predefinito è 100 e il valore massimo consentito è 1000. - Le dimensioni dei dati di risposta. Una pagina di risultati di ricerca potrebbe restituire meno risorse rispetto al valore specificato nel parametro
_count
se le dimensioni della risposta sono elevate.
Se una ricerca restituisce più risorse rispetto al numero di risorse che possono essere visualizzate in una pagina, la risposta include un URL di paginazione nel campo Bundle.link
. In questo campo possono essere restituiti più valori. Il valore con Bundle.link.relation = next
indica che puoi utilizzare il corrispondente Bundle.link.url
per recuperare la pagina successiva.
Il valore di Bundle.total
indica il numero totale di risorse corrispondenti. Questo valore è esatto se i risultati rientrano interamente in una pagina, ma diventa una stima approssimativa quando il numero di risultati è superiore a una pagina.
Puoi ottenere un totale esatto per una ricerca che corrisponde a molti risultati seguendo ripetutamente i link di paginazione fino a quando i risultati non sono esauriti.
Per ulteriori informazioni sull'impaginazione e sui totali di ricerca, consulta Implementazione dell'impaginazione e dei totali di ricerca con la ricerca FHIR.
Puoi ordinare i risultati utilizzando il parametro _sort
, che accetta un
elenco separato da virgole di nomi di parametri di ricerca in ordine di priorità. Puoi
utilizzare un prefisso -
per indicare l'ordine decrescente. Ad esempio, la seguente query ordina in ordine crescente in base allo stato, suddividendo i risultati in ordine decrescente in base alla data e suddividendo eventuali risultati rimanenti in ordine crescente in base alla categoria:
_sort=status,-date,category
Ritardo nell'indicizzazione
Le risorse FHIR vengono indicizzate in modo asincrono, pertanto potrebbe esserci un leggero ritardo tra il momento in cui una risorsa viene creata o modificata e il momento in cui la modifica si riflette nei risultati di ricerca. L'unica eccezione sono i dati degli identificatori delle risorse,
che vengono indicizzati in modo sincrono come indice speciale. Di conseguenza, la ricerca utilizzando
l'identificatore della risorsa non è soggetta a ritardi di indicizzazione. Per utilizzare l'indice
sincronico speciale, il termine di ricerca per l'identificatore deve avere il pattern
identifier=[system]|[value]
o identifier=[value]
e puoi utilizzare uno dei seguenti
parametri dei risultati di ricerca:
_count
_include
_revinclude
_summary
_elements
Se la query contiene altri parametri di ricerca, verrà utilizzato l'indice asincrono standard. Tieni presente che la ricerca nell'indice speciale è ottimizzata per la risoluzione di un numero ridotto di corrispondenze. La ricerca non è ottimizzata se i criteri di ricerca dell'identificatore corrispondono a un numero elevato (ad es. più di 2000) di risorse. Per una query di ricerca che corrisponde a un numero elevato di risorse, puoi evitare di utilizzare l'indice sincrono speciale includendo un parametro _sort
aggiuntivo nella query. Utilizza _sort=-_lastUpdated
se vuoi mantenere
l'ordine di ordinamento predefinito.
Ricerca in tutti i tipi di risorse
Alcuni parametri di ricerca, indicati da un'underscore iniziale come _id
,
si applicano a tutti i tipi di risorse. Questi parametri per tutte le risorse sono elencati nella
specifica FHIR per il tipo di risorsa.
Quando utilizzi questi parametri di ricerca, puoi eseguire una ricerca in più tipi di risorse omettendo il tipo di risorsa dal percorso della richiesta. Ad esempio,
l'utilizzo di GET .../fhir?_id=1234
anziché GET .../fhir/Patient?_id=1234
consente di eseguire ricerche
in tutte le risorse FHIR anziché solo in una risorsa Patient. Puoi utilizzare il parametro speciale _type
con questo tipo di richiesta per limitare i risultati a un elenco di tipi di risorse separati da virgola. Ad esempio, la seguente query
restituisce solo risultati corrispondenti per le risorse Observation
e Condition
:
GET .../fhir?_tag=active&_type=Observation,Condition
Tipi di dati
Ogni parametro di ricerca definito da FHIR ha un tipo di dato, che include tipi primitivi come i seguenti:
- Stringa
- Numero
- Data
I tipi di dati includono anche i seguenti tipi complessi:
- Token
- Riferimento
- Quantità
Ogni tipo di dati ha una propria sintassi per specificare i valori. Ogni tipo di dati supporta modificatori che alterano il modo in cui viene eseguita la ricerca.
Le sezioni seguenti mostrano come utilizzare i tipi di dati. Per ulteriori dettagli su tipi di dati, sintassi dei valori e modificatori aggiuntivi, consulta Funzionalità di ricerca FHIR avanzate.
Numero
Cerca valori interi o con rappresentazione in virgola mobile. Per modificare il comparatore, anteponi al valore uno dei seguenti modificatori:
ne
lt
le
gt
ge
Ad esempio, utilizza [parameter]=100
per l'uguaglianza o [parameter]=ge100
per valori superiori o uguali a 100.
Data
Cerca su qualsiasi tipo di data, ora o periodo. Il formato del parametro data è il seguente:
yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm]
Si applicano gli stessi modificatori di prefisso utilizzati per number.
Stringa
Per impostazione predefinita, viene eseguita una ricerca di prefisso insensibile alle maiuscole, agli accenti o ad altri segni diacritici.
Token
Cerca una corrispondenza esatta di una stringa di un "codice". Puoi limitare la ricerca all'URI di un "sistema" che indica il valore impostato da cui viene estratto il codice utilizzando il seguente formato:
[parameter]=[system]|[code]
Ad esempio, la seguente ricerca corrisponde a un codice di 10738-3, ma solo se qualificato come valore di un sistema di codifica con l'URI specificato:
code=http://hl7.org/fhir/ValueSet/observation-codes|10738-3
Quantità
Cerca un valore numerico utilizzando gli stessi modificatori di prefisso di number. Puoi specificare la ricerca con un sistema e un codice specifici che indicano le unità del valore nel seguente formato:
[parameter]=[prefix][number]|[system]|[code]
Ad esempio, la seguente query cerca valori di quantità inferiori a 9,1 con il sistema di unità e il codice specificati:
value-quantity=lt9.1|http://unitsofmeasure.org|mg
Riferimento
Cerca i riferimenti tra le risorse. Puoi utilizzare le seguenti query per i riferimenti alle risorse all'interno di un datastore FHIR:
[parameter]=[id]
[parameter]=[type]/[id]
Puoi utilizzare [parameter]=[url]
per specificare i riferimenti tramite URL
che potrebbero non essere all'interno del datastore FHIR.
Gestione dei parametri di ricerca
Per impostazione predefinita, il metodo di ricerca applica la gestione "permissiva", che ignora i parametri non riconosciuti dalla ricerca. Il metodo di ricerca esegue la ricerca utilizzando eventuali parametri rimanenti nella richiesta, il che potrebbe restituire più risorse del previsto.
La risposta include quanto segue:
- Un valore in
Bundle.link
con un valore diBundle.link.relation = self
- Un
Bundle.link.url
di un URL contenente solo i parametri che sono stati applicati correttamente alla ricerca. Puoi esaminare questo valore per determinare se sono stati ignorati parametri.
Puoi impostare l'intestazione HTTP della richiesta su Prefer: handling=strict
in una richiesta di ricerca. L'impostazione dell'intestazione fa sì che il datastore FHIR restituisca un errore per qualsiasi parametro non riconosciuto.