View a markdown version of this page

Opération FHIR R4 $davinci-data-export pour HealthLake - AWS HealthLake

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Opération FHIR R4 $davinci-data-export pour HealthLake

Il s'agit d'une $davinci-data-export opération FHIR asynchrone à partir de laquelle vous pouvez exporter des données de santé. AWS HealthLake Cette opération prend en charge plusieurs types d'exportation, notamment l'attribution de membres (ATR), l'accès aux fournisseurs PDEx et Payer-to-Payer les API d'accès aux membres. Il s'agit d'une version spécialisée de l'$exportopération FHIR standard, conçue pour répondre aux exigences des guides de mise DaVinci en œuvre.

Fonctionnalités principales

  • Traitement asynchrone : suit le modèle de demande asynchrone FHIR standard

  • Group-Level Exporter : exporte les données pour les membres d'une ressource de groupe spécifique

  • Plusieurs types d'exportation : prend en charge l'ATR (attribution de membres), l'accès aux fournisseurs PDEx et Payer-to-Payer les API d'accès aux membres

  • Support complet pour les profils : inclut les profils US Core, CARIN Blue Button et PDex

  • Filtrage flexible : prend en charge le filtrage par patients, types de ressources et plages de temps

  • Sortie NDJSON : fournit des données au format JSON délimité par de nouvelles lignes

Opération Endpoint

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

Paramètres de demande

Paramètre Cardinalité Description
patient 0.. * Membres spécifiques dont les données doivent être exportées. En cas d'omission, tous les membres du groupe sont exportés.
_type 0,1 Comma-delimited liste des types de ressources FHIR à exporter. En cas d'omission, tous les types de ressources pris en charge pour le type d'exportation spécifié sont inclus. Pour les exportations ATR, les 8 types de ressources d'attribution sont utilisés par défaut. Pour les exportations PDex, cela inclut tous les types de ressources d'attribution, ainsi que les types de ressources cliniques et de réclamations issus des profils US Core, CARIN Blue Button et PDex.
_since 0,1 N'incluez que les ressources mises à jour après cette date et cette heure.
_until 0,1 N'incluez que les ressources mises à jour avant cette date et cette heure.
exportType 0,1 Type d'exportation à effectuer. Valeurs valides : hl7.fhir.us.davinci-atr (ATR), hl7.fhir.us.davinci-pdex (Accès fournisseur), hl7.fhir.us.davinci-pdex#provider-snapshot (instantané d'accès fournisseur), hl7.fhir.us.davinci-pdex.p2p (Payer-to-Payer), hl7.fhir.us.davinci-pdex.member (Accès membre). Valeur par défaut : hl7.fhir.us.davinci-atr.
_includeEOB2xWoFinancial 0,1 Lorsqu'il est défini surtrue, inclut ExplanationOfBenefit les ressources qui déclarent un profil CARIN BB 2.x Financial (non Basis) lors de l'exportation avec les données financières supprimées. La ressource exportée est conforme au profil de base correspondant, mais la ressource d'origine dans le magasin de données n'est pas modifiée. Ce paramètre n'a aucun effet sur les ressources qui déclarent déjà un profil Basis, car celles-ci sont toujours incluses et les données financières résiduelles sont automatiquement supprimées. Valeur par défaut : false.
_security 0.. * Filtrez les ressources exportées par valeurs de meta.security codage. Utilisez le system|code format (le caractère du tube doit être «  URL-encoded  as »%7C). Lorsque plusieurs valeurs sont fournies, les ressources doivent correspondre à toutes (sémantique ET). Utilisez system| (tube final, aucun code) pour faire correspondre n'importe quel code d'un système donné.
_tag 0.. * Filtrez les ressources exportées par valeurs de meta.tag codage. Utilise le même system|code format et la même sémantique AND que. _security Lorsque _security les deux filtres _tag sont spécifiés, les ressources doivent correspondre aux deux filtres.
Comportement du filtre pour _security et _tag

Les _tag filtres _security et s'appliquent à tous les types d'exportation, y comprishl7.fhir.us.davinci-atr. Ces filtres prennent également en charge les modificateurs de recherche FHIR suivants ::not,:missing, :text:above, et. :below Par exemple, vous pouvez utiliser _tag:not=archived ou_security:missing=true. L'opération exclut de l'exportation les ressources qui ne correspondent pas aux filtres fournis.

ExplanationOfBenefit données financières

Les champs de données financières suivants sont supprimés de toutes les ExplanationOfBenefit ressources CARIN BB 2.x exportées, que la ressource déclare une base ou un profil financier : montants des adjudications,,,,payment, total benefitPeriodbenefitBalance, et article et. net unitPrice Cela garantit que les données financières ne sont pas exportées sur Da Vinci Provider Access et Payer-to-Payer les chemins. ExplanationOfBenefitles ressources qui déclarent uniquement un profil d'autorisation préalable PDex (sans profil CARIN BB 2.x) sont exportées telles quelles et aucune donnée financière n'est supprimée. Si une ressource déclare les deux profils, les données financières sont supprimées.

Types de ressource pris en charge

Les types de ressources pris en charge dépendent du type d'exportation que vous spécifiez. Pour les exportations ATR, les types de ressources suivants sont pris en charge :

  • Group

  • Patient

  • Coverage

  • RelatedPerson

  • Practitioner

  • PractitionerRole

  • Organization

  • Location

Pour les exportations PDex (accès fournisseur et accès membre), tous les types de ressources cliniques et de réclamations sont pris en charge en plus des types précédents. Payer-to-Payer Pour une liste complète des types de ressources pris en charge, consultez le US Core Implementation Guide (STU 6.1), le CARIN Blue Button Implementation Guide et le Da Vinci Prior Authorization Support Implementation Guide.

Types d'exportation

L'$davinci-data-exportopération prend en charge les types d'exportation suivants. Vous spécifiez le type d'exportation à l'aide du exportType paramètre.

Type d'exportation Objectif Étendue des données Limite temporelle
hl7.fhir.us.davinci-atr Liste d'attribution des membres Attribution-related ressources Aucune
hl7.fhir.us.davinci-pdex API d'accès aux fournisseurs Données cliniques et relatives aux demandes de remboursement pour les patients concernés Aucune
hl7.fhir.us.davinci-pdex#provider-snapshot API d'accès aux fournisseurs (instantané) Toutes les données cliniques, d'autorisation préalable et non financières sur les demandes et les consultations pour les patients attribués Aucune
hl7.fhir.us.davinci-pdex.p2p Payer-to-Payer Échange Données historiques sur les membres pour les transitions d'assurance 5 ans
hl7.fhir.us.davinci-pdex.member API d'accès aux membres Données de santé propres au membre 5 ans
Limites temporelles par type d'exportation

La limite temporelle de 5 ans s'applique uniquement aux types d'exportation Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) et Member Access (hl7.fhir.us.davinci-pdex.member). Les types d'exportation Provider Access (hl7.fhir.us.davinci-pdexethl7.fhir.us.davinci-pdex#provider-snapshot) ne sont soumis à aucune restriction temporelle. Pour les types d'exportation limités dans le temps, la limite de 5 ans ne s'applique pas aux types de ressources ATR (Group,Patient,Coverage,RelatedPerson,, Practitioner PractitionerRoleOrganization,Location). Ces ressources sont toujours incluses quel que soit l'âge.

Base de filtrage temporel

Les limites temporelles et les _until paramètres _since et sont évalués par rapport à l'meta.lastUpdatedhorodatage de chaque ressource plutôt qu'aux dates cliniques ou de service. Cela permet un filtrage temporel cohérent pour tous les types de ressources.

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

Avec le type d'exportation ATR, vous pouvez exporter les données de la liste d'attribution des membres. Utilisez ce type d'exportation pour récupérer les ressources liées à l'attribution pour les membres d'un groupe. Pour plus d'informations, consultez l'opération d'exportation de Da Vinci ATR.

Types de ressource pris en charge

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

Filtrage temporel

Aucun filtrage temporel n'est appliqué. Toutes les ressources correspondantes sont exportées quelle que soit la date.

Types d'exportation PDex

Tous les types d'exportation PDex partagent les mêmes profils pris en charge et la même logique de filtrage. Pour plus d'informations, consultez l'API Da Vinci PDex Provider Access. Les profils suivants sont pris en charge :

  • US Core 3.1.1, 6.1.0 et 7.0.0

  • Autorisation préalable PDex (non prise en charge pour l'accès des membres)

  • CARIN BB 2.x Profils de base : établissement hospitalier, établissement ambulatoire, professionnel, oral, pharmacie NonClinician

Pour les exportations PDex, les ressources cliniques et de gestion des sinistres sont automatiquement découvertes pour chaque patient du groupe. Il n'est pas nécessaire de faire explicitement référence à ces ressources dans la ressource Groupe. L'opération recherche toutes les ressources du compartiment patient (telles que ObservationCondition,Coverage,RelatedPerson,MedicationRequest, etExplanationOfBenefit) appartenant aux patients attribués. Seuls Patient les types d'ATR (GroupPractitioner,,,Location) et ceux qui ne concernent pas le compartiment du patient nécessitent des références explicites dans le groupe. PractitionerRole Organization

Accès au fournisseur (hl7.fhir.us.davinci-pdex)

Permet aux fournisseurs du réseau de récupérer les données des patients pour les patients auxquels ils ont été attribués.

Accès au fournisseur — snapshot (hl7.fhir.us.davinci-pdex#provider-snapshot)

Renvoie un aperçu complet de toutes les données cliniques, d'autorisation préalable et non financières et de consultations relatives aux patients concernés. Ce type d'exportation se comporte de la même manière hl7.fhir.us.davinci-pdex et n'est pas soumis à une limite temporelle.

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

Permet l'échange de données entre les payeurs lorsqu'un patient change d'assurance.

Accès aux membres (hl7.fhir.us.davinci-pdex.member)

Permet aux membres d'accéder à leurs propres données de santé.

Support du profil et logique d'inclusion

Pour les exportations PDex, l'$davinci-data-exportopération utilise des déclarations de profil dans l'meta.profileélément pour déterminer les ressources à inclure dans l'exportation.

ExplanationOfBenefit Gestion des ressources

ExplanationOfBenefitLes ressources (EOB) sont incluses ou exclues des exportations PDex en fonction de leurs meta.profile déclarations :

  • ExplanationOfBenefit les ressources dotées d'un profil CARIN BB 1.x sont exclues de l'exportation.

  • ExplanationOfBenefit les ressources non meta.profile définies sont exclues de l'exportation.

  • ExplanationOfBenefit les ressources avec un profil CARIN BB 2.x Basis sont toujours incluses, toutes les données financières résiduelles étant supprimées afin que la ressource soit conforme au profil CARIN BB 2.x Basis. Non-Financial

  • ExplanationOfBenefit les ressources avec un profil CARIN BB 2.x contenant des données financières sont exclues par défaut. Lorsqu'il _includeEOB2xWoFinancial=true est défini, ils sont inclus dans les données financières supprimées et la ressource est transformée selon le profil de base correspondant.

  • ExplanationOfBenefit les ressources avec un profil d'autorisation préalable PDex sont toujours incluses.

Priorité du profil pour le dépouillement des données financières

Lorsqu'une ExplanationOfBenefit ressource déclare plusieurs profils, le découpage des données financières a priorité sur le transfert. Pour une ressource qui déclare à la fois un profil de base (ou financier) et un profil d'autorisation préalable PDex, l'opération supprime les données financières avant d'exporter la ressource.

Transformation des données financières

Lorsque vous le définissez_includeEOB2xWoFinancial=true, l'opération transforme les ExplanationOfBenefit ressources CARIN BB 2.x en leurs profils de base correspondants en supprimant les données financières. Par exemple, une C4BB ExplanationOfBenefit Oral ressource est transformée enC4BB ExplanationOfBenefit Oral Basis, ce qui supprime les données financières de l'enregistrement conformément à la spécification FHIR.

L'opération supprime les éléments de données financières suivants dans deux scénarios : lorsqu'elle transforme une ressource financière CARIN BB 2.x en son profil de base (en utilisant_includeEOB2xWoFinancial=true), et lorsqu'elle supprime les données financières résiduelles d'une ressource CARIN BB 2.x Basis :

  • L'totalélément

  • L'paymentélément

  • L'benefitPeriodélément

  • L'benefitBalanceélément

  • Le adjudication montant inscrit (la amount tranche ; les entrées non financières telles que benefitpaymentstatus et billingnetworkstatus sont conservées)

  • L'item.netélément

  • L'item.unitPriceélément

  • Le item.adjudication montant saisi

L'opération met également à jour les métadonnées du profil lors de la transformation :

  • meta.profileest mis à jour vers l'URL canonique du profil Basis

  • La version est mise à jour vers la version CARIN BB 2.x Basis

  • Les ressources existantes dans le magasin de données ne sont pas modifiées

  • Les ressources exportées ne sont pas renvoyées dans le magasin de données

Règles de détection des profils

L'opération utilise les règles suivantes pour détecter et valider les profils :

  • La détection des versions est basée sur les meta.profile URL canoniques

  • Une ressource est incluse si l'un de ses profils déclarés correspond aux critères d'exportation

  • La validation du profil a lieu pendant le traitement de l'exportation

Filtrage temporel pour les exportations PDex

HealthLake applique un filtre temporel de 5 ans pour les types d'exportation Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) et Member Access (hl7.fhir.us.davinci-pdex.member). Le filtre est basé sur la date de dernière mise à jour de la ressource. Les types d'exportation (hl7.fhir.us.davinci-pdexethl7.fhir.us.davinci-pdex#provider-snapshot) de Provider Access ne sont soumis à aucune limite temporelle. Pour les types d'exportation limités dans le temps, le filtre s'applique à toutes les ressources, à l'exception des types de ressources d'attribution de base suivants, qui sont toujours exportés quel que soit leur âge :

  • Patient

  • Coverage

  • Organization

  • Practitioner

  • PractitionerRole

  • RelatedPerson

  • Location

  • Group

Ces ressources administratives et démographiques sont exemptées car elles fournissent un contexte essentiel pour les données exportées. Les exportations ATR ne sont soumises à aucun filtrage temporel.

Exemple de demandes

Les exemples suivants montrent comment démarrer des tâches d'exportation pour différents types d'exportation.

Exportation 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" } } }

Exportation de l'accès au fournisseur avec suppression des données ExplanationOfBenefit financières

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

Exportation d'instantanés avec 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 exportation

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

Exportation de l'accès aux membres pour un patient spécifique

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

Exemple de réponse

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

Relations avec les ressources

L'opération exporte les ressources en fonction de leurs relations au sein de la liste d'attribution des membres :

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

Le diagramme des relations entre les ressources précédent s'applique aux exportations ATR. Pour les exportations PDex, les ressources cliniques et relatives aux réclamations sont automatiquement découvertes grâce à la recherche de patients et ne nécessitent pas de références explicites dans la ressource du groupe.

Sources de ressources

Ressource Emplacement de la source Description
Patient Group.member.entity Les patients membres de la liste d'attribution
Coverage Group.member.extension:coverageReference Couverture qui a donné lieu à l'adhésion du patient
Organization Group.member.extension:attributedProvider Organisations auxquelles les patients sont attribués
Practitioner Group.member.extension:attributedProvider Praticiens individuels auxquels les patients sont attribués
PractitionerRole Group.member.extension:attributedProvider Rôles de praticiens auxquels les patients sont attribués
RelatedPerson Coverage.subscriber Abonnés de la couverture
Location PractitionerRole.location Lieux associés aux rôles des praticiens
Group Point d'entrée La liste d'attribution elle-même

Gestion des emplois

Vérifier le statut du job

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

Annuler une tâche

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

Cycle de vie d'une tâche

  • SUBMITTED- Le job a été reçu et mis en file d'attente

  • IN_PROGRESS- Job en cours de traitement actif

  • COMPLETED- Job terminé avec succès, fichiers disponibles au téléchargement

  • FAILED- Job a rencontré une erreur

Format de sortie

  • Format de fichier : NDJSON (JSON délimité par une nouvelle ligne)

  • Organisation des fichiers : fichiers distincts pour chaque type de ressource

  • Extension de fichier : .ndjson

  • Emplacement : compartiment et chemin S3 spécifiés

Gestion des erreurs

L'opération renvoie une mauvaise demande HTTP 400 avec un OperationOutcome pour les conditions suivantes :

Erreurs d'autorisation

Le rôle IAM spécifié dans DataAccessRoleArn ne dispose pas des autorisations suffisantes pour effectuer l'opération d'exportation. Pour obtenir la liste complète des autorisations S3 et KMS requises, voir Configuration des autorisations pour les tâches d'exportation.

Erreurs de validation des paramètres
  • Le patient paramètre n'est pas formaté comme Patient/id,Patient/id,...

  • Une ou plusieurs références de patients ne sont pas valides ou n'appartiennent pas au groupe spécifié

  • La valeur du exportType paramètre n'est pas un type d'exportation pris en charge

  • Le _type paramètre contient les types de ressources qui ne sont pas pris en charge pour le type d'exportation spécifié.

  • Le _type paramètre ne contient pas les types de ressources requis (Group,Patient,Coverage) pour le type hl7.fhir.us.davinci-atr d'exportation

  • La valeur du _includeEOB2xWoFinancial paramètre n'est pas un booléen valide

Erreurs de validation des ressources
  • La ressource de groupe spécifiée n'existe pas dans le magasin de données

  • La ressource de groupe spécifiée n'a aucun membre

  • Un ou plusieurs membres du groupe font référence à des ressources pour patients qui n'existent pas dans le magasin de données

Sécurité et autorisation

$davinci-data-exportest une opération groupée du backend autorisée via des autorisations IAM ou des scopes SMART on FHIR (OAuth 2.0) au niveau du système ; les demandes présentant des scopes au niveau du patient ou de l'utilisateur sont rejetées. L'opération n'évalue pas les ressources de consentement FHIR pour filtrer ou restreindre les données exportées.

Bonnes pratiques

  • Sélection du type de ressource : demandez uniquement les types de ressources dont vous avez besoin pour minimiser la taille des exportations et le temps de traitement

  • Time-Based Filtrage : utilisez le _since paramètre pour les exportations incrémentielles

  • Filtrage des patients : utilisez le patient paramètre lorsque vous n'avez besoin de données que pour des membres spécifiques

  • Surveillance des tâches : vérifiez régulièrement l'état des tâches pour les exportations importantes

  • Gestion des erreurs : implémentez une logique de nouvelle tentative appropriée pour les tâches ayant échoué

  • Connaissance du filtre temporel : pour les exportations Payer-to-Payer et l'accès aux membres, considérez le filtre temporel quinquennal lorsque vous sélectionnez les types de ressources

  • Suppression des données financières : à utiliser _includeEOB2xWoFinancial=true lorsque vous avez besoin de données sur les réclamations sans informations financières

  • Gestion des profils : assurez-vous que les ressources disposent de déclarations de profil appropriées, validez par rapport aux profils cibles avant l'ingestion et utilisez le versionnement des profils pour contrôler le comportement d'exportation

Limitations

  • Un maximum de 500 patients peut être spécifié dans le patient paramètre

  • L'exportation est limitée aux Group-level opérations uniquement

  • Supporte uniquement l'ensemble prédéfini de types de ressources pour chaque type d'exportation

  • La sortie est toujours au format NDJSON

  • Payer-to-Payer et les exportations liées à l'accès aux membres sont limitées à 5 ans de données cliniques et de réclamations

  • La transformation des données financières ne s'applique qu'aux profils CARIN BB 2.x ExplanationOfBenefit

Ressources supplémentaires