Delen via

Toegang tot de FHIR-service met Postman

  • Artikel

In dit artikel worden de stappen beschreven voor toegang tot de FHIR-service® in Azure Health Data Services met Postman.

Vereisten

Een werkruimte, verzameling en omgeving maken

Als u niet bekend bent met Postman, volgt u deze stappen om een werkruimte, verzameling en omgeving te maken.

Postman introduceert het werkruimteconcept waarmee u en uw team API's, verzamelingen, omgevingen en andere onderdelen kunnen delen. U kunt de standaardwerkruimte Mijn werkruimte of teamwerkruimte gebruiken of een nieuwe werkruimte voor u of uw team maken.

Schermopname van het maken van werkruimten.

Maak vervolgens een nieuwe verzameling waarin u alle gerelateerde REST API-aanvragen kunt groeperen. Selecteer Verzamelingen maken in de werkruimte. U kunt de standaardnaam Nieuwe verzameling behouden of de naam ervan wijzigen. De wijziging wordt automatisch opgeslagen.

Schermopname van het maken van een nieuwe verzameling.

U kunt postman-verzamelingen ook importeren en exporteren. Zie de Postman-documentatie voor meer informatie.

Schermopname van het importeren en exporteren van verzamelingen.

Omgevingsvariabelen maken of bijwerken

Hoewel u de volledige URL in de aanvraag kunt gebruiken, raden we u aan de URL en andere gegevens op te slaan in variabelen.

Voor toegang tot de FHIR-service moet u deze variabelen maken of bijwerken:

Variabele Beschrijving Opmerkingen
tenantid Azure-tenant waar de FHIR-service wordt geïmplementeerd Overzicht van toepassingsregistratie
sub-id Azure-abonnement waarbij de FHIR-service wordt geïmplementeerd Overzicht van de FHIR-service
clientid Registratie-id van toepassingsclient -
clientsecret Registratiegeheim voor toepassingsclient -
fhirurl De volledige URL van de FHIR-service (bijvoorbeeld https://xxx.azurehealthcareapis.com) Overzicht van de FHIR-service
bearerToken Slaat het Microsoft Entra-toegangstoken op in het script Leeg laten

Notitie

Zorg ervoor dat u de omleidings-URL https://www.getpostman.com/oauth2/callback hebt geconfigureerd in de registratie van de clienttoepassing.

Schermopname van omgevingsvariabele.

De mogelijkheidsinstructie ophalen

Voer {{fhirurl}}/metadata de GETaanvraag in en kies Send. U ziet nu de mogelijkheidsinstructie van de FHIR-service.

Schermopname van parameters voor mogelijkheidsaanvragen.

Schermopname van een aanvraag voor opslaan.

Een Microsoft Entra-toegangstoken ophalen

Haal een Microsoft Entra-toegangstoken op met behulp van een service-principal of een Microsoft Entra-gebruikersaccount. Kies een van de twee methoden.

Een service-principal gebruiken met een type clientreferentietoe kennen

De FHIR-service wordt beveiligd door Microsoft Entra ID. De standaardverificatie kan niet worden uitgeschakeld. Als u toegang wilt krijgen tot de FHIR-service, moet u eerst een Microsoft Entra-toegangstoken ophalen. Zie Toegangstokens voor Microsoft Identity Platform voor meer informatie.

Maak een nieuwe POST aanvraag:

  1. Voer de aanvraagheader in: https://login.microsoftonline.com/{{tenantid}}/oauth2/token

  2. Selecteer het tabblad Hoofdtekst en selecteer x-www-form-urlencoded. Voer de volgende waarden in de sleutel- en waardesectie in:

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

Notitie

In scenario's waarin de doelgroepparameter van de FHIR-service niet is toegewezen aan de URL van het FHIR-service-eindpunt, moet de waarde van de resourceparameter worden toegewezen aan de doelgroepwaarde in het deelvenster FHIR-serviceverificatie.

  1. Selecteer het tabblad Testen en voer de tekstsectie in: pm.environment.set("bearerToken", pm.response.json().access_token); Als u de waarde beschikbaar wilt maken voor de verzameling, gebruikt u de methode pm.collectionVariables.set. Zie Variabelen gebruiken in scripts voor meer informatie over de ingestelde methode en het bereikniveau.
  2. Selecteer Opslaan om de instellingen op te slaan.
  3. Selecteer Verzenden. U ziet nu een antwoord met het Microsoft Entra-toegangstoken, dat automatisch wordt opgeslagen in de variabele bearerToken . U kunt deze vervolgens gebruiken in alle AANVRAGEN van de FHIR-service-API.

Schermopname van de knop Verzenden.

U kunt het toegangstoken onderzoeken met behulp van onlinehulpprogramma's zoals https://jwt.ms. Selecteer het tabblad Claims om gedetailleerde beschrijvingen voor elke claim in het token te bekijken.

Schermopname van toegangstokenclaims.

Een gebruikersaccount gebruiken met het toekenningstype autorisatiecode

U kunt het Microsoft Entra-toegangstoken ophalen met de referenties van uw Entra-account en de vermelde stappen volgen.

  1. Controleer of u lid bent van de Microsoft Entra-tenant met de vereiste toegangsmachtigingen.

  2. Zorg ervoor dat u de omleidings-URL https://oauth.pstmn.io/v1/callback voor het webplatform hebt geconfigureerd in de registratie van de clienttoepassing.

    Schermopname van de callback-URL.

  3. Voeg in de registratie van de clienttoepassing onder API-machtigingen de User_Impersonation gedelegeerde machtiging toe voor Azure Healthcare APIS van API's die mijn organisatie gebruikt.

    Schermopname van toepassingsregistratiemachtigingen.

    Schermopname van het scherm met toepassingsregistratiemachtigingen.

  4. Selecteer in Postman het tabblad Autorisatie van een verzameling of een specifieke REST-aanroep, selecteer Type als OAuth 2.0 en stel onder De sectie Nieuw token configureren de volgende waarden in:

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

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

    • URL van toegangstoken: https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/token

    • Client-id: registratie-id van toepassingsclient

    • Clientgeheim: registratiegeheim van toepassingsclient

    • Bereik: {{fhirurl}}/.default

    • Clientverificatie: clientreferenties verzenden in hoofdtekst

    Schermopname van het configuratiescherm.

  5. Kies Nieuw toegangstoken ophalen onder aan de pagina.

  6. U wordt gevraagd om gebruikersreferenties voor aanmelding.

  7. U ontvangt het token. Kies Token gebruiken.

  8. Zorg ervoor dat het token zich in de autorisatieheader van de REST-aanroep bevindt.

Bekijk het toegangstoken met behulp van onlinehulpprogramma's zoals https://jwt.ms. Selecteer het tabblad Claims om gedetailleerde beschrijvingen voor elke claim in het token te bekijken.

Verbinding maken naar de FHIR-server

Open Postman, selecteer de werkruimte, verzameling en omgeving die u wilt gebruiken. Selecteer het + pictogram om een nieuwe aanvraag te maken.

Schermopname van het maken van een nieuwe aanvraag.

Als u de statuscontrole wilt uitvoeren op de FHIR-service, voert {{fhirurl}}/health/check u de GET-aanvraag in en kiest u Vervolgens Verzenden. U moet het Status of FHIR service - HTTP Status codeantwoord kunnen zien met 200 en OverallStatus als In orde in reactie, wat betekent dat uw statuscontrole is geslaagd.

De FHIR-resource ophalen

Nadat u een Microsoft Entra-toegangstoken hebt verkregen, hebt u toegang tot de FHIR-gegevens. Voer in een nieuwe GET aanvraag in {{fhirurl}}/Patient.

Selecteer Bearer-token als autorisatietype. Voer {{bearerToken}} in de sectie Token in. Selecteer Verzenden. Als reactie ziet u een lijst met patiënten in uw FHIR-resource.

Schermopname van de selectie van bearer-token.

De FHIR-resource maken of bijwerken

Nadat u een Microsoft Entra-toegangstoken hebt verkregen, kunt u de FHIR-gegevens maken of bijwerken. U kunt bijvoorbeeld een nieuwe patiënt maken of een bestaande patiënt bijwerken.

Maak een nieuwe aanvraag, wijzig de methode in Post en voer vervolgens de waarde in de aanvraagsectie in.

{{fhirurl}}/Patient

Selecteer Bearer-token als autorisatietype. Voer {{bearerToken}} in de sectie Token in. Selecteer het tabblad Hoofdtekst . Selecteer de onbewerkte optie en JSON als hoofdtekstindeling. Kopieer en plak de tekst in de hoofdtekstsectie.

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

Selecteer Verzenden. Als het goed is, ziet u een nieuwe patiënt in het JSON-antwoord.

Schermopname van de knop Verzenden om een nieuwe patiënt te maken.

FHIR-gegevens exporteren

Nadat u een Microsoft Entra-toegangstoken hebt verkregen, kunt u FHIR-gegevens exporteren naar een Azure-opslagaccount.

Maak een nieuwe GET aanvraag: {{fhirurl}}/$export?_container=export

Selecteer Bearer-token als autorisatietype. Voer {{bearerToken}} in de sectie Token in. Selecteer Kopteksten om twee nieuwe headers toe te voegen:

  • Accepteren: application/fhir+json

  • Liever: respond-async

Selecteer Verzenden. U ziet een 202 Accepted antwoord. Selecteer het tabblad Kopteksten van het antwoord en noteer de waarde in de inhoudslocatie. U kunt de waarde gebruiken om een query uit te voeren op de status van de exporttaak.

Schermopname van het geaccepteerde antwoord selectie 202.

Volgende stappen

Starterverzameling van Postman-voorbeeldquery's

Notitie

FHIR® is een geregistreerd handelsmerk van HL7 en wordt gebruikt met de machtiging HL7.