Acceso mediante Postman

Importante

Azure Healthcare APIs se encuentra actualmente en VERSIÓN PRELIMINAR. Los Términos de uso complementarios para las versiones preliminares de Microsoft Azure incluyen términos legales adicionales que se aplican a las características de Azure que se encuentran en la versión beta, en versión preliminar o que todavía no se han publicado con disponibilidad general.

En este artículo, recorreremos los pasos para acceder al servicio FHIR de Healthcare APIs (que se conoce como el servicio FHIR) con Postman.

Requisitos previos

  • El servicio FHIR implementado en Azure. Para obtener información sobre cómo implementar el servicio FHIR, vea Deploy a FHIR service.
  • Una aplicación cliente registrada para acceder al servicio FHIR. Para obtener información sobre cómo registrar una aplicación cliente, vea Registrar una aplicación cliente de servicio en Azure Active Directory.
  • Permisos concedidos a la aplicación cliente y a su cuenta de usuario, por ejemplo, "Colaborador de datos de FHIR", para acceder al servicio FHIR.
  • Postman instalado localmente. Para obtener más información sobre Postman, vea Introducción con Postman.

Uso de Postman: creación de un área de trabajo, una colección y un entorno

Si no está nuevo en Postman, siga estos pasos. Omita este paso si prefiere no hacerlo

Postman presenta el concepto de área de trabajo para que usted y su equipo puedan compartir API, colecciones, entornos y otros componentes. Puede usar el valor predeterminado "Mi área de trabajo" o "Área de trabajo de equipo" o crear una nueva área de trabajo para usted o su equipo.

Screenshot of create a new workspace in Postman.

A continuación, cree una nueva colección donde pueda agrupar todas las solicitudes de API REST relacionadas. En el área de trabajo, seleccione Crear colecciones. Puede mantener el nombre predeterminado Nueva colección o cambiarle el nombre. El cambio se guarda automáticamente.

Screenshot of create a new collection.

También puede importar y exportar colecciones de Postman. Para obtener más información, vea la documentación de Postman.

Screenshot of import data.

Creación o actualización de variables de entorno

Aunque puede usar la dirección URL completa en la solicitud, se recomienda almacenar la dirección URL y otros datos en variables y usarlas.

Para acceder al servicio FHIR, es necesario crear o actualizar las siguientes variables.

  • tenantid: inquilino de Azure en el que se implementa el servicio FHIR. Se encuentra en la opción de menú Introducción al registro de aplicaciones.
  • subid: suscripción de Azure en la que se implementa el servicio FHIR. Se encuentra en la opción de menú información general del servicio FHIR.
  • clientid: identificador de registro de cliente de aplicación.
  • clientsecret: secreto de registro de cliente de aplicación.
  • fhirurl: dirección URL completa del servicio FHIR. Por ejemplo: https://xxx.azurehealthcareapis.com. Se encuentra en la opción de menú información general del servicio FHIR.
  • bearerToken: la variable para almacenar el token Azure Active Directory (Azure AD) en el script. Deje este parámetro en blanco.

Nota:

Asegúrese de que ha configurado la dirección URL de redireccionamiento, https://www.getpostman.com/oauth2/callback , en el registro de la aplicación cliente.

Screenshot of environments variable.

Conectar al servidor de FHIR

Abra Postman, seleccione el área detrabajo, lacolección y el entorno que desea usar. Seleccione el + icono para crear una nueva solicitud.

Screenshot of create a new request.

Instrucción get capability

Escriba {{fhirurl}}/metadata en la solicitud y presione GETSend . Debería ver la instrucción de funcionalidad del servicio FHIR.

Screenshot of capability statement parameters.

Screenshot of save request.

Obtener Azure AD token de acceso

El servicio FHIR está protegido por Azure AD. No se puede deshabilitar la autenticación predeterminada. Para acceder al servicio FHIR, primero debe obtener un token Azure AD acceso. Para obtener más información, vea Plataforma de identidad de Microsoft tokens de acceso.

Cree una nueva POST solicitud:

  1. Escriba en el encabezado de solicitud: https://login.microsoftonline.com/{{tenantid}}/oauth2/token

  2. Seleccione la pestaña Cuerpo y seleccione x-www-form-urlencoded. Escriba los siguientes valores en la sección clave y valor:

    • grant_type:
    • client_id:
    • client_secret:
    • resource:
  3. Seleccione la pestaña Prueba y escriba en la sección de texto:

  4. Haga clic en Save (Guardar) para guardar la configuración.

  5. Presione Enviar. Debería ver una respuesta con el token Azure AD de acceso, que se guarda automáticamente en bearerToken la variable. A continuación, puede usarlo en todas las solicitudes de API del servicio FHIR.

Screenshot of send button.

Puede examinar el token de acceso mediante herramientas en línea como https://jwt.ms . Seleccione la pestaña Notificaciones para ver descripciones detalladas de cada notificación en el token.

Screenshot of access token claims.

Obtener el recurso de FHIR

Después de obtener un token de Azure AD, puede acceder a los datos de FHIR. En una nueva GET solicitud, escriba {{fhirurl}}/Patient .

Seleccione Bearer Token (Token de portador) como tipo de autorización. Escriba {{bearerToken}} en la sección {{bearerToken}} . Seleccione Enviar. Como respuesta, debería ver una lista de pacientes en el recurso de FHIR.

Screenshot of select bearer token.

Creación o actualización del recurso de FHIR

Después de obtener un token de Azure AD, puede crear o actualizar los datos de FHIR. Por ejemplo, puede crear un nuevo paciente o actualizar uno existente.

Cree una nueva solicitud, cambie el método a "Post" y escriba el valor en la sección de solicitud.

{{fhirurl}}/Patient

Seleccione Bearer Token (Token de portador) como tipo de autorización. Escriba {{bearerToken}} en la sección {{bearerToken}} . Seleccione la pestaña Cuerpo. Seleccione la opción sin formato y JSON como formato de texto del cuerpo. Copie y pegue el texto en la sección del cuerpo.

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

Seleccione Enviar. Debería ver un nuevo paciente en la respuesta JSON.

Screenshot of send button to create a new patient.

Exportación de datos de FHIR

Después de obtener un token de Azure AD, puede exportar los datos de FHIR a una cuenta de almacenamiento de Azure.

Cree una nueva GET solicitud: {{fhirurl}}/$export?_container=export

Seleccione Bearer Token (Token de portador) como tipo de autorización. Escriba {{bearerToken}} en la sección {{bearerToken}} . Seleccione Encabezados para agregar dos nuevos encabezados:

  • Acepte:
  • Prefiere:

Presione Enviar. Debería observar una 202 Accepted respuesta. Seleccione la pestaña Encabezados de la respuesta y anote el valor en Content-Location. Puede usar el valor para consultar el estado del trabajo de exportación.

Screenshot of post to create a new patient 202 accepted response.

Pasos siguientes

En este artículo, ha aprendido a acceder al servicio FHIR en las API de Azure Healthcare con Postman. Para obtener información sobre el servicio FHIR en las API de Azure Healthcare, consulte