Acceso mediante Postman

En este artículo, le guiaremos por los pasos necesarios para acceder a Azure Health Data Services (en adelante denominado servicio FHIR) con Postman.

Prerrequisitos

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

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

Postman presenta el concepto de área de trabajo para permitirle y su equipo 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.

Captura de pantalla de la creación de un área de trabajo en Postman.

A continuación, cree una colección en la que puede 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.

Captura de pantalla de la creación de una nueva colección.

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

Captura de pantalla de la importación de datos.

Crear o actualizar 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ú Información general del registro de aplicaciones.
  • subid : suscripción de Azure en la que se implementa el servicio FHIR. Se encuentra en la opción de menú de información general del servicio FHIR .
  • clientid : id. 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ú de información general del servicio FHIR .
  • bearerToken : la variable para almacenar el token de acceso de 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.

Captura de pantalla de la variable de entornos.

Conexión al servidor FHIR

Abra Postman, seleccione el área de trabajo, la colección y el entorno que desea usar. Seleccione el + icono para crear una nueva solicitud.

Captura de pantalla de la creación de una nueva solicitud.

Obtención de la instrucción de funcionalidad

Escriba {{fhirurl}}/metadata en la GETsolicitud y seleccione Send. Debería ver la instrucción de funcionalidad del servicio FHIR.

Captura de pantalla de los parámetros de la instrucción de funcionalidad.

Captura de pantalla de la solicitud de guardado.

Obtención del token de acceso de Azure AD

Azure AD protege el servicio FHIR. No se puede deshabilitar la autenticación predeterminada. Para acceder al servicio FHIR, primero debe obtener un token de acceso de Azure AD. Para obtener más información, consulte 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 valores siguientes en la sección clave y valor:

    • grant_type: Client_Credentials
    • client_id: {{clientid}}
    • client_secret: {{clientsecret}}
    • recurso: {{fhirurl}}
  3. Seleccione la pestaña Prueba y escriba en la sección de texto: pm.environment.set("bearerToken", pm.response.json().access_token); Para que el valor esté disponible para la colección, use el método pm.collectionVariables.set. Para obtener más información sobre el método set y su nivel de ámbito, consulte Uso de variables en scripts.

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

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

Captura de pantalla del botón Enviar.

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 del token.

Captura de pantalla de las notificaciones del token de acceso.

Obtención del recurso de FHIR

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

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

Captura de pantalla del token de portador seleccionado.

Creación o actualización del recurso de FHIR

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

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

{{fhirurl}}/Patient

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

{
    "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.

Captura de pantalla del botón Enviar para crear un nuevo paciente.

Exportación de datos de FHIR

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

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

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

  • Aceptar: application/fhir+json
  • Preferir: respond-async

Seleccione 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.

Captura de pantalla de la publicación para crear una nueva respuesta aceptada al paciente 202.

Pasos siguientes

En este artículo, ha aprendido a acceder al servicio FHIR en Azure Health Data Services con Postman. Para más información sobre el servicio FHIR en Azure Health Data Services, consulte

FHIR® es una marca registrada de HL7 y se usa con su permiso.