Dichiarazione di conformità FHIR

Gli archivi FHIR all'interno dell'API Cloud Healthcare supportano più versioni di Fast Healthcare Interoperability Resources (FHIR) specifica pubblicata da Health Level 7 International (HL7).

L'API v1 supporta le seguenti versioni:

Quando crei un archivio FHIR, devi specificare la versione FHIR come parametro del metodo fhirStores.create. Non puoi modificare la versione FHIR dopo la creazione dell'archivio.

L'interfaccia API di ogni archivio è conforme alla versione FHIR di quell'archivio. Ad esempio, l'interazione conformance di DSTU2 è diversa dall'interazione capabilities di STU3, ma entrambe condividono il percorso REST /fhir/metadata, quindi questo percorso restituisce risposte diverse in base alla versione FHIR del datastore.

Le funzionalità aggiunte nelle versioni FHIR successive sono disponibili negli archivi che utilizzano versioni FHIR precedenti se non creano incompatibilità. Ad esempio, l'interazione patch è disponibile in un archivio DSTU2 anche se è definita solo a partire da STU3.

Dettagli delle funzionalità supportate nell'API v1 per versione FHIR

R5

La dichiarazione di capacità del server indica le parti della specifica che sono supportate.

  • Archiviazione e recupero di tutte le risorse R5, incluso il supporto per gli elementi di estensione. L'API accetta, archivia e restituisce le estensioni su qualsiasi elemento di dati.
  • Sono supportati tutti i metodi dell' API RESTful che utilizzano il tipo di contenuti JSON, ad eccezione di:
  • Sono supportate la convalida e l'applicazione dei profili.
  • I parametri di ricerca definiti dall'utente, incluse le ricerche sugli elementi di estensione, sono supportati nell'API v1beta1.

  • Sono supportate tutte le funzionalità di ricerca, ad eccezione di:

    • I parametri di ricerca Group-characteristic-value, Location-near, Location-contains, DocumentReference-relationship, Bundle-composition, Bundle-message, Observation-component-value-canonical,Observation-value-canonical, QuestionnaireResponse-item-subject e Composition-section-text 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 risorsa a cui fanno riferimento i parametri di ricerca. Esclude i campi in cui non è possibile eseguire ricerche. Non supporta AND esplicito (i termini vengono combinati implicitamente con AND) o le parentesi.
    • I parametri di ricerca speciali Resource-query, Resource-filter, Resource-language, Resource-in e Resource-list non sono supportati.
    • Il parametro _sort, se utilizzato nei campi con elementi ripetuti, esegue l'ordinamento in base al primo elemento; questo comportamento è diverso dalla specifica. _sort è supportato per i parametri di ricerca di tipo number, data, string, token e quantity.
    • I modificatori di ricerca di token :of-type, :code-text, text-advanced, e :text e i modificatori di ricerca di riferimento :identifier, not-in, text-advanced, e :code-text non sono supportati. Il modificatore contains per le ricerche di URI non è supportato.
    • Le ricerche di riferimenti canonici non sono supportate. I riferimenti canonici vengono trattati come riferimenti normali. I modificatori above e below non sono supportati.
    • Quando utilizzi il parametro _type, puoi utilizzare solo i parametri di ricerca comuni (a tutte le risorse) e non l'intersezione dei tipi di risorse specificati.

    • È supportato il seguente sottoinsieme di parametri di ricerca compositi:

      • 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 compositi non sono supportati.

    • La ricerca che utilizza il metodo POST non accetta i parametri application/x-www-form-urlencoded nel corpo della richiesta.

    • Il carattere jolly (*) è supportato per _include, ma non per _revinclude.

Le aree non supportate includono:

  • Il tipo di contenuti XML non è supportato.
  • L'operazione di patch non supporta XML Patch o FHIRPath Patch.
  • Le richieste HTTP HEAD non sono supportate.

Alcuni aspetti dell'API si sono discostati dalla specifica FHIR a causa della compatibilità con le versioni precedenti di FHIR. Questi problemi sono stati risolti in R5:

  • Quando la convalida dei campi obbligatori è abilitata, i campi null e i campi vuoti (ad esempio, {}) vengono ora rifiutati.
  • UpperCamelCase non è più supportato per i campi delle risorse in JSON.
  • I riferimenti urn:uuid non sono consentiti nei bundle batch, indipendentemente dal fatto che l'integrità referenziale sia disabilitata o meno. I bundle batch non riscrivono mai i riferimenti.
  • I bundle di transazioni sono più rigorosi nella riscrittura dei riferimenti rispetto a prima e generano errori per FullUrl non validi nelle voci, come definito dalla specifica: https://www.hl7.org/fhir/bundle.html#references.
  • I riferimenti che sembrano riferimenti alle risorse devono avere ID validi.
  • La convalida del profilo di base è abilitata per le richieste PATCH.

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 le estensioni su qualsiasi elemento di dati.
  • Sono supportati tutti i metodi dell' API RESTful che utilizzano il tipo di contenuti JSON, ad eccezione di:
  • Sono supportate la convalida e l'applicazione dei profili.
  • I parametri di ricerca definiti dall'utente, incluse le ricerche sugli elementi di estensione, 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 e Bundle-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 risorsa a cui fanno riferimento i parametri di ricerca. Esclude i campi in cui non è possibile eseguire ricerche. Non supporta AND esplicito (i termini vengono combinati implicitamente con AND) o le parentesi.
    • I parametri di ricerca speciali _query, _filter e _list non sono supportati.
    • Il parametro _sort, se utilizzato nei campi con elementi ripetuti, esegue l'ordinamento in base al primo elemento; questo comportamento è diverso dalla specifica. _sort è supportato per i parametri di ricerca di tipo number, data, string, token e quantity.
    • Il modificatore di ricerca di token :of-type e il modificatore di ricerca di riferimento :identifier non sono supportati.
    • Le ricerche di riferimenti canonici non sono supportate. I riferimenti canonici vengono trattati come riferimenti normali.
    • Quando utilizzi il parametro _type, puoi utilizzare solo i parametri di ricerca comuni (a 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

      I restanti parametri di ricerca compositi non sono supportati.

    • La ricerca che utilizza il metodo POST non accetta i parametri application/x-www-form-urlencoded nel corpo della richiesta.

    • Il carattere jolly (*) è supportato per _include, ma non per _revinclude.

Le aree non supportate includono:

Aree in cui l'API si discosta dalla specifica FHIR per consentire la compatibilità con le versioni precedenti:

  • null è accettato per i campi obbligatori
  • Un codice vuoto è accettato per i campi obbligatori
  • I riferimenti urn:uuid sono consentiti nei bundle batch quando l'integrità referenziale è disabilitata.

STU3

La dichiarazione di capacità del server indica le parti della specifica che sono supportate.

  • Sono supportate 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.

  • Sono supportati tutti i metodi dell' API RESTful che utilizzano il tipo di contenuti JSON, ad eccezione di:

  • Sono supportate la convalida e l'applicazione dei profili.

  • I parametri di ricerca definiti dall'utente, incluse le ricerche sugli elementi di estensione, 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 e Bundle-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 risorsa a cui fanno riferimento i parametri di ricerca. Esclude i campi in cui non è possibile eseguire ricerche. Non supporta AND esplicito (i termini vengono combinati implicitamente con AND) o le parentesi.
    • I parametri di ricerca speciali _query, _filter e _list non sono supportati.
    • Il parametro _sort, se utilizzato nei campi con elementi ripetuti, esegue l'ordinamento in base al primo elemento; questo comportamento è diverso dalla specifica. _sort è supportato per i parametri di ricerca di tipo number, data, string, token e quantity.
    • La ricerca che utilizza il metodo POST non accetta i parametri application/x-www-form-urlencoded nel corpo della richiesta.
    • Il carattere jolly (*) è supportato per _include, ma non per _revinclude.

Le aree non supportate includono:

Aree in cui l'API si discosta dalla specifica FHIR per consentire la compatibilità con le versioni precedenti:

  • null è accettato per i campi obbligatori
  • Un codice vuoto è accettato per i campi obbligatori
  • I riferimenti urn:uuid sono consentiti nei bundle batch quando l'integrità referenziale è disabilitata.

DSTU2

La dichiarazione di conformità del server indica le parti della specifica che sono supportate.

  • Sono supportate l'archiviazione e il recupero di tutte le risorse DSTU2, incluso il supporto per gli elementi di estensione. L'API accetta, archivia e restituisce le estensioni su qualsiasi elemento di dati.
  • Sono supportati tutti i metodi dell' API RESTful che utilizzano il tipo di contenuti JSON, ad eccezione di:
  • Sono supportate la convalida e l'applicazione dei profili.
  • 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 e Coverage-sequence non sono supportati.
    • I parametri di ricerca definiti sugli 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 risorsa a cui fanno riferimento i parametri di ricerca. Esclude i campi in cui non è possibile eseguire ricerche. Non supporta AND esplicito (i termini vengono combinati implicitamente con AND) o le parentesi.
    • I parametri di ricerca speciali _query, _filter e _list non sono supportati.
    • Il parametro _sort, se utilizzato nei campi con elementi ripetuti, esegue l'ordinamento in base al primo elemento; questo comportamento è diverso dalla specifica. _sort è supportato per i parametri di ricerca di tipo number, data, string, token e quantity.
    • La ricerca che utilizza il metodo POST non accetta i parametri application/x-www-form-urlencoded nel corpo della richiesta.
    • Il carattere jolly (*) è supportato per _include, ma non per _revinclude.

Le aree non supportate includono:

Aree in cui l'API si discosta dalla specifica FHIR per consentire la compatibilità con le versioni precedenti:

  • null è accettato per i campi obbligatori
  • Un codice vuoto è accettato per i campi obbligatori
  • I riferimenti urn:uuid sono consentiti nei bundle batch quando l'integrità referenziale è disabilitata.

Dettagli delle operazioni al di fuori della 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 meccanismo di notifica è comune a tutti gli archivi dell'API Cloud Healthcare e non è inteso come sostitutivo della funzionalità di sottoscrizione FHIR (DSTU2, STU3, R4, e R5)) 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 della bozza della specifica FHIR Bulk Data.
  • 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 di utilizzo.
  • L'endpoint ExecuteBundle accetta i bundle history in v1beta1 per creare versioni precedenti delle risorse.