View a markdown version of this page

Operación de exportación de datos FHIR R4 $davinci-data-para HealthLake - AWS HealthLake
Características principales dePunto final de la operaciónParámetros de la solicitudTipos de exportaciónLógica de inclusión y soporte de perfilesFiltrado temporal para las exportaciones de PDeXSolicitudes de ejemploRespuesta de ejemploRelaciones de recursosGestión de trabajosOutput Format (Formato de salida)Gestión de erroresSeguridad y autorizaciónPrácticas recomendadasLimitacionesRecursos adicionales

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Operación de exportación de datos FHIR R4 $davinci-data-para HealthLake

La $davinci-data-export operación es una operación FHIR asíncrona desde la que puede exportar datos de atención médica. AWS HealthLake Esta operación admite varios tipos de exportación, incluidas las API de atribución de miembros (ATR), PDeX Provider Access y Member Access. Payer-to-Payer Es una versión especializada de la $export operación estándar del FHIR, diseñada para cumplir con los requisitos de las DaVinci guías de implementación.

Características principales de

  • Procesamiento asíncrono: sigue el patrón estándar de solicitudes asíncronas del FHIR

  • Group-Level Exportación: exporta los datos de los miembros de un recurso de grupo específico

  • Múltiples tipos de exportación: admite las API ATR (atribución de miembros), PDeX Provider Access y Member Access Payer-to-Payer

  • Soporte integral de perfiles: incluye perfiles US Core, CARIN Blue Button y PDeX

  • Filtrado flexible: admite el filtrado por pacientes, tipos de recursos y rangos de tiempo

  • Salida NDJSON: proporciona datos en formato JSON delimitado por líneas nuevas

Punto final de la operación

GET [base]/Group/[id]/$davinci-data-export
POST [base]/Group/[id]/$davinci-data-export

Parámetros de la solicitud

Parámetro Cardinalidad Description (Descripción)
patient 0.. * Miembros específicos cuyos datos se van a exportar. Si se omite, se exportan todos los miembros del grupo.
_type 0.1. Comma-delimited lista de tipos de recursos del FHIR para exportar. Si se omite, se incluyen todos los tipos de recursos compatibles con el tipo de exportación especificado. Para las exportaciones ATR, el valor predeterminado es de 8 tipos de recursos de atribución. En el caso de las exportaciones de PDeX, se incluyen todos los tipos de recursos de atribución, además de los tipos de recursos clínicos y de reclamaciones de los perfiles US Core, CARIN Blue Button y PDeX.
_since 0.1 Incluya únicamente los recursos actualizados después de esta fecha y hora.
_until 0.1.. Incluya únicamente los recursos actualizados antes de esta fecha y hora.
exportType 0.1.. El tipo de exportación que se va a realizar. Valores válidos: hl7.fhir.us.davinci-atr (ATR), hl7.fhir.us.davinci-pdex (Provider Access), hl7.fhir.us.davinci-pdex#provider-snapshot (instantánea de Provider Access), hl7.fhir.us.davinci-pdex.p2p (Payer-to-Payer), hl7.fhir.us.davinci-pdex.member (Member Access). Predeterminado: hl7.fhir.us.davinci-atr.
_includeEOB2xWoFinancial 0,1.. Si se establece entrue, incluye ExplanationOfBenefit los recursos que declaran un perfil financiero (no básico) CARIN BB 2.x en la exportación sin incluir los datos financieros. El recurso exportado se ajusta al perfil base correspondiente, pero el recurso original del banco de datos no se modifica. Este parámetro no afecta a los recursos que ya declaran un perfil básico, ya que siempre se incluyen y los datos financieros residuales se eliminan automáticamente. Predeterminado: false.
_security 0.. * Filtra los recursos exportados por valores meta.security de codificación. Utilice el system|code formato (el carácter de barra vertical debe ser URL-encoded como%7C). Cuando se proporcionan varios valores, los recursos deben coincidir con todos ellos (con la semántica AND). Úselo system| (barra vertical final, sin código) para hacer coincidir cualquier código de un sistema determinado.
_tag 0.. * Filtra los recursos exportados por valores meta.tag de codificación. Utiliza el mismo system|code formato y la misma semántica AND que_security. Cuando se _tag especifican ambos _security y, los recursos deben coincidir con ambos filtros.
Comportamiento del filtro para _security y _tag

Los _tag filtros _security y se aplican a todos los tipos de exportación, incluidos. hl7.fhir.us.davinci-atr Estos filtros también admiten los siguientes modificadores de búsqueda del FHIR::not,:missing, :text:above, y. :below Puede utilizar, por ejemplo _tag:not=archived o _security:missing=true. La operación excluye de la exportación los recursos que no coincidan con los filtros suministrados.

ExplanationOfBenefit datos financieros

Los siguientes campos de datos financieros se eliminan de todos los ExplanationOfBenefit recursos de CARIN BB 2.x exportados, independientemente de si el recurso declara un perfil básico o financiero: importes de adjudicación,payment, total benefitPeriodbenefitBalance, y partida y. net unitPrice Esto garantiza que los datos financieros no se exporten a Da Vinci Provider Access ni a las rutas. Payer-to-Payer ExplanationOfBenefitlos recursos que declaran solo un perfil de autorización previa de PDeX (sin un perfil CARIN BB 2.x) se exportan sin cambios y no se elimina ningún dato financiero. Si un recurso declara ambos perfiles, se eliminan los datos financieros.

Tipos de recursos admitidos

Los tipos de recursos admitidos dependen del tipo de exportación que especifique. Para las exportaciones ATR, se admiten los siguientes tipos de recursos:

  • Group

  • Patient

  • Coverage

  • RelatedPerson

  • Practitioner

  • PractitionerRole

  • Organization

  • Location

Para las exportaciones de PDeX (Provider Access y Member Access), se admiten todos los tipos de recursos clínicos y de reclamaciones, además de los tipos anteriores. Payer-to-Payer Para obtener una lista completa de los tipos de recursos compatibles, consulte la Guía de implementación básica de EE. UU. (STU 6.1), la Guía de implementación de CARIN Blue Button y la Guía de implementación del soporte de autorización previa de Da Vinci.

Tipos de exportación

La $davinci-data-export operación admite los siguientes tipos de exportación. El tipo de exportación se especifica mediante el exportType parámetro.

Tipo de exportación Finalidad Alcance de los datos Límite temporal
hl7.fhir.us.davinci-atr Lista de atribuciones de miembros Attribution-related recursos Ninguno
hl7.fhir.us.davinci-pdex API de acceso para proveedores Datos clínicos y de reclamaciones de los pacientes atribuidos Ninguno
hl7.fhir.us.davinci-pdex#provider-snapshot API de acceso para proveedores (instantánea) Todos los datos clínicos, de autorización previa y no financieros sobre reclamaciones y encuentros de pacientes atribuidos Ninguno
hl7.fhir.us.davinci-pdex.p2p Payer-to-Payer Intercambio Datos históricos de los miembros para las transiciones de seguros 5 años
hl7.fhir.us.davinci-pdex.member API de acceso para miembros Datos de salud propios del miembro 5 años
Límites temporales por tipo de exportación

El límite temporal de 5 años se aplica únicamente a los tipos de exportación Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) y Member Access (hl7.fhir.us.davinci-pdex.member). Los tipos de exportación de Provider Access (hl7.fhir.us.davinci-pdexyhl7.fhir.us.davinci-pdex#provider-snapshot) no tienen ninguna restricción temporal. En el caso de los tipos de exportación limitados temporalmente, el límite de 5 años no se aplica a los tipos de recursos ATR (GroupPatient,Coverage,RelatedPerson,, Practitioner PractitionerRoleOrganization,Location). Estos recursos siempre se incluyen independientemente de la edad.

Base de filtrado temporal

Los límites temporales y los _until parámetros _since y se evalúan en función de la meta.lastUpdated marca temporal de cada recurso, en lugar de las fechas clínicas o de servicio. Esto proporciona un filtrado temporal uniforme en todos los tipos de recursos.

ATR (hl7.fhir.us.davinci-atr)

Con el tipo de exportación ATR, puedes exportar los datos de la lista de atribución de miembros. Usa este tipo de exportación para recuperar recursos relacionados con la atribución para los miembros de un grupo. Para obtener más información, consulte la operación de exportación de ATR de Da Vinci.

Tipos de recursos admitidos

Group, Patient, Coverage, RelatedPerson, Practitioner, PractitionerRole, Organization, Location

Filtrado temporal

No se aplica ningún filtrado temporal. Todos los recursos coincidentes se exportan independientemente de la fecha.

Tipos de exportación de PDex

Todos los tipos de exportación de PDex comparten los mismos perfiles compatibles y la misma lógica de filtrado. Para obtener más información, consulte la API Da Vinci PDex Provider Access. Se admiten los siguientes perfiles:

  • US Core 3.1.1, 6.1.0 y 7.0.0

  • Autorización previa de PDeX (no se admite para el acceso de los miembros)

  • Perfiles básicos de CARIN BB 2.x: pacientes hospitalizados, pacientes ambulatorios institucionales, profesionales, orales, farmacéuticos NonClinician

En el caso de las exportaciones de PDeX, se descubren automáticamente los recursos clínicos y de reclamaciones de cada paciente del Grupo. No es necesario que haga referencia explícita a estos recursos en el recurso del Grupo. La operación busca todos los recursos del compartimento de pacientes (comoObservation,, Condition Coverage RelatedPersonMedicationRequest, yExplanationOfBenefit) que pertenecen a los pacientes atribuidos. Únicamente PatientGroup, y los tipos de ATR no compartimentados para pacientes (Practitioner,, PractitionerRoleOrganization,Location) requieren referencias explícitas en el Grupo.

Acceso al proveedor () hl7.fhir.us.davinci-pdex

Permite a los proveedores de la red recuperar los datos de los pacientes atribuidos.

Acceso al proveedor: instantánea () hl7.fhir.us.davinci-pdex#provider-snapshot

Devuelve una instantánea completa de todos los datos clínicos, de autorización previa y no financieros y de consultas de los pacientes atribuidos. Este tipo de exportación tiene el mismo comportamiento hl7.fhir.us.davinci-pdex y no está sujeto a ningún límite temporal.

Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p)

Permite el intercambio de datos entre los pagadores cuando un paciente cambia de seguro.

Acceso de miembros () hl7.fhir.us.davinci-pdex.member

Permite a los miembros acceder a sus propios datos de salud.

Lógica de inclusión y soporte de perfiles

En el caso de las exportaciones de PDex, la $davinci-data-export operación utiliza declaraciones de perfil en el meta.profile elemento para determinar qué recursos incluir en la exportación.

ExplanationOfBenefit Manejo de recursos

ExplanationOfBenefitLos recursos (EOB) se incluyen o excluyen de las exportaciones de PDeX en función de sus meta.profile declaraciones:

  • ExplanationOfBenefit los recursos con un perfil CARIN BB 1.x se excluyen de la exportación.

  • ExplanationOfBenefit los recursos sin ningún meta.profile conjunto se excluyen de la exportación.

  • ExplanationOfBenefit Los recursos con un perfil básico CARIN BB 2.x siempre se incluyen y se eliminan los datos financieros residuales para que el recurso se ajuste al perfil básico CARIN BB 2.x. Non-Financial

  • ExplanationOfBenefit los recursos con un perfil CARIN BB 2.x que contiene datos financieros se excluyen de forma predeterminada. Cuando _includeEOB2xWoFinancial=true están configurados, se incluyen sin datos financieros y el recurso se transforma en el perfil base correspondiente.

  • ExplanationOfBenefit los recursos con un perfil de autorización previa de PDeX siempre se incluyen.

Prioridad del perfil para la eliminación de datos financieros

Cuando un ExplanationOfBenefit recurso declara varios perfiles, la eliminación de datos financieros tiene prioridad sobre la transferencia. En el caso de un recurso que declara un perfil básico (o financiero) y un perfil de autorización previa de PDeX, la operación elimina los datos financieros antes de exportar el recurso.

Transformación de datos financieros

Cuando se configura_includeEOB2xWoFinancial=true, la operación transforma los ExplanationOfBenefit recursos de CARIN BB 2.x en sus perfiles básicos correspondientes mediante la eliminación de los datos financieros. Por ejemplo, un C4BB ExplanationOfBenefit Oral recurso se transforma enC4BB ExplanationOfBenefit Oral Basis, lo que elimina los datos financieros del registro según la especificación de la FHIR.

La operación elimina los siguientes elementos de datos financieros en dos escenarios: cuando transforma un recurso financiero CARIN BB 2.x en su perfil base (mediante_includeEOB2xWoFinancial=true) y cuando elimina los datos financieros residuales de un recurso base CARIN BB 2.x:

  • totalEl elemento

  • El payment elemento

  • El benefitPeriod elemento

  • El benefitBalance elemento

  • Las anotaciones del adjudication importe (la amount parte; las entradas no financieras, como benefitpaymentstatus y billingnetworkstatus se conservan)

  • El elemento item.net

  • El item.unitPrice elemento

  • Las entradas item.adjudication de importe

La operación también actualiza los metadatos del perfil durante la transformación:

  • meta.profilese actualiza a la URL canónica del perfil básico

  • La versión se ha actualizado a la versión básica CARIN BB 2.x

  • Los recursos existentes en el almacén de datos no se modifican

  • Los recursos exportados no se devuelven al almacén de datos

Reglas de detección de perfiles

La operación utiliza las siguientes reglas para detectar y validar los perfiles:

  • La detección de versiones se basa en las meta.profile URL canónicas

  • Se incluye un recurso si alguno de sus perfiles declarados coincide con los criterios de exportación

  • La validación del perfil se produce durante el procesamiento de la exportación

Filtrado temporal para las exportaciones de PDeX

HealthLake aplica un filtro temporal de 5 años para los tipos de exportación Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) y Member Access (hl7.fhir.us.davinci-pdex.member). El filtro se basa en la fecha en que se actualizó el recurso por última vez. Los tipos de exportación de Provider Access (hl7.fhir.us.davinci-pdexyhl7.fhir.us.davinci-pdex#provider-snapshot) no están sujetos a ningún límite temporal. Para los tipos de exportación limitados temporalmente, el filtro se aplica a todos los recursos, excepto a los siguientes tipos de recursos de atribución principales, que siempre se exportan independientemente de su antigüedad:

  • Patient

  • Coverage

  • Organization

  • Practitioner

  • PractitionerRole

  • RelatedPerson

  • Location

  • Group

Estos recursos administrativos y demográficos están exentos porque proporcionan un contexto esencial para los datos exportados. Las exportaciones de ATR no están sujetas a ningún filtrado temporal.

Solicitudes de ejemplo

Los siguientes ejemplos muestran cómo iniciar trabajos de exportación para diferentes tipos de exportación.

Exportación ATR

GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Group,Patient,Coverage,Practitioner,Organization&exportType=hl7.fhir.us.davinci-atr

POST https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Group,Patient,Coverage,Practitioner,Organization&exportType=hl7.fhir.us.davinci-atr
Content-Type: application/json

{
  "DataAccessRoleArn": "arn:aws:iam::444455556666:role/your-healthlake-service-role",
  "JobName": "attribution-export-job",
  "OutputDataConfig": {
    "S3Configuration": {
      "S3Uri": "s3://your-export-bucket/EXPORT-JOB",
      "KmsKeyId": "arn:aws:kms:region:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    }
  }
}

Exportación de Provider Access con eliminación de datos ExplanationOfBenefit financieros

GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Observation,Condition,MedicationRequest,ExplanationOfBenefit&exportType=hl7.fhir.us.davinci-pdex&_includeEOB2xWoFinancial=true

Exportación de instantáneas de Provider Access

GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?exportType=hl7.fhir.us.davinci-pdex%23provider-snapshot

Payer-to-Payer exportar

GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Coverage,ExplanationOfBenefit,Condition,Procedure&exportType=hl7.fhir.us.davinci-pdex.p2p&_includeEOB2xWoFinancial=true

Exportación de Member Access para un paciente específico

GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Observation,Condition,ExplanationOfBenefit,MedicationRequest&exportType=hl7.fhir.us.davinci-pdex.member&patient=Patient/example-patient-id

Respuesta de ejemplo

{
  "datastoreId": "eaee622d8406b41eb86c0f4741201ff9",
  "jobStatus": "SUBMITTED",
  "jobId": "48d7b91dae4a64d00d54b70862f33f61"
}

Relaciones de recursos

La operación exporta los recursos en función de sus relaciones dentro de la lista de atribuciones de miembros:

Group (Attribution List)
├── Patient (Members)
├── Coverage → RelatedPerson (Subscribers)
├── Practitioner (Attributed Providers)
├── PractitionerRole → Location
└── Organization (Attributed Providers)
nota

El diagrama de relaciones de recursos anterior se aplica a las exportaciones de ATR. En el caso de las exportaciones de PDeX, los recursos clínicos y de reclamaciones se descubren automáticamente mediante la búsqueda de pacientes y no es necesario incluir referencias explícitas en el recurso del Grupo.

Fuentes de recursos

Recurso Ubicación de origen Description (Descripción)
Patient Group.member.entity Los pacientes que son miembros de la lista de atribuciones
Coverage Group.member.extension:coverageReference Cobertura que dio lugar a la afiliación de los pacientes
Organization Group.member.extension:attributedProvider Organizaciones a las que se atribuyen los pacientes
Practitioner Group.member.extension:attributedProvider Profesionales individuales a los que se atribuyen los pacientes
PractitionerRole Group.member.extension:attributedProvider Funciones de los profesionales a las que se atribuyen los pacientes
RelatedPerson Coverage.subscriber Suscriptores de la cobertura
Location PractitionerRole.location Ubicaciones asociadas a las funciones de los profesionales
Group Punto final de entrada La propia lista de atribuciones

Gestión de trabajos

Comprobar el estado del trabajo

GET [base]/export/[job-id]

Cancelar trabajo

DELETE [base]/export/[job-id]

Ciclo de vida del trabajo

  • SUBMITTED- Se ha recibido el trabajo y se ha puesto en cola

  • IN_PROGRESS- Job se está procesando activamente

  • COMPLETED- Job finalizado correctamente, archivos disponibles para descargar

  • FAILED- El trabajo encontró un error

Output Format (Formato de salida)

  • Formato de archivo: NDJSON (JSON delimitado por nueva línea)

  • Organización de archivos: archivos separados para cada tipo de recurso

  • Extensión de archivo: .ndjson

  • Ubicación: depósito y ruta de S3 especificados

Gestión de errores

La operación devuelve una solicitud incorrecta de HTTP 400 con un valor OperationOutcome para las siguientes condiciones:

Errores de autorización

La función de IAM especificada en DataAccessRoleArn no tiene permisos suficientes para realizar la operación de exportación. Para ver la lista completa de los permisos de S3 y KMS necesarios, consulte Configurar los permisos para los trabajos de exportación.

Errores de validación de parámetros

  • El patient parámetro no tiene el formato Patient/id,Patient/id,...

  • Una o más referencias de pacientes no son válidas o no pertenecen al grupo especificado

  • El valor del exportType parámetro no es un tipo de exportación compatible

  • El _type parámetro contiene tipos de recursos que no son compatibles con el tipo de exportación especificado

  • En el _type parámetro faltan los tipos de recursos necesarios (Group,Patient,Coverage) para el tipo de hl7.fhir.us.davinci-atr exportación

  • El valor del _includeEOB2xWoFinancial parámetro no es un booleano válido

Errores de validación de recursos

  • El recurso de grupo especificado no existe en el banco de datos

  • El recurso de grupo especificado no tiene miembros

  • Uno o más miembros del grupo hacen referencia a recursos para pacientes que no existen en el almacén de datos

Seguridad y autorización

$davinci-data-exportes una operación masiva de back-end autorizada mediante permisos de IAM o SMART a nivel del sistema en el ámbito del FHIR (OAuth 2.0); se rechazan las solicitudes que presenten ámbitos a nivel de paciente o usuario. La operación no evalúa los recursos de consentimiento del FHIR para filtrar o restringir los datos exportados.

  • Se aplican los mecanismos de autorización estándar del FHIR

  • La función de acceso a los datos debe tener los permisos de IAM necesarios para las operaciones de S3 y KMS. Para ver la lista completa de los permisos necesarios, consulte Configurar los permisos para los trabajos de exportación.

Prácticas recomendadas

  • Selección del tipo de recurso: solicite únicamente los tipos de recursos que necesite para minimizar el tamaño de la exportación y el tiempo de procesamiento

  • Time-Based Filtrado: utilice el _since parámetro para exportaciones incrementales

  • Filtrado de pacientes: utilice el patient parámetro cuando solo necesite datos de miembros específicos

  • Supervisión del trabajo: compruebe periódicamente el estado del trabajo para grandes exportaciones

  • Gestión de errores: Implemente la lógica de reintento adecuada para los trabajos fallidos

  • Conocimiento del filtro temporal: para las exportaciones Payer-to-Payer y las de acceso de los miembros, tenga en cuenta el filtro temporal de 5 años al seleccionar los tipos de recursos

  • Eliminación de datos financieros: úselo _includeEOB2xWoFinancial=true cuando necesite datos de reclamaciones sin información financiera

  • Gestión de perfiles: asegúrese de que los recursos cuenten con las declaraciones de perfil adecuadas, compárelos con los perfiles de destino antes de su ingestión y utilice el control de versiones de los perfiles para controlar el comportamiento de exportación

Limitaciones

  • Se puede especificar un máximo de 500 pacientes en el parámetro patient

  • La exportación se limita únicamente a Group-level las operaciones

  • Solo admite el conjunto predefinido de tipos de recursos para cada tipo de exportación

  • La salida siempre está en formato NDJSON

  • Payer-to-Payer y las exportaciones de Member Access están limitadas a 5 años de datos clínicos y de reclamaciones

  • La transformación de los datos financieros solo se aplica a los perfiles CARIN BB 2.x ExplanationOfBenefit

Recursos adicionales