I datastore FHIR all'interno dell'API Cloud Healthcare supportano più versioni di le risorse Fast Healthcare Interoperability (FHIR) specifica 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 uso di prova)
- DSTU2 versione 1.0.2 (Bozza standard per l'uso di prova)
Quando crei un datastore FHIR, specifichi la versione FHIR come parametro
il metodo fhirStores.create
. Non puoi modificare la versione FHIR dopo la creazione dell'archivio.
L'interfaccia API di ogni datastore è conforme alla versione FHIR del datastore. Per
Ad esempio, l'interazione conformance
DSTU2 è diversa da STU3
interazione capabilities
, ma entrambi condividono il percorso REST /fhir/metadata
,
il percorso restituisce risposte diverse in base alla versione FHIR del datastore.
La funzionalità aggiunta nelle versioni FHIR successive è disponibile nei datastore che utilizzano versioni FHIR precedenti se non crea incompatibilità. Ad esempio, l'interazione patch
è disponibile in un negozio DSTU2 anche se è stata definita solo
da STU3 in poi.
Dettagli delle funzionalità supportate nell'API v1 in base alla versione FHIR
R4
La dichiarazione di capacità del server indica le parti della specifica che sono supportate.
- Archiviazione e recupero di tutte le risorse R4, incluso il supporto per gli elementi di estensione. L'API accetta, archivia e restituisce estensioni per qualsiasi elemento di dati.
- Tutti i metodi nella
API RESTful
che utilizzano il tipo di contenuto JSON, ad eccezione di:
- Le interazioni con history a livello di tipo e di sistema che recuperano la cronologia in più risorse non sono supportate. La cronologia delle risorse può essere recuperata solo per una risorsa alla volta.
- La batch/transaction l'interazione non supporta le operazioni di ricerca all'interno del bundle.
- Profilo e la convalida e l'applicazione forzata.
- I parametri di ricerca definiti dall'utente, incluse le ricerche negli elementi dell'estensione, sono supportati nell'API v1beta1.
Tutta la ricerca è supportata, 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 dei risultati di ricerca
_contained
,_containedType
,_summary=count
e_summary=true
non sono supportati. - Il parametro di ricerca speciale
_content
esegue ricerche 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 contenuti espliciti diAND
(i termini sono implicitamente combinato conAND
) o parentesi. - I parametri di ricerca speciali
_query
,_filter
e_list
non sono supportati. - Il parametro
_sort
, se utilizzato in campi con elementi ripetuti, ordina in base al primo elemento; differisce dalla specifica. Tutti i parametri di ricerca supportati sono idonei per_sort
, ad eccezione dei parametro di ricerca speciale_content
. - Il modificatore di ricerca dei token
:of-type
e il modificatore di ricerca di riferimento:identifier
non sono supportati. - Le ricerche nei riferimenti canonici non sono supportate. Riferimenti canonici vengono trattati come normali riferimenti.
- Quando utilizzi il parametro
_type
, possono essere utilizzati solo i parametri di ricerca comuni (per tutte le risorse) e non l'intersezione dei tipi di risorse specificati. È supportato il seguente sottoinsieme 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
Gli altri parametri di ricerca composita non sono supportati.
La ricerca utilizzando il metodo
POST
non accetta parametriapplication/x-www-form-urlencoded
nel corpo della richiesta.Il carattere jolly (
*
) è supportato per_include
, ma non è supportato per_revinclude
.
- I parametri di ricerca
Le aree non supportate includono:
- La maggior parte delle operazioni estese non è implementata.
- Il tipo di contenuto XML non è supportato.
- L'operazione di applicazione patch non supporta XML Patch o
FHIRPath
Patch. - Le richieste HTTP HEAD non sono supportate.
Aree in cui l'API si discosta dalla specifica FHIR per consentire la compatibilità con le versioni precedenti:
null
è accettato per i campi obbligatori- Per i campi obbligatori è accettato un codice vuoto
urn:uuid
riferimenti consentiti nei bundle batch
STU3
L'input del server dichiarazione di capacità indica le parti della specifica supportate.
- Archiviazione e recupero di tutti i dati Risorse STU3 tra cui il supporto per elementi di estensione. L'API accetta, archivia e restituisce le estensioni su qualsiasi elemento di dati.
Tutti i metodi nella API RESTful che utilizzano il tipo di contenuto JSON, ad eccezione di:
- A livello di tipo e di sistema cronologia le interazioni che recuperano la cronologia su più risorse supportati. La cronologia delle risorse può essere recuperata solo per una risorsa su una volta.
- La batch/transaction l'interazione non supporta le operazioni di ricerca all'interno del bundle.
Profilo e la convalida e l'applicazione forzata.
I parametri di ricerca definiti dall'utente, comprese le ricerche di elementi delle estensioni, sono supportati nell'API v1beta1.
Tutta la ricerca è supportata, 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 dei risultati di ricerca
_contained
,_containedType
,_summary=count
e_summary=true
non sono supportati. - Il parametro di ricerca speciale
_content
cerca in tutti i campi della a cui fanno riferimento i parametri di ricerca. Sono esclusi i campi che non sono disponibili per la ricerca. Non supporta contenuti espliciti diAND
(i termini sono implicitamente combinato con AND) o tra parentesi. - I parametri di ricerca speciali
_query
,_filter
e_list
non sono supportati. - Il parametro
_sort
, se utilizzato in campi con elementi ripetuti, ordina 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 con il metodo
POST
non accettaapplication/x-www-form-urlencoded
nel corpo della richiesta. - Il carattere jolly (
*
) è supportato per_include
, ma non è supportato per_revinclude
.
- I parametri di ricerca
Le aree non supportate includono:
- Più alta operazioni estese non sono implementate.
- Il tipo di contenuto XML non è supportato.
- L'operazione di patch non supporta XML Patch o FHIRPath Patch.
Aree in cui l'API si discosta dalla specifica FHIR per consentire la compatibilità con le versioni precedenti:
null
è accettato per i campi obbligatori- Per i campi obbligatori è accettato un codice vuoto
urn:uuid
riferimenti consentiti nei bundle batch
DSTU2
L'input del server dichiarazione di conformità indica le parti della specifica supportate.
- Archiviazione e recupero di tutti i dati Risorse DSTU2 tra cui il supporto per elementi di estensione. L'API accetta, archivia e restituisce estensioni su qualsiasi elemento di dati.
- Tutti i metodi nella
API RESTful
che utilizzano il tipo di contenuto JSON, ad eccezione di:
- A livello di tipo e di sistema cronologia le interazioni che recuperano la cronologia su più risorse supportati. La cronologia delle risorse può essere recuperata solo per una risorsa alla volta.
- La batch/transaction l'interazione non supporta le operazioni di ricerca all'interno del bundle.
- Profilo e la convalida e l'applicazione forzata.
- Tutti i
cerca
è supportata, 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 di estensione non sono supportati.
- I parametri di ricerca che eseguono la corrispondenza fonetica non sono supportati.
- I parametri dei risultati di ricerca
_contained
,_containedType
,_summary=count
e_summary=true
non sono supportati. - Il parametro di ricerca speciale
_content
cerca in tutti i campi della a cui fanno riferimento i parametri di ricerca. Sono esclusi i campi che non sono disponibili per la ricerca. Non supporta contenuti espliciti diAND
(i termini sono implicitamente combinato con AND) o tra parentesi. - I parametri di ricerca speciali
_query
,_filter
e_list
non sono supportati. - Il parametro
_sort
, se utilizzato in campi con elementi ripetuti, ordina dal primo elemento; differisce dalla specifica. Tutti supportati parametri di ricerca sono idonei per_sort
, ad eccezione dei parametri speciali parametro di ricerca_content
. - La ricerca utilizzando il metodo
POST
non accetta parametriapplication/x-www-form-urlencoded
nel corpo della richiesta. - Il carattere jolly (
*
) è supportato per_include
, ma non è supportato per_revinclude
.
- I parametri di ricerca
Le aree non supportate includono:
- Più alta operazioni estese non sono implementate.
- I parametri di ricerca definiti dall'utente non sono supportati per DSTU2.
- Il tipo di contenuto XML non è supportato.
Aree in cui l'API si discosta dalla specifica FHIR per consentire la compatibilità con le versioni precedenti:
null
è accettato per i campi obbligatori- Per i campi obbligatori è accettato un codice vuoto
urn:uuid
riferimenti consentiti nei bundle batch
Dettagli delle operazioni non incluse nella specifica pubblicata
- La configurazione degli archivi FHIR include un'opzione per notificare un argomento Pub/Sub specificato dall'utente per tutte le modifiche apportate alle risorse nell'archivio. Questo il meccanismo di notifica è comune a tutti gli archivi dell'API Cloud Healthcare e non è destinata a sostituire l'abbonamento FHIR (DSTU2, STU3 e R4) funzionalità.
- L'operazione di esportazione degli archivi FHIR in destinazioni Cloud Storage offre solo la possibilità di esportare in blocco l'intero archivio. Non è un'implementazione del Dati collettivi FHIR una bozza di specifica.
- L'operazione di importazione degli archivi FHIR non è definita nella specifica.
- L'operazione
Resource-purge
che rimuove le versioni precedenti delle risorse non è definita nella specifica. Questa API potrebbe cambiare in futuro qualora l'elaborazione degli standard o altre implementazioni FHIR portino all'uso di un altro metodo API per questo caso d'uso. - L'endpoint
ExecuteBundle
accettahistory
bundle nella versione v1beta1 per creare versioni storiche delle risorse.