Compartir a través de

Información general de Dataverse Healthcare APIs

  • Artículo

Las API de atención sanitaria de Dataverse son una oferta completa de productos de Microsoft Cloud for Healthcare que le permiten interactuar con Dataverse utilizando el estándar FHIR (Recursos de interoperabilidad sanitarios rápidos). Las API usan las asignaciones del kit de herramientas de integración de datos para transformar los paquetes entre FHIR y Dataverse.

Estas API se implementan como API de Dataverse diseñadas para aceptar paquetes FHIR como parámetros de entrada. Las API manejan la asignación y la transformación de recursos FHIR individuales y publican los registros resultantes en Dataverse. Puede autenticarse y proteger estos puntos finales como lo haría con las API estándar de Dataverse.

Nota

Para obtener más información sobre las API estándar de Dataverse, vaya a Crear y usar API personalizadas.

Las Dataverse Healthcare APIs se pueden usar para:

  • Publicar datos basados en FHIR directamente en Dataverse.
  • Sincronizar Dataverse con servicios FHIR externos como Azure Health Data Services.

Estas API combinadas con Azure Logic Apps constituyen el reemplazo de Microsoft Cloud for Healthcare de las herramientas del agente de sincronización FHIR Azure.

No es necesario utilizar la aplicación lógica proporcionada para utilizar las API de atención médica de Dataverse. Puede crear su propia aplicación lógica, con Power Automate o desarrollar su propio código personalizado. Tampoco hay ningún requisito para sincronizar datos con un servicio FHIR externo. Puede sincronizar con los puntos finales FHIR de Azure Health Data Services o publicar datos directamente en las API. Las Dataverse Healthcare APIs están destinadas a ser un componente flexible que se puede usar para diseñar sus soluciones de atención médica en torno a Microsoft Cloud for Healthcare.

Sección Contenido
Dataverse Healthcare APIs Resume información sobre las API actualmente disponibles como parte de las API de atención médica de Dataverse.
Descripción general de la reescritura de Dataverse Healthcare APIs Explica el proceso de reescritura para Dataverse Healthcare APIs.
Configurar las Dataverse Healthcare API Contiene pasos para configurar las Dataverse Healthcare APIs.
Configurar Azure Logic Apps con un desencadenador HTTP Contiene una guía detallada paso a paso guía para crear su propia aplicación lógica que pueda ingerir datos FHIR en API de atención médica de Dataverse, Azure Health Data Services o ambos.
Usar la plantilla de canalización de datos de Healthcare para implementar Azure Logic Apps Proporciona guías paso a paso para usar una plantilla para implementar un grupo de Azure Logic Apps que orquesta la ingestión de agrupaciones de FHIR en Dataverse Healthcare API y Azure Health Data Services.
Usar las Dataverse Healthcare APIs Resume cómo invocar y utilizar las API de atención médica de Dataverse, con ejemplos y escenarios de uso comunes.
Revisar los registros de Dataverse Healthcare API Explica cómo revisar los registros de transacciones para actividades de las Dataverse healthcare API.

Dataverse Healthcare APIs

Las siguientes API están actualmente disponibles como parte de las Dataverse Healthcare APIs:

  • API de agrupación de upsert
  • Recuperar API de agrupación

API de agrupación de upsert

La API de agrupación de upsert permite enviar paquetes FHIR a Dataverse y transformarlos en registros de Dataverse.

La API es compatible actualmente con las siguientes capacidades:

  • La ingesta de paquetes de recursos únicos y mixtos. Un solo paquete de recursos contiene solo un tipo de recurso, mientras que uno mixto contiene varios tipos de recursos.
  • La ingestión de tipos de paquetes por lotes. Para obtener más información, vaya a Tipos de agrupación admitidos.
  • Ingestión de paquetes con referencias de nombre de recurso uniforme (URN).
  • Integridad referencial de los paquetes FHIR: un recurso se creará en Dataverse solo si se resuelven todas sus referencias.
  • La creación de registros ampliados para cada recurso FHIR en Dataverse.
  • La creación de codeable concepts cuando faltan en Dataverse.
  • Respuestas detalladas y localizadas.

La API (msind_UpsertBundle) tiene dos parámetros de solicitud definidos de la siguiente manera:

Parámetro de la solicitud Descripción
msind_JSON El paquete FHIR que debe insertarse (valor obligatorio).
msind_BundleTag Una etiqueta que ayuda a identificar los paquetes al analizar los registros en Dataverse (valor opcional).

Para obtener información sobre cómo invocar la API y revisar algunos escenarios de uso comunes, vaya a Invocar la API del paquete upsert desde la API web.

Después de la invocación de la API, puede esperar los siguientes elementos en la respuesta JSON:

Parámetro de respuesta Descripción
msind_Status Un valor booleano que indica si el paquete se procesó correctamente y si se insertaron todos los recursos válidos de Dataverse.
msind_StatusDetail Proporciona información detallada sobre el valor msind_Status.
msind_fhirresourceid Id. FHIR del recurso en el paquete. Si una entrada en el resultado pertenece a un registro expandido, el valor es el id. de FHIR del recurso raíz.
msind_fhirresourcetype Id. FHIR del tipo de recurso del recurso en el paquete. Si una entrada en el resultado pertenece a un registro expandido, el valor es el tipo de recurso de FHIR del recurso raíz.
msind_resultingrecordid El ID de Dataverse después de que se inserta el registro. Si una entrada en el resultado pertenece a un registro expandido, el valor es el id. de Dataverse del recurso raíz.
msind_resultingrecordtype El nombre de la entidad de Dataverse en la que se ha realizado la operación upsert sobre el registro. Si una entrada en el resultado pertenece a un registro expandido, el valor el nombre de la entidad de Dataverse del registro expandido.
msind_requestactionperformed El tipo de acción realizada. Para ver los valores esperados y su descripción, vaya a Tipos de acciones de solicitud realizadas.
msind_requeststatus Estado de la solicitud. Para ver los valores esperados y su descripción, vaya a Tipos de estados de solicitud.
msind_requeststatusdetail Información detallada sobre el valor msind_requeststatus.

Tipos de acciones de solicitud realizadas

La tabla siguiente muestra los valores esperados para el parámetro de la respuesta msind_requestactionperformed:

valor Descripción
935000000 Se crea un recurso raíz.
935000001 Se actualiza un recurso raíz ya existente en Dataverse.
935000002 La acción se realizó en una entidad expandida.

Tipos de estado de solicitud

La tabla siguiente muestra los valores esperados para el parámetro de la respuesta msind_requeststatus:

valor Descripción
935000000 El upsert de recursos resultó en un éxito.
935000001 El upsert de recursos resultó en una advertencia.
935000002 El upsert de recursos resultó en un error.

Tipos de agrupación admitidos

La API de paquete upsert actualmente admite paquetes del tipo batch y batch-response. Para ingerir paquetes de tipos que no son compatibles, primero debe cambiar el tipo de paquete que está enviando. Si desea cambiar el tipo de paquete a lote antes de publicar en las API, puede usar la acción de reemplazar integrada de la aplicación lógica para cambiar el tipo de paquete. Este paso procesa el paquete como un grupo de acciones independientes.

Al cambiar el tipo de paquete a lote, es importante considerar el efecto que podría tener en sus escenarios individuales. Cambiar un paquete transaccional a lote podría tener efectos no deseados en los datos que está intentando incorporar en Dataverse. Para obtener más información sobre las reglas para usar estos paquetes, vaya a HL7 FHIR - Uso de paquetes.

Si envía un paquete del tipo batch-response, la Dataverse Healthcare API registra recursos del tipo OperationOutcome con valor de gravedad error a los registros. Esta acción le permite publicar el paquete en un servidor FHIR y canalizar la respuesta del servidor FHIR a la Dataverse Healthcare API. Como resultado, puede capturar todos los errores en un solo lugar.

Recuperar API de agrupación

La API del paquete de recuperación le permite consultar Dataverse para un solo recurso FHIR utilizando el ID de FHIR. La API transforma la solicitud y utiliza los mapas del kit de herramientas de integración de datos para responder con un recurso estandarizado FHIR.

La API es compatible actualmente con las siguientes capacidades:

  • Consulta de un solo registro utilizando el id. de FHIR.
  • Registro detallado y localizado.

La API (msind_RetrieveBundle) tiene un parámetro de solicitud definido de la siguiente manera:

Parámetro de la solicitud Descripción
msind_FHIRQuery La consulta FHIR a ejecutar (valor requerido).

Consultas FHIR admitidas

Consultar Descripción
FHIRResource/FHIRID La consulta devuelve el recurso completo junto con las entidades expandidas.
FHIRResource/FHIRId?_elements=element_1,element_2,...,element_n La consulta devuelve los elementos especificados en la consulta junto con los elementos marcados como FHIR requerido en el mapa de atributos.

Para más información, vaya a Búsqueda de elementos FHIR.

Para obtener información sobre cómo invocar la API y revisar algunos escenarios de uso comunes, vaya a Invocar la API del paquete de recuperación desde la API web.

Después de la invocación de la API, puede ver una respuesta que contiene el estado de la solicitud completa y el estado detallado de cada recurso y sus elementos expandidos.

Parámetro de respuesta Descripción
msind_Status Un valor booleano que indica si la acción se procesó correctamente.
msind_StatusDetail Proporciona información detallada sobre el valor msind_Status.
msind_JSON Representación JSON de FHIR.