Gli archivi FHIR all'interno dell'API Cloud Healthcare supportano più versioni della specifica Fast Healthcare Interoperability Resources (FHIR) pubblicata da Health Level 7 International (HL7).
L'API v1 supporta le seguenti versioni:
- R4 versione 4.0.1 (Release 4)
- STU3 versione 3.0.1 (Release 3 - Standard per l'uso di prova)
- DSTU2 versione 1.0.2 (bozza di standard per l'uso di prova)
Quando crei un archivio FHIR, specifichi la versione FHIR come parametro per il metodo fhirStores.create
. Non puoi modificare la versione FHIR dopo aver creato l'archivio.
L'interfaccia API per ogni archivio è conforme alla versione FHIR dell'archivio. Ad esempio, l'interazione conformance
di DSTU2 è diversa dall'interazione capabilities
STU3, ma entrambe condividono il percorso REST /fhir/metadata
, pertanto il percorso restituisce risposte diverse in base alla versione FHIR dell'archivio.
La funzionalità aggiunta nelle versioni FHIR successive è disponibile negli archivi che utilizzano le versioni FHIR precedenti se non crea incompatibilità. Ad esempio, l'interazione patch
è disponibile in un archivio DSTU2 anche se questa interazione è definita
solo a partire da STU3.
Dettagli delle funzionalità supportate nell'API v1 dalla versione FHIR
R4
La dichiarazione di capacità del server indica le parti della specifica supportate.
- Archiviazione e recupero di tutte le risorse R4, compreso il supporto per gli elementi di estensione. L'API accetta, archivia e restituisce le estensioni su qualsiasi elemento di dati.
- Tutti i metodi dell'API RESTful che utilizzano il tipo di contenuti JSON sono supportati, ad eccezione di:
- Le interazioni della cronologia a livello di tipo e di sistema che recuperano la cronologia su più risorse non sono supportate. La cronologia delle risorse può essere recuperata per una sola risorsa alla volta.
- L'interazione batch/transaction non supporta le operazioni di ricerca all'interno del bundle.
- La convalida e l'applicazione forzata del profilo sono supportate.
- I parametri di ricerca definiti dall'utente, comprese le ricerche negli elementi delle estensioni, sono supportati nell'API v1beta1.
Sono supportate tutte le funzionalità di ricerca, ad eccezione di:
- I parametri di ricerca
Group-characteristic-value
,Location-near
,Bundle-composition
eBundle-message
non sono supportati. - I parametri di ricerca che eseguono la corrispondenza fonetica non sono supportati.
- I parametri del risultato di ricerca
_contained
,_containedType
,_summary=count
e_summary=true
non sono supportati. - Il parametro di ricerca speciale
_content
cerca in tutti i campi della risorsa a cui fanno riferimento i parametri di ricerca. Sono esclusi i campi che non sono disponibili per la ricerca. Non supporta i valoriAND
espliciti (i termini sono implicitamente combinati conAND
) o le parentesi. - I parametri di ricerca speciali
_query
,_filter
e_list
non sono supportati. - Se utilizzato su campi con elementi ripetuti, il parametro
_sort
viene ordinato in base al primo elemento; differisce dalla specifica. Tutti i parametri di ricerca supportati sono idonei per_sort
, ad eccezione del parametro di ricerca speciale_content
. - Il modificatore di ricerca dei token
:of-type
e il modificatore di ricerca del riferimento:identifier
non sono supportati. - Le ricerche di riferimenti canonici non sono supportate. I riferimenti canonici vengono trattati come normali riferimenti.
- Quando utilizzi il parametro
_type
, puoi utilizzare solo i parametri di ricerca comuni (per tutte le risorse) e non l'intersezione dei tipi di risorse specificati. Sono supportati i seguenti sottoinsiemi di parametri di ricerca compositi:
DocumentReference-relationship
Observation-code-value-concept
Observation-code-value-date
Observation-code-value-quantity
Observation-code-value-string
Observation-combo-code-value-concept
Observation-combo-code-value-quantity
Observation-component-code-value-concept
Observation-component-code-value-quantity
I restanti parametri di ricerca composita non sono supportati.
La ricerca che utilizza il metodo
POST
non accetta i parametriapplication/x-www-form-urlencoded
nel corpo della richiesta.Il carattere jolly (
*
) è supportato per_include
, ma non per_revinclude
.
- I parametri di ricerca
Le aree non supportate includono:
- La maggior parte delle operazioni estese non viene implementata.
- Il tipo di contenuti XML non è supportato.
- L'operazione di patch non supporta la patch XML o la patch
FHIRPath
. - Le richieste HEAD HTTP non sono supportate.
- L'endpoint
ExecuteBundle
non accetta pacchettihistory
.
STU3
La dichiarazione di capacità del server indica le parti della specifica supportate.
- Sono supportati l'archiviazione e il recupero di tutte le risorse STU3, incluso il supporto per gli elementi di estensione. L'API accetta, archivia e restituisce le estensioni su qualsiasi elemento di dati.
Tutti i metodi dell'API RESTful che utilizzano il tipo di contenuti JSON sono supportati, ad eccezione di:
- Le interazioni della cronologia a livello di tipo e di sistema che recuperano la cronologia su più risorse non sono supportate. La cronologia delle risorse può essere recuperata per una sola risorsa alla volta.
- L'interazione batch/transaction non supporta le operazioni di ricerca all'interno del bundle.
La convalida e l'applicazione forzata del profilo sono supportate.
I parametri di ricerca definiti dall'utente, comprese le ricerche negli elementi delle estensioni, sono supportati nell'API v1beta1.
Sono supportate tutte le funzionalità di ricerca, ad eccezione di:
- I parametri di ricerca
Group-characteristic-value
,Sequence-coordinate
,Location-near
,Location-near-distance
,Bundle-composition
eBundle-message
non sono supportati. - I parametri di ricerca che eseguono la corrispondenza fonetica non sono supportati.
- I parametri del risultato di ricerca
_contained
,_containedType
,_summary=count
e_summary=true
non sono supportati. - Il parametro di ricerca speciale
_content
cerca in tutti i campi della risorsa a cui fanno riferimento i parametri di ricerca. Vengono esclusi i campi non disponibili per la ricerca. Non supportaAND
esplicito (i termini sono implicitamente combinati con AND) o parentesi. - I parametri di ricerca speciali
_query
,_filter
e_list
non sono supportati. - Se utilizzato su campi con elementi ripetuti, il parametro
_sort
viene ordinato in base al primo elemento; differisce dalla specifica. Tutti i parametri di ricerca supportati sono idonei per_sort
, ad eccezione del parametro di ricerca speciale_content
. - La ricerca che utilizza il metodo
POST
non accetta i parametriapplication/x-www-form-urlencoded
nel corpo della richiesta. - Il carattere jolly (
*
) è supportato per_include
, ma non per_revinclude
.
- I parametri di ricerca
Le aree non supportate includono:
- La maggior parte delle operazioni estese non viene implementata.
- Il tipo di contenuti XML non è supportato.
- L'operazione di patch non supporta la patch XML o la patch FHIRPath.
DSTU2
L'dichiarazione di conformità del server indica le parti della specifica supportate.
- Sono supportati l'archiviazione e il recupero di tutte le risorse DSTU2, compreso il supporto per gli elementi di estensione. L'API accetta, archivia e restituisce le estensioni su qualsiasi elemento di dati.
- Tutti i metodi dell'API RESTful che utilizzano il tipo di contenuti JSON sono supportati, ad eccezione di:
- Le interazioni della cronologia a livello di tipo e di sistema che recuperano la cronologia su più risorse non sono supportate. La cronologia delle risorse può essere recuperata per una sola risorsa alla volta.
- L'interazione batch/transaction non supporta le operazioni di ricerca all'interno del bundle.
- La convalida e l'applicazione forzata del profilo sono supportate.
- Sono supportate tutte le funzionalità di ricerca, ad eccezione di:
- I parametri di ricerca
Group-characteristic-value
,Location-near
,Location-near-distance
,Bundle-composition
,Bundle-message
,Coverage-dependent
eCoverage-sequence
non sono supportati. - I parametri di ricerca definiti negli elementi delle estensioni non sono supportati.
- I parametri di ricerca che eseguono la corrispondenza fonetica non sono supportati.
- I parametri del risultato di ricerca
_contained
,_containedType
,_summary=count
e_summary=true
non sono supportati. - Il parametro di ricerca speciale
_content
cerca in tutti i campi della risorsa a cui fanno riferimento i parametri di ricerca. Vengono esclusi i campi non disponibili per la ricerca. Non supportaAND
esplicito (i termini sono implicitamente combinati con AND) o parentesi. - I parametri di ricerca speciali
_query
,_filter
e_list
non sono supportati. - Se utilizzato su campi con elementi ripetuti, il parametro
_sort
viene ordinato in base al primo elemento; differisce dalla specifica. Tutti i parametri di ricerca supportati sono idonei per_sort
, ad eccezione del parametro di ricerca speciale_content
. - La ricerca che utilizza il metodo
POST
non accetta i parametriapplication/x-www-form-urlencoded
nel corpo della richiesta. - Il carattere jolly (
*
) è supportato per_include
, ma non per_revinclude
.
- I parametri di ricerca
Le aree non supportate includono:
- La maggior parte delle operazioni estese non viene implementata.
- I parametri di ricerca definiti dall'utente non sono supportati per DSTU2.
- Il tipo di contenuti XML non è supportato.
Dettagli delle operazioni al di fuori della specifica pubblicata
- L'API FHIR gRPC offre un'interfaccia RPC per FHIR utilizzando il framework gRPC. Non è standard, è in fase di sviluppo e non supporta tutti i metodi FHIR.
- La configurazione dell'archivio FHIR include un'opzione per notificare un argomento Pub/Sub specificato dall'utente per tutte le modifiche alle risorse nell'archivio. Questo meccanismo di notifica è comune a tutti gli archivi dell'API Cloud Healthcare e non è destinato a sostituire le funzionalità degli abbonamenti FHIR (DSTU2, STU3 e R4).
- L'operazione di esportazione degli archivi FHIR nelle destinazioni Cloud Storage offre solo un'esportazione collettiva dell'intero archivio. Non è un'implementazione della bozza della bozza FHIR Bulk Data.
- L'operazione di importazione dell'archivio FHIR non è definita nella specifica.
- L'operazione
Resource-purge
che rimuove le versioni cronologiche delle risorse non è definita nella specifica. Questa API potrebbe cambiare in futuro se il processo degli standard o altre implementazioni FHIR convergono su un metodo API diverso per questo caso d'uso.