Share via

Få åtkomst till FHIR-tjänsten med hjälp av Postman

  • Artikel

Den här artikeln visar stegen för att komma åt FHIR-tjänsten® i Azure Health Data Services med Postman.

Förutsättningar

Skapa en arbetsyta, en samling och en miljö

Om du inte har använt Postman tidigare följer du de här stegen för att skapa en arbetsyta, en samling och en miljö.

Postman introducerar arbetsytekonceptet så att du och ditt team kan dela API:er, samlingar, miljöer och andra komponenter. Du kan använda standardarbetsytan Min arbetsyta eller Team-arbetsyta eller skapa en ny arbetsyta åt dig eller ditt team.

Skärmbild som visar skapande av arbetsyta.

Skapa sedan en ny samling där du kan gruppera alla relaterade REST API-begäranden. På arbetsytan väljer du Skapa samlingar. Du kan behålla standardnamnet Ny samling eller byta namn på den. Ändringen sparas automatiskt.

Skärmbild som visar skapandet av en ny samling.

Du kan också importera och exportera Postman-samlingar. Mer information finns i Postman-dokumentationen.

Skärmbild som visar import och export av samlingar.

Skapa eller uppdatera miljövariabler

Även om du kan använda den fullständiga URL:en i begäran rekommenderar vi att du lagrar URL:en och andra data i variabler.

För att få åtkomst till FHIR-tjänsten måste du skapa eller uppdatera dessa variabler:

Variabel Beskrivning Anteckningar
tenantid Azure-klientorganisation där FHIR-tjänsten distribueras Finns i översikten över programregistrering
subid Azure-prenumeration där FHIR-tjänsten distribueras Finns i översikten över FHIR-tjänsten
clientid Programklientregistrerings-ID -
clientsecret Programklientregistreringshemlighet -
fhirurl Fullständig URL för FHIR-tjänsten (till exempel https://xxx.azurehealthcareapis.com) Finns i översikten över FHIR-tjänsten
bearerToken Lagrar Microsoft Entra-åtkomsttoken i skriptet Lämna tomt

Kommentar

Kontrollera att du har konfigurerat omdirigerings-URL:en https://www.getpostman.com/oauth2/callback i klientprogramregistreringen.

Skärmbild som visar miljövariabeln.

Hämta funktionssatsen

Ange {{fhirurl}}/metadata i GETbegäran och välj Sendsedan . Du bör se funktionsöversikten för FHIR-tjänsten.

Skärmbild som visar parametrar för kapacitetsbegäran.

Skärmbild som visar en spara begäran.

Hämta en Microsoft Entra-åtkomsttoken

Hämta en Microsoft Entra-åtkomsttoken med hjälp av tjänstens huvudnamn eller ett Microsoft Entra-användarkonto. Välj en av de två metoderna.

Använda ett tjänsthuvudnamn med en tilldelningstyp för klientautentiseringsuppgifter

FHIR-tjänsten skyddas av Microsoft Entra-ID. Standardautentiseringen kan inte inaktiveras. För att få åtkomst till FHIR-tjänsten måste du skaffa en Microsoft Entra-åtkomsttoken först. Mer information finns i Microsofts identitetsplattform åtkomsttoken.

Skapa en ny POST begäran:

  1. Ange begärandehuvudet: https://login.microsoftonline.com/{{tenantid}}/oauth2/token

  2. Välj fliken Brödtext och välj x-www-form-urlencoded. Ange följande värden i avsnittet nyckel och värde:

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

Kommentar

I scenarier där FHIR-tjänstens målgruppsparameter inte mappas till FHIR-tjänstens slutpunkts-URL bör resursparametervärdet mappas till målgruppsvärdet i fönstret FHIR-tjänstautentisering.

  1. Välj fliken Test och ange i textavsnittet: pm.environment.set("bearerToken", pm.response.json().access_token); Om du vill göra värdet tillgängligt för samlingen använder du metoden pm.collectionVariables.set. Mer information om den angivna metoden och dess omfångsnivå finns i Använda variabler i skript.
  2. Spara inställningarna genom att klicka på Spara.
  3. Välj Skicka. Du bör se ett svar med Microsoft Entra-åtkomsttoken, som sparas i variabeln bearerToken automatiskt. Du kan sedan använda den i alla FHIR-tjänst-API-begäranden.

Skärmbild som visar knappen Skicka.

Du kan undersöka åtkomsttoken med hjälp av onlineverktyg som https://jwt.ms. Välj fliken Anspråk för att se detaljerade beskrivningar för varje anspråk i token.

Skärmbild som visar anspråk på åtkomsttoken.

Använda ett användarkonto med auktoriseringskodens beviljandetyp

Du kan hämta Microsoft Entra-åtkomsttoken med dina autentiseringsuppgifter för Etttra-kontot och följa stegen i listan.

  1. Kontrollera att du är medlem i Microsoft Entra-klientorganisationen med de åtkomstbehörigheter som krävs.

  2. Kontrollera att du har konfigurerat omdirigerings-URL:en https://oauth.pstmn.io/v1/callback för webbplattformen i klientprogramregistreringen.

    Skärmbild som visar återanrops-URL.

  3. I klientprogramregistreringen under API-behörigheter lägger du till User_Impersonationdelegerad behörighet för Azure Healthcare APIS från API:er som min organisation använder.

    Skärmbild som visar behörigheter för programregistrering.

    Skärmbild som visar skärmen behörigheter för programregistrering.

  4. I Postman väljer du fliken Auktorisering för antingen en samling eller ett specifikt REST-anrop, väljer Typ som OAuth 2.0 och under Avsnittet Konfigurera ny token anger du följande värden:

    • Motringnings-URL: https://oauth.pstmn.io/v1/callback

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

    • URL för åtkomsttoken: https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/token

    • Klient-ID: Programklientregistrerings-ID

    • Klienthemlighet: Programklientregistreringshemlighet

    • Omfång: {{fhirurl}}/.default

    • Klientautentisering: Skicka klientautentiseringsuppgifter i brödtext

    Skärmbild som visar konfigurationsskärmen.

  5. Välj Hämta ny åtkomsttoken längst ned på sidan.

  6. Du uppmanas att ange användarautentiseringsuppgifter för inloggning.

  7. Du får token. Välj Använd token.

  8. Kontrollera att token finns i auktoriseringshuvudet för REST-anropet.

Granska åtkomsttoken med hjälp av onlineverktyg som https://jwt.ms. Välj fliken Anspråk för att se detaljerade beskrivningar för varje anspråk i token.

Anslut till FHIR-servern

Öppna Postman, välj den arbetsyta, samling och miljö som du vill använda. + Välj ikonen för att skapa en ny begäran.

Skärmbild som visar hur du skapar en ny begäran.

Om du vill utföra hälsokontroll på FHIR-tjänsten anger du {{fhirurl}}/health/check i GET-begäran och väljer sedan Skicka. Du bör kunna se kodsvaret Status of FHIR service - HTTP Status med 200 och OverallStatus som Felfri som svar, vilket innebär att hälsokontrollen lyckas.

Hämta FHIR-resursen

När du har hämtat en Microsoft Entra-åtkomsttoken kan du komma åt FHIR-data. I en ny GET begäran anger du {{fhirurl}}/Patient.

Välj Ägartoken som auktoriseringstyp. Ange {{bearerToken}} i avsnittet Token . Välj Skicka. Som svar bör du se en lista över patienter i din FHIR-resurs.

Skärmbild som visar val av ägartoken.

Skapa eller uppdatera FHIR-resursen

När du har hämtat en Microsoft Entra-åtkomsttoken kan du skapa eller uppdatera FHIR-data. Du kan till exempel skapa en ny patient eller uppdatera en befintlig patient.

Skapa en ny begäran, ändra metoden till Post och ange sedan värdet i avsnittet för begäran.

{{fhirurl}}/Patient

Välj Ägartoken som auktoriseringstyp. Ange {{bearerToken}} i avsnittet Token . Välj fliken Brödtext . Välj alternativet raw och JSON som brödtextformat. Kopiera och klistra in texten i brödtextavsnittet.

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

Välj Skicka. Du bör se en ny patient i JSON-svaret.

Skärmbild som visar knappen Skicka för att skapa en ny patient.

Exportera FHIR-data

När du har hämtat en Microsoft Entra-åtkomsttoken kan du exportera FHIR-data till ett Azure-lagringskonto.

Skapa en ny GET begäran: {{fhirurl}}/$export?_container=export

Välj Ägartoken som auktoriseringstyp. Ange {{bearerToken}} i avsnittet Token . Välj Rubriker för att lägga till två nya rubriker:

  • Acceptera: application/fhir+json

  • Föredrar: respond-async

Välj Skicka. Du bör märka ett 202 Accepted svar. Välj fliken Rubriker i svaret och anteckna värdet i Content-Location. Du kan använda värdet för att fråga exportjobbets status.

Skärmbild som visar val 202-godkänt svar.

Nästa steg

Startsamling med Postman-exempelfrågor

Kommentar

FHIR® är ett registrerat varumärke som tillhör HL7 och används med tillstånd av HL7.