Aceda ao serviço FHIR utilizando o Postman

  • Artigo

Este artigo mostra as etapas para acessar o serviço FHIR® nos Serviços de Dados de Saúde do Azure com o Postman.

Pré-requisitos

  • Serviço FHIR implantado no Azure. Para obter mais informações, consulte Implantar um serviço FHIR.
  • Uma aplicação cliente registada para aceder ao serviço FHIR. Para obter mais informações, consulte Registrar um aplicativo cliente de serviço na ID do Microsoft Entra.
  • Permissões de Contribuidor de Dados FHIR concedidas ao aplicativo cliente e à sua conta de usuário.
  • Carteiro instalado localmente. Para obter mais informações, consulte Introdução ao Postman.

Criar um espaço de trabalho, coleção e ambiente

Se você é novo no Postman, siga estas etapas para criar um espaço de trabalho, uma coleção e um ambiente.

O Postman apresenta o conceito de espaço de trabalho para permitir que você e sua equipe compartilhem APIs, coleções, ambientes e outros componentes. Você pode usar o espaço de trabalho padrão Meu espaço de trabalho ou o espaço de trabalho de equipe ou criar um novo espaço de trabalho para você ou sua equipe.

Captura de tela mostrando a criação do espaço de trabalho.

Em seguida, crie uma nova coleção onde você pode agrupar todas as solicitações de API REST relacionadas. No espaço de trabalho, selecione Criar coleções. Você pode manter o nome padrão Nova coleção ou renomeá-la. A alteração é guardada automaticamente.

Captura de tela mostrando a criação de uma nova coleção.

Você também pode importar e exportar coleções do Postman. Para obter mais informações, consulte a documentação do Postman.

Captura de tela mostrando a importação e exportação de coleções.

Criar ou atualizar variáveis de ambiente

Embora você possa usar a URL completa na solicitação, recomendamos que armazene a URL e outros dados em variáveis.

Para acessar o serviço FHIR, você precisa criar ou atualizar estas variáveis:

Variável Descrição Notas
inquilino Locatário do Azure onde o serviço FHIR é implantado Localizado na visão geral do registro do aplicativo
Subid Assinatura do Azure onde o serviço FHIR é implantado Localizado na visão geral do serviço FHIR
ID do cliente ID de registro do cliente do aplicativo -
ClientSecret Segredo de registro do cliente do aplicativo -
Fhirurl O URL completo do serviço FHIR (por exemplo, https://xxx.azurehealthcareapis.com) Localizado na visão geral do serviço FHIR
portadorToken Armazena o token de acesso do Microsoft Entra no script Deixar em branco

Nota

Certifique-se de configurar a URL https://www.getpostman.com/oauth2/callback de redirecionamento no registro do aplicativo cliente.

Captura de tela mostrando ambientes variáveis.

Obtenha a declaração de capacidade

Introduza {{fhirurl}}/metadata o GETpedido e, em seguida, selecione Send. Você deve ver a declaração de capacidade do serviço FHIR.

Captura de tela mostrando os parâmetros de solicitação de capacidade.

Captura de ecrã a mostrar um pedido de guarda.

Obter um de acesso do Microsoft Entra

Obtenha um token de acesso do Microsoft Entra usando uma entidade de serviço ou uma conta de usuário do Microsoft Entra. Escolha um dos dois métodos.

Usar uma entidade de serviço com um tipo de concessão de credenciais de cliente

O serviço FHIR é protegido pelo Microsoft Entra ID. A autenticação padrão não pode ser desabilitada. Para acessar o serviço FHIR, você precisa obter um token de acesso do Microsoft Entra primeiro. Para obter mais informações, consulte Tokens de acesso à plataforma de identidade da Microsoft.

Crie um novo POST pedido:

  1. Digite o cabeçalho da solicitação: https://login.microsoftonline.com/{{tenantid}}/oauth2/token

  2. Selecione a guia Corpo e selecione x-www-form-urlencoded. Insira os seguintes valores na seção de chave e valor:

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

Nota

Em cenários em que o parâmetro FHIR service audience não é mapeado para a URL do ponto de extremidade do serviço FHIR, o valor do parâmetro resource deve ser mapeado para o valor audience no painel Autenticação do serviço FHIR.

  1. Selecione a guia Test e insira na seção de texto: pm.environment.set("bearerToken", pm.response.json().access_token); Para disponibilizar o valor para a coleção, use o método pm.collectionVariables.set. Para obter mais informações sobre o método set e seu nível de escopo, consulte Usando variáveis em scripts.
  2. Selecione Guardar para guardar as definições.
  3. Selecione Enviar. Você verá uma resposta com o token de acesso do Microsoft Entra, que é salvo na variável bearerToken automaticamente. Em seguida, você pode usá-lo em todas as solicitações de API de serviço FHIR.

Captura de ecrã a mostrar o botão enviar.

Você pode examinar o token de acesso usando ferramentas on-line como https://jwt.ms. Selecione a guia Declarações para ver descrições detalhadas de cada declaração no token.

Captura de tela mostrando declarações de token de acesso.

Usar uma conta de usuário com o tipo de concessão de código de autorização

Você pode obter o token de acesso do Microsoft Entra usando suas credenciais de conta do Entra e seguindo as etapas listadas.

  1. Verifique se você é um membro do locatário do Microsoft Entra com as permissões de acesso necessárias.

  2. Certifique-se de configurar a URL https://oauth.pstmn.io/v1/callback de redirecionamento para a plataforma Web no registro do aplicativo cliente.

    Captura de tela mostrando o URL de retorno de chamada.

  3. No registro do aplicativo cliente em Permissões de API, adicione a permissão delegada User_Impersonation para APIS do Azure Healthcare de APIs que minha organização usa.

    Captura de tela mostrando as permissões de registro do aplicativo.

    Captura de tela mostrando a tela de permissões de registro do aplicativo.

  4. No Carteiro, selecione a guia Autorização de uma coleção ou de uma chamada REST específica, selecione Tipo como OAuth 2.0 e, na seção Configurar Novo Token , defina estes valores:

    • URL de retorno de chamada: https://oauth.pstmn.io/v1/callback

    • URL de autenticação: https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/authorize

    • URL do token de acesso: https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/token

    • ID do cliente: ID de registro do cliente do aplicativo

    • Segredo do cliente: segredo de registro do cliente do aplicativo

    • Âmbito de aplicação: {{fhirurl}}/.default

    • Autenticação de cliente: Enviar credenciais de cliente no corpo

    Captura de tela mostrando a tela de configuração.

  5. Escolha Obter novo token de acesso na parte inferior da página.

  6. Ser-lhe-ão pedidas credenciais de utilizador para iniciar sessão.

  7. Você recebe o token. Escolha Usar token.

  8. Verifique se o token está no cabeçalho de autorização da chamada REST.

Examine o token de acesso usando ferramentas on-line como https://jwt.ms. Selecione a guia Declarações para ver descrições detalhadas de cada declaração no token.

Conectar-se ao servidor FHIR

Abra o Postman, selecione o espaço de trabalho, a coleção e o ambiente que deseja usar. Selecione o + ícone para criar uma nova solicitação.

Captura de tela mostrando a criação de uma nova solicitação.

Para executar a verificação de integridade no serviço FHIR, insira {{fhirurl}}/health/check a solicitação GET e escolha Enviar. Você deve ser capaz de ver a resposta do código com 200 e OverallStatus como Saudável em resposta, o Status of FHIR service - HTTP Status que significa que sua verificação de integridade foi bem-sucedida.

Obter o recurso FHIR

Depois de obter um token de acesso do Microsoft Entra, você pode acessar os dados FHIR. Em uma nova GET solicitação, digite {{fhirurl}}/Patient.

Selecione Token ao portador como tipo de autorização. Entre {{bearerToken}} na seção Token . Selecione Enviar. Como resposta, você deve ver uma lista de pacientes em seu recurso FHIR.

Captura de tela mostrando a seleção do token de portador.

Criar ou atualizar o recurso FHIR

Depois de obter um token de acesso do Microsoft Entra, você pode criar ou atualizar os dados FHIR. Por exemplo, você pode criar um novo paciente ou atualizar um paciente existente.

Crie uma nova solicitação, altere o método para Post e insira o valor na seção de solicitação.

{{fhirurl}}/Patient

Selecione Token ao portador como o tipo de autorização. Entre {{bearerToken}} na seção Token . Selecione a guia Corpo . Selecione a opção raw e JSON como formato de corpo de texto. Copie e cole o texto na seção do corpo.

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

Selecione Enviar. Você deve ver um novo paciente na resposta JSON.

Captura de tela mostrando o botão enviar para criar um novo paciente.

Exportar dados do FHIR

Depois de obter um token de acesso do Microsoft Entra, você pode exportar dados FHIR para uma conta de armazenamento do Azure.

Crie um novo GET pedido: {{fhirurl}}/$export?_container=export

Selecione Token ao portador como tipo de autorização. Entre {{bearerToken}} na seção Token . Selecione Cabeçalhos para adicionar dois novos cabeçalhos:

  • Aceitar: application/fhir+json

  • Prefira: respond-async

Selecione Enviar. Você deve notar uma 202 Accepted resposta. Selecione a guia Cabeçalhos da resposta e anote o valor no Local do conteúdo. Você pode usar o valor para consultar o status do trabalho de exportação.

Captura de tela mostrando a seleção 202 respostas aceitas.

Próximos passos

Coleção inicial de consultas de amostra do Postman

Nota

FHIR® é uma marca registada da HL7 e é utilizada com a permissão da HL7.