Dostęp przy użyciu narzędzia Postman

W tym artykule omówimy kroki uzyskiwania dostępu do usług Azure Health Data Services (zwanej dalej usługą FHIR) za pomocą narzędzia Postman.

Wymagania wstępne

• Usługa FHIR wdrożona na platformie Azure. Aby uzyskać informacje o sposobie wdrażania usługi FHIR, zobacz Wdrażanie usługi FHIR.
• Zarejestrowana aplikacja kliencka w celu uzyskania dostępu do usługi FHIR. Aby uzyskać informacje o sposobie rejestrowania aplikacji klienckiej, zobacz Rejestrowanie aplikacji klienckiej usługi w usłudze Azure Active Directory.
• Uprawnienia przyznane aplikacji klienckiej i konta użytkownika, na przykład "Współautor danych FHIR", aby uzyskać dostęp do usługi FHIR.
• Narzędzie Postman zainstalowane lokalnie. Aby uzyskać więcej informacji na temat narzędzia Postman, zobacz Rozpoczynanie pracy z programem Postman.

Używanie narzędzia Postman: tworzenie obszaru roboczego, kolekcji i środowiska

Jeśli dopiero zaczynasz korzystać z narzędzia Postman, wykonaj poniższe kroki. W przeciwnym razie możesz pominąć ten krok.

Postman wprowadza koncepcję obszaru roboczego, aby umożliwić Tobie i zespołowi udostępnianie interfejsów API, kolekcji, środowisk i innych składników. Możesz użyć domyślnego "Mój obszar roboczy" lub "Obszar roboczy zespołu" lub utworzyć nowy obszar roboczy dla Ciebie lub twojego zespołu.

Następnie utwórz nową kolekcję, w której można grupować wszystkie powiązane żądania interfejsu API REST. W obszarze roboczym wybierz pozycję Utwórz kolekcje. Możesz zachować domyślną nazwę Nowa kolekcja lub zmienić jej nazwę. Zmiana jest zapisywana automatycznie.

Można również importować i eksportować kolekcje Postman. Aby uzyskać więcej informacji, zobacz dokumentację narzędzia Postman.

Tworzenie lub aktualizowanie zmiennych środowiskowych

Chociaż możesz użyć pełnego adresu URL w żądaniu, zaleca się przechowywanie adresu URL i innych danych w zmiennych i używanie ich.

Aby uzyskać dostęp do usługi FHIR, musimy utworzyć lub zaktualizować następujące zmienne.

• tenantid — dzierżawa platformy Azure, w której wdrożono usługę FHIR. Znajduje się on w menu Przegląd rejestracji aplikacji .
• subid — subskrypcja platformy Azure, w której wdrożono usługę FHIR. Znajduje się on w menu przeglądu usługi FHIR .
• clientid — identyfikator rejestracji klienta aplikacji.
• clientsecret — wpis tajny rejestracji klienta aplikacji.
• fhirurl — pełny adres URL usługi FHIR. Na przykład https://xxx.azurehealthcareapis.com. Znajduje się on w menu przeglądu usługi FHIR .
• bearerToken — zmienna do przechowywania tokenu dostępu usługi Azure Active Directory (Azure AD) w skrypcie. Pozostaw to pole puste.

Uwaga

Upewnij się, że skonfigurowano adres URL przekierowania , https://www.getpostman.com/oauth2/callbackw rejestracji aplikacji klienckiej.

Nawiązywanie połączenia z serwerem FHIR

Otwórz program Postman, wybierz obszar roboczy, kolekcję i środowisko , którego chcesz użyć. Wybierz ikonę, + aby utworzyć nowe żądanie.

Aby sprawdzić kondycję usługi FHIR, wprowadź {{fhirurl}}/health/check w żądaniu GET i wybierz pozycję Wyślij. Powinna być widoczna odpowiedź stanu usługi FHIR — odpowiedź kodu stanu HTTP z wartością 200 i stanem ogólnym jako "W dobrej kondycji" w odpowiedzi oznacza, że sprawdzanie kondycji jest udane.

Get capability, instrukcja

Wprowadź {{fhirurl}}/metadata w żądaniu GETi wybierz pozycję Send. Powinna zostać wyświetlona instrukcja możliwości usługi FHIR.

Uzyskiwanie tokenu dostępu Azure AD

Usługa FHIR jest zabezpieczona przez Azure AD. Nie można wyłączyć domyślnego uwierzytelniania. Aby uzyskać dostęp do usługi FHIR, najpierw musisz uzyskać token dostępu Azure AD. Aby uzyskać więcej informacji, zobacz Platforma tożsamości Microsoft tokeny dostępu.

Utwórz nowe POST żądanie:

1. Wprowadź w nagłówku żądania: https://login.microsoftonline.com/{{tenantid}}/oauth2/token

2. Wybierz kartę Treść i wybierz pozycję x-www-form-urlencoded. Wprowadź następujące wartości w sekcji klucz i wartość:

   • grant_type: Client_Credentials
   • client_id: {{clientid}}
   • client_secret: {{clientsecret}}
   • zasób: {{fhirurl}}

3. Wybierz kartę Test i wprowadź w sekcji tekstowej: pm.environment.set("bearerToken", pm.response.json().access_token); Aby udostępnić wartość kolekcji, użyj metody pm.collectionVariables.set. Aby uzyskać więcej informacji na temat metody set i jej poziomu zakresu, zobacz Using variables in scripts (Używanie zmiennych w skryptach).

4. Wybierz pozycję Zapisz, aby zapisać ustawienia.

5. Wybierz pozycję Wyślij. Powinna zostać wyświetlona odpowiedź z tokenem dostępu Azure AD, który jest zapisywany automatycznie w zmiennejbearerToken. Następnie można go użyć we wszystkich żądaniach interfejsu API usługi FHIR.

Token dostępu można sprawdzić przy użyciu narzędzi online, takich jak https://jwt.ms. Wybierz kartę Oświadczenia, aby wyświetlić szczegółowe opisy poszczególnych oświadczeń w tokenie.

Pobieranie zasobu FHIR

Po uzyskaniu tokenu dostępu Azure AD możesz uzyskać dostęp do danych FHIR. W nowym GET żądaniu wprowadź .{{fhirurl}}/Patient

Wybierz pozycję Token elementu nośnego jako typ autoryzacji. Wprowadź w {{bearerToken}} sekcji Token (Token ). Wybierz pozycję Wyślij. W odpowiedzi powinna zostać wyświetlona lista pacjentów w zasobie FHIR.

Tworzenie lub aktualizowanie zasobu FHIR

Po uzyskaniu tokenu dostępu Azure AD możesz utworzyć lub zaktualizować dane FHIR. Możesz na przykład utworzyć nowego pacjenta lub zaktualizować istniejącego pacjenta.

Utwórz nowe żądanie, zmień metodę na "Post" i wprowadź wartość w sekcji żądania.

{{fhirurl}}/Patient

Wybierz pozycję Token elementu nośnego jako typ autoryzacji. Wprowadź w {{bearerToken}} sekcji Token (Token ). Wybierz kartę Treść . Wybierz opcję nieprzetworzoną i format JSON jako format tekstu treści. Skopiuj i wklej tekst do sekcji treści.

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

Wybierz pozycję Wyślij. W odpowiedzi JSON powinien zostać wyświetlony nowy pacjent.

Eksportowanie danych FHIR

Po uzyskaniu tokenu dostępu Azure AD możesz wyeksportować dane FHIR do konta usługi Azure Storage.

Utwórz nowe GET żądanie: {{fhirurl}}/$export?_container=export

Wybierz pozycję Token elementu nośnego jako typ autoryzacji. Wprowadź wartość {{bearerToken}} w sekcji Token (Token ). Wybierz pozycję Nagłówki , aby dodać dwa nowe nagłówki:

• Zaakceptuj: application/fhir+json
• Preferuj: respond-async

Wybierz pozycję Wyślij. Powinna zostać wyświetlona 202 Accepted odpowiedź. Wybierz kartę Nagłówki odpowiedzi i zanotuj wartość w polu Content-Location. Możesz użyć wartości , aby wykonać zapytanie dotyczące stanu zadania eksportu.

Następne kroki

W tym artykule przedstawiono sposób uzyskiwania dostępu do usługi FHIR w usługach Azure Health Data Services za pomocą narzędzia Postman. Aby uzyskać informacje o usłudze FHIR w usługach Azure Health Data Services, zobacz

Co to jest usługa FHIR?

Aby zapoznać się z początkową kolekcją przykładowych zapytań Postman, zobacz nasze repozytorium przykładów w witrynie Github.
FHIR® jest zastrzeżonym znakiem towarowym HL7 i jest używany z pozwoleniem HL7.