Få åtkomst till FHIR-tjänsten med hjälp av Postman
Den här artikeln visar stegen för att komma åt FHIR-tjänsten® i Azure Health Data Services med Postman.
- FHIR-tjänsten distribuerad i Azure. Mer information finns i Distribuera en FHIR-tjänst.
- Postman installerat lokalt. Mer information finns i Kom igång med Postman.
- Rollen Administratör för användaråtkomst för rolltilldelningar i FHIR-tjänsten.
Om du vill komma åt FHIR-tjänsten från Postman-programmet läser du stegen:
Registrera ett klientprogram (appregistrering) i Microsoft Entra-ID.
Tilldela rollen FHIR-datadeltagare under FHIR-tjänsten.
Konfigurera Postman – Skapa arbetsyta, samling och miljö
Välj + Nya registreringar.
Ange ett namn för appregistrering. Under Kontotyper som stöds väljer du Endast konton i den här organisationskatalogen. välj Registrera.
När du har registrerat ett nytt program kan du hitta program-ID:t (klient- och katalog-ID:t) i avsnittet Översikt. Anteckna dessa värden för senare användning, eftersom du behöver dem när du konfigurerar Postman-miljön.
Välj Autentisering för att granska inställningarna. Standardvärdet för Tillåt offentliga klientflöden är "Nej".
Om du behåller det här standardvärdet är programregistreringen ett konfidentiellt klientprogram och ett certifikat eller en hemlighet krävs.
Om du ändrar standardvärdet till "Ja" för alternativet "Tillåt offentliga klientflöden" i den avancerade inställningen är programregistreringen ett offentligt klientprogram och ett certifikat eller en hemlighet krävs inte.
Ja-värdet är användbart när du vill använda klientprogrammet i din mobilapp eller en JavaScript-app där du inte vill lagra några hemligheter.
För verktyg som kräver en omdirigerings-URL väljer du Lägg till en plattform för att konfigurera plattformen.
För Postman väljer du Mobil- och skrivbordsprogram. Ange "https://www.getpostman.com/oauth2/callback" i avsnittet Anpassade omdirigerings-URI:er. Välj knappen Konfigurera för att spara inställningen.
- Klicka på Certifikat och hemligheter. Klicka på +Ny klienthemlighet.
- Under Lägg till en klienthemlighet anger du ett namn för hemligheten i fältet Beskrivning . Vägledningen är att ange 6 månader för hemlighetens förfallotid. Klicka på Lägg till.
- Det är viktigt att du sparar det hemliga värdet, inte det hemliga ID:t.
Anteckning
Använd grant_type av client_credentials när du försöker hämta en åtkomsttoken för FHIR-tjänsten med hjälp av verktyg som Postman eller REST Client.
Det här avsnittet visar stegen för att tilldela rollen FHIR-datadeltagare till ett registrerat program för FHIR-tjänsten® i Azure Health Data Services.
I Azure Portal navigerar du till din FHIR-tjänst.
I den vänstra menyn väljer du bladet Åtkomstkontroll (IAM). Klicka på + Lägg till och välj sedan Lägg till rolltilldelning. Om alternativet för att lägga till en rolltilldelning inte är tillgängligt ber du Azure-administratören att tilldela dig behörighet att utföra det här steget.
I Lägg till rolltilldelning under fliken Roll rullar du ned i listan och väljer FHIR-datadeltagare. Klicka på Nästa.
Under fliken Medlemmar klickar du på +Välj medlemmar. Ange namnet på postmantjänstklientappen i fältet Välj till höger. Välj appen.
På samma sätt skriver du in namnet på ditt användarnamn i Välj. Välj din användare så att den läggs till i listan tillsammans med appregistrering och klicka på Välj. Klicka på Nästa.
Under fliken Granska + tilldela klickar du på Granska + tilldela.
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.
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.
Du kan också importera och exportera Postman-samlingar. Mer information finns i Postman-dokumentationen.
Ä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 |
Anteckning
Kontrollera att du har konfigurerat omdirigerings-URL:en https://www.getpostman.com/oauth2/callback
i klientprogramregistreringen.
Ange {{fhirurl}}/metadata
i GET
begäran och välj Send
sedan . Du bör se funktionsöversikten för FHIR-tjänsten.
Hämta en Microsoft Entra-åtkomsttoken genom att välja antingen tjänstens huvudnamn eller ett Microsoft Entra-användarkonto.
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:
Ange begärandehuvudet:
https://login.microsoftonline.com/{{tenantid}}/oauth2/token
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}}
- grant_type:
Anteckning
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.
- Välj fliken Test och ange
pm.environment.set("bearerToken", pm.response.json().access_token);
i textavsnittet. 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. - Spara inställningarna genom att klicka på Spara.
- Välj Skicka. Du bör se ett svar med Microsoft Entra-åtkomsttoken, som sparas automatiskt i variabeln
bearerToken
. Du kan sedan använda den i alla FHIR-tjänst-API-begäranden.
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.
Du kan hämta Microsoft Entra-åtkomsttoken med dina autentiseringsuppgifter för Microsoft Entra-kontot och följa stegen i listan.
Kontrollera att du är medlem i Microsoft Entra-klientorganisationen med de åtkomstbehörigheter som krävs.
Kontrollera att du har konfigurerat omdirigerings-URL:en
https://oauth.pstmn.io/v1/callback
för webbplattformen i klientprogramregistreringen.I klientprogramregistreringen under API-behörigheter lägger du till User_Impersonation delegerad behörighet för Azure Healthcare APIS från API:er som min organisation använder.
- I Postman väljer du fliken Auktorisering för antingen en samling eller ett specifikt REST-anrop, väljer Skriv 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
Välj Hämta ny åtkomsttoken längst ned på sidan.
Ange användarautentiseringsuppgifter för inloggning.
När du har fått token väljer du Använd token.
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.
Ö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.
Om du vill utföra en 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.
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.
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 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 följande text 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.
När du har hämtat en Microsoft Entra-åtkomsttoken kan du exportera FHIR-data till ett Azure-lagringskonto.
Information om hur du konfigurerar exportinställningar och skapar ett Data Lake Storage Gen2-konto finns i Konfigurera inställningar för export.
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 det här värdet för att fråga exportjobbets status.
Startsamling med Postman-exempelfrågor
Anteckning
FHIR® är ett registrerat varumärke som tillhör HL7 och används med tillstånd av HL7.