Condividi tramite

Accedere al servizio FHIR usando Postman

  • Articolo

Questo articolo illustra i passaggi per accedere al servizio FHIR® in Servizi dati di integrità di Azure con Postman.

Prerequisiti

Creare un'area di lavoro, una raccolta e un ambiente

Se non si ha familiarità con Postman, seguire questa procedura per creare un'area di lavoro, una raccolta e un ambiente.

Postman introduce il concetto di area di lavoro per consentire all'utente e al team di condividere API, raccolte, ambienti e altri componenti. È possibile usare l'area di lavoro personale o l'area di lavoro team predefinita o creare una nuova area di lavoro per l'utente o il team.

Screenshot che mostra la creazione dell'area di lavoro.

Creare quindi una nuova raccolta in cui è possibile raggruppare tutte le richieste API REST correlate. Nell'area di lavoro selezionare Crea raccolte. È possibile mantenere il nome predefinito Nuova raccolta o rinominarlo. La modifica viene salvata automaticamente.

Screenshot che mostra la creazione di una nuova raccolta.

È anche possibile importare ed esportare raccolte Postman. Per altre informazioni, vedere la documentazione di Postman.

Screenshot che mostra l'importazione e l'esportazione delle raccolte.

Creare o aggiornare le variabili di ambiente

Sebbene sia possibile usare l'URL completo nella richiesta, è consigliabile archiviare l'URL e altri dati nelle variabili.

Per accedere al servizio FHIR, è necessario creare o aggiornare queste variabili:

Variabile Descrizione Note
tenantid Tenant di Azure in cui viene distribuito il servizio FHIR Informazioni generali sulla registrazione dell'applicazione
subid Sottoscrizione di Azure in cui viene distribuito il servizio FHIR Panoramica del servizio FHIR
Clientid ID registrazione client dell'applicazione -
clientsecret Segreto di registrazione client dell'applicazione -
fhirurl URL completo del servizio FHIR (ad esempio, https://xxx.azurehealthcareapis.com) Panoramica del servizio FHIR
bearerToken Archivia il token di accesso Di Microsoft Entra nello script Lasciare vuoto

Nota

Assicurarsi di aver configurato l'URL https://www.getpostman.com/oauth2/callback di reindirizzamento nella registrazione dell'applicazione client.

Screenshot che mostra la variabile degli ambienti.

Ottenere l'istruzione capability

Immettere {{fhirurl}}/metadata nella GETrichiesta e quindi scegliere Send. Verrà visualizzata l'istruzione capability del servizio FHIR.

Screenshot che mostra i parametri della richiesta di funzionalità.

Screenshot che mostra una richiesta di salvataggio.

Ottenere un token di accesso di Microsoft Entra

Ottenere un token di accesso di Microsoft Entra usando un'entità servizio o un account utente Microsoft Entra. Scegliere uno dei due metodi.

Usare un'entità servizio con un tipo di concessione di credenziali client

Il servizio FHIR è protetto da Microsoft Entra ID. L'autenticazione predefinita non può essere disabilitata. Per accedere al servizio FHIR, è prima necessario ottenere un token di accesso Di Microsoft Entra. Per altre informazioni, vedere Token di accesso di Microsoft Identity Platform.

Creare una nuova POST richiesta:

  1. Immettere l'intestazione della richiesta: https://login.microsoftonline.com/{{tenantid}}/oauth2/token

  2. Selezionare la scheda Corpo e selezionare x-www-form-urlencoded. Immettere i valori seguenti nella sezione chiave e valore:

    • grant_type:Client_Credentials
    • client_id:{{clientid}}
    • client_secret:{{clientsecret}}
    • risorsa: {{fhirurl}}

Nota

Negli scenari in cui il parametro del gruppo di destinatari del servizio FHIR non è mappato all'URL dell'endpoint del servizio FHIR, il valore del parametro della risorsa deve essere mappato al valore del gruppo di destinatari nel riquadro Autenticazione del servizio FHIR.

  1. Selezionare la scheda Test e immettere nella sezione di testo: pm.environment.set("bearerToken", pm.response.json().access_token); per rendere disponibile il valore per la raccolta, usare il metodo pm.collectionVariables.set. Per altre informazioni sul metodo set e sul relativo livello di ambito, vedere Uso di variabili negli script.
  2. Selezionare Salva per salvare le impostazioni.
  3. Selezionare Invia. Verrà visualizzata una risposta con il token di accesso Microsoft Entra, che viene salvato automaticamente nella variabile bearerToken . È quindi possibile usarlo in tutte le richieste api del servizio FHIR.

Screenshot che mostra il pulsante di invio.

È possibile esaminare il token di accesso usando strumenti online, https://jwt.msad esempio . Selezionare la scheda Attestazioni per visualizzare descrizioni dettagliate per ogni attestazione nel token.

Screenshot che mostra le attestazioni del token di accesso.

Usare un account utente con il tipo di concessione del codice di autorizzazione

È possibile ottenere il token di accesso di Microsoft Entra usando le credenziali dell'account Entra e seguendo i passaggi elencati.

  1. Verificare di essere un membro del tenant di Microsoft Entra con le autorizzazioni di accesso necessarie.

  2. Assicurarsi di aver configurato l'URL https://oauth.pstmn.io/v1/callback di reindirizzamento per la piattaforma Web nella registrazione dell'applicazione client.

    Screenshot che mostra l'URL di callback.

  3. Nella registrazione dell'applicazione client in Autorizzazioni API aggiungere l'autorizzazione delegata User_Impersonation per le API del settore sanitario di Azure dalle API usate dall'organizzazione.

    Screenshot che mostra le autorizzazioni di registrazione dell'applicazione.

    Screenshot che mostra la schermata delle autorizzazioni di registrazione dell'applicazione.

  4. In Postman selezionare la scheda Autorizzazione di una raccolta o una chiamata REST specifica, selezionare Tipo come OAuth 2.0 e nella sezione Configura nuovo token impostare questi valori:

    • URL di callback: https://oauth.pstmn.io/v1/callback

    • URL di autenticazione: https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/authorize

    • URL del token di accesso: https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/token

    • ID client: ID registrazione client dell'applicazione

    • Segreto client: segreto di registrazione client dell'applicazione

    • Ambito: {{fhirurl}}/.default

    • Autenticazione client: inviare le credenziali client nel corpo

    Screenshot che mostra la schermata di configurazione.

  5. Scegliere Recupera nuovo token di accesso nella parte inferiore della pagina.

  6. Vengono richieste le credenziali utente per l'accesso.

  7. Si riceve il token. Scegliere Usa token.

  8. Assicurarsi che il token si trova nell'intestazione di autorizzazione della chiamata REST.

Esaminare il token di accesso usando strumenti online, ad https://jwt.msesempio . Selezionare la scheda Attestazioni per visualizzare descrizioni dettagliate per ogni attestazione nel token.

Connessione al server FHIR

Aprire Postman, selezionare l'area di lavoro, la raccolta e l'ambiente da usare. Selezionare l'icona + per creare una nuova richiesta.

Screenshot che mostra la creazione di una nuova richiesta.

Per eseguire il controllo di integrità nel servizio FHIR, immettere {{fhirurl}}/health/check nella richiesta GET e quindi scegliere Invia. Dovrebbe essere possibile visualizzare la risposta del Status of FHIR service - HTTP Status codice con 200 e OverallStatus come Integro in risposta, il che significa che il controllo integro ha esito positivo.

Ottenere la risorsa FHIR

Dopo aver ottenuto un token di accesso di Microsoft Entra, è possibile accedere ai dati FHIR. In una nuova GET richiesta immettere {{fhirurl}}/Patient.

Selezionare Bearer Token (Token di connessione) come tipo di autorizzazione. Immettere {{bearerToken}} nella sezione Token . Selezionare Invia. Come risposta, dovrebbe essere visualizzato un elenco di pazienti nella risorsa FHIR.

Screenshot che mostra la selezione del token di connessione.

Creare o aggiornare la risorsa FHIR

Dopo aver ottenuto un token di accesso di Microsoft Entra, è possibile creare o aggiornare i dati FHIR. Ad esempio, è possibile creare un nuovo paziente o aggiornare un paziente esistente.

Creare una nuova richiesta, modificare il metodo in Post e quindi immettere il valore nella sezione della richiesta.

{{fhirurl}}/Patient

Selezionare Bearer Token (Token di connessione) come tipo di autorizzazione. Immettere {{bearerToken}} nella sezione Token . Selezionare la scheda Corpo . Selezionare l'opzione raw e JSON come formato di testo del corpo. Copiare e incollare il testo nella sezione body.

{
    "resourceType": "Patient",
    "active": true,
    "name": [
        {
            "use": "official",
            "family": "Kirk",
            "given": [
                "James",
                "Tiberious"
            ]
        },
        {
            "use": "usual",
            "given": [
                "Jim"
            ]
        }
    ],
    "gender": "male",
    "birthDate": "1960-12-25"
}

Selezionare Invia. Nella risposta JSON dovrebbe essere visualizzato un nuovo paziente.

Screenshot che mostra il pulsante Invia per creare un nuovo paziente.

Esportare i dati FHIR

Dopo aver ottenuto un token di accesso Microsoft Entra, è possibile esportare i dati FHIR in un account di archiviazione di Azure.

Creare una nuova GET richiesta: {{fhirurl}}/$export?_container=export

Selezionare Bearer Token (Token di connessione) come tipo di autorizzazione. Immettere {{bearerToken}} nella sezione Token . Selezionare Intestazioni per aggiungere due nuove intestazioni:

  • Accetta: application/fhir+json

  • Preferisci: respond-async

Selezionare Invia. Si dovrebbe notare una 202 Accepted risposta. Selezionare la scheda Intestazioni della risposta e prendere nota del valore in Content-Location. È possibile usare il valore per eseguire una query sullo stato del processo di esportazione.

Screenshot che mostra la risposta di selezione 202 accettata.

Passaggi successivi

Raccolta iniziale di query di esempio Postman

Nota

FHIR® è un marchio registrato di HL7 e viene usato con l'autorizzazione di HL7.