As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Operação de exportação de dados FHIR R4 $davinci-data-export para HealthLake
A $davinci-data-export operação é uma operação FHIR assíncrona que você pode usar para exportar dados de saúde. AWS HealthLake Essa operação oferece suporte a vários tipos de exportação, incluindo APIs de Atribuição de Membros (ATR), PDex Provider Access e Member Access. Payer-to-Payer É uma versão especializada da $export operação padrão do FHIR, projetada para atender aos requisitos dos guias de DaVinci implementação.
Recursos principais
Processamento assíncrono: segue o padrão de solicitação assíncrona FHIR
Group-Level Exportar: exporta dados para membros dentro de um recurso específico do Grupo
Vários tipos de exportação: suporta APIs ATR (Atribuição de Membros), PDex Provider Access e Member Access Payer-to-Payer
Suporte abrangente de perfis: inclui perfis US Core, CARIN Blue Button e PDex
Filtragem flexível: suporta a filtragem por pacientes, tipos de recursos e intervalos de tempo
Saída NDJSON: fornece dados no formato JSON delimitado por nova linha
Ponto final da operação
GET [base]/Group/[id]/$davinci-data-export POST [base]/Group/[id]/$davinci-data-export
Parâmetros da solicitação
| Parâmetro | Cardinalidade | Description |
|---|---|---|
patient |
0.. * | Membros específicos cujos dados devem ser exportados. Quando omitidos, todos os membros do Grupo são exportados. |
_type |
0,1 | Comma-delimited lista de tipos de recursos FHIR a serem exportados. Quando omitidos, todos os tipos de recursos compatíveis com o tipo de exportação especificado são incluídos. Para exportações de ATR, o padrão é de 8 tipos de recursos de atribuição. Para exportações de PDex, isso inclui todos os tipos de recursos de atribuição, além dos tipos de recursos clínicos e de sinistros dos perfis US Core, CARIN Blue Button e PDex. |
_since |
0,1 | Inclua somente recursos atualizados após essa data e hora. |
_until |
0,1 | Inclua somente recursos atualizados antes dessa data e hora. |
exportType |
0,1 | O tipo de exportação a ser executada. Valores válidos: hl7.fhir.us.davinci-atr (ATR), hl7.fhir.us.davinci-pdex (Acesso do provedor), hl7.fhir.us.davinci-pdex#provider-snapshot (instantâneo do acesso do provedor), hl7.fhir.us.davinci-pdex.p2p (Payer-to-Payer), hl7.fhir.us.davinci-pdex.member (Acesso do membro). Padrão: hl7.fhir.us.davinci-atr. |
_includeEOB2xWoFinancial |
0,1 | Quando definido comotrue, inclui ExplanationOfBenefit recursos que declaram um perfil financeiro (não básico) do CARIN BB 2.x na exportação com dados financeiros removidos. O recurso exportado está em conformidade com o perfil Basis correspondente, mas o recurso original no armazenamento de dados não é modificado. Esse parâmetro não tem efeito nos recursos que já declaram um perfil Basis, pois eles estão sempre incluídos e têm dados financeiros residuais removidos automaticamente. Padrão: false. |
_security |
0.. * | Filtre os recursos exportados por valores de meta.security codificação. Use o system|code formato (o caractere de barra vertical deve ser URL-encoded como%7C). Quando vários valores são fornecidos, os recursos devem corresponder a todos eles (E à semântica). Use system| (tubo de arrasto, sem código) para combinar qualquer código de um determinado sistema. |
_tag |
0.. * | Filtre os recursos exportados por valores de meta.tag codificação. Usa o mesmo system|code formato e semântica AND de_security. Quando ambos _security _tag são especificados, os recursos devem corresponder aos dois filtros. |
Comportamento do filtro para _security e _tag
Os _tag filtros _security e se aplicam a todos os tipos de exportação, inclusivehl7.fhir.us.davinci-atr. Esses filtros também oferecem suporte aos seguintes modificadores de pesquisa FHIR::not,, :missing:text, e. :above :below Por exemplo, você poderá usar o _tag:not=archived ou o _security:missing=true. A operação exclui da exportação quaisquer recursos que não correspondam aos filtros fornecidos.
ExplanationOfBenefit dados financeiros
Os seguintes campos de dados financeiros são removidos de todos os ExplanationOfBenefit recursos exportados do CARIN BB 2.x, independentemente de o recurso declarar um perfil básico ou financeiro: valores de adjudicação,,,, paymenttotal, benefitPeriod e item e. benefitBalance net unitPrice Isso garante que os dados financeiros não sejam exportados nos caminhos e Payer-to-Payer no Da Vinci Provider Access. ExplanationOfBenefitrecursos que declaram somente um perfil de Autorização Prévia PDex (sem um perfil CARIN BB 2.x) são exportados inalterados e nenhum dado financeiro é removido. Se um recurso declarar os dois perfis, os dados financeiros serão removidos.
Tipos de recursos compatíveis
Os tipos de recursos suportados dependem do tipo de exportação que você especificar. Para exportações de ATR, os seguintes tipos de recursos são suportados:
GroupPatientCoverageRelatedPersonPractitionerPractitionerRoleOrganizationLocation
Para exportações de PDex (Provider Access e Member Access), todos os tipos de recursos clínicos e de sinistros são suportados, além dos tipos anteriores. Payer-to-Payer Para obter uma lista completa dos tipos de recursos suportados, consulte o US Core Implementation Guide (STU 6.1)
Tipos de exportação
A $davinci-data-export operação oferece suporte aos seguintes tipos de exportação. Você especifica o tipo de exportação usando o exportType parâmetro.
| Tipo de exportação | Finalidade | Escopo de dados | Limite temporal |
|---|---|---|---|
hl7.fhir.us.davinci-atr |
Lista de atribuição de membros | Attribution-related recursos | Nenhum |
hl7.fhir.us.davinci-pdex |
API de acesso do provedor | Dados clínicos e de reclamações de pacientes atribuídos | Nenhum |
hl7.fhir.us.davinci-pdex#provider-snapshot |
API de acesso do provedor (instantâneo) | Todas as solicitações clínicas, de autorização prévia e não financeiras e dados de encontros de pacientes atribuídos | Nenhum |
hl7.fhir.us.davinci-pdex.p2p |
Payer-to-Payer Troca | Dados históricos de associados para transições de seguros | 5 anos |
hl7.fhir.us.davinci-pdex.member |
API de acesso de membros | Dados de saúde do próprio membro | 5 anos |
Limites temporais por tipo de exportação
O limite temporal de 5 anos se aplica somente aos tipos de exportação Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) e Member Access (hl7.fhir.us.davinci-pdex.member). Os tipos de exportação do Provider Access (hl7.fhir.us.davinci-pdexehl7.fhir.us.davinci-pdex#provider-snapshot) não têm restrição temporal. Para os tipos de exportação que são limitados temporalmente, o limite de 5 anos não se aplica aos tipos de recursos ATR (Group,,,Patient,Coverage,RelatedPerson, PractitionerPractitionerRole,Organization). Location Esses recursos estão sempre incluídos, independentemente da idade.
Base de filtragem temporal
Os limites temporais e os _until parâmetros _since e são avaliados em relação à meta.lastUpdated data e hora de cada recurso, em vez de datas clínicas ou de serviço. Isso fornece uma filtragem temporal consistente em todos os tipos de recursos.
ATR (hl7.fhir.us.davinci-atr)
Com o tipo de exportação ATR, você pode exportar dados da Lista de Atribuição de Membros. Use esse tipo de exportação para recuperar recursos relacionados à atribuição para membros de um grupo. Para obter mais informações, consulte a Operação de exportação de ATR Da Vinci
- Tipos de recursos compatíveis
Group,Patient,Coverage,RelatedPerson,Practitioner,PractitionerRole,Organization,Location- Filtragem temporal
Nenhuma filtragem temporal é aplicada. Todos os recursos correspondentes são exportados independentemente da data.
Tipos de exportação PDex
Todos os tipos de exportação PDex compartilham os mesmos perfis suportados e a mesma lógica de filtragem. Para obter mais informações, consulte a API Da Vinci PDex Provider Access
US Core 3.1.1, 6.1.0 e 7.0.0
Autorização prévia PDex (não suportada para acesso de membros)
Perfis básicos do CARIN BB 2.x: Institucional de Internação, Institucional Ambulatorial, Profissional, Oral, Farmácia NonClinician
Para exportações de PDex, os recursos clínicos e de sinistros são descobertos automaticamente para cada paciente do Grupo. Você não precisa referenciar explicitamente esses recursos no recurso do Grupo. A operação busca todos os recursos do compartimento do paciente (comoObservation,,Condition, Coverage RelatedPersonMedicationRequest, eExplanationOfBenefit) que pertencem aos pacientes atribuídos. Somente Patient os tipos de ATR que não são do compartimento do paciente (Practitioner,, PractitionerRoleOrganization,Location) exigem referências explícitas no Grupo. Group
- Acesso do provedor (
hl7.fhir.us.davinci-pdex) Permite que os provedores da rede recuperem dados de pacientes atribuídos.
- Acesso do provedor — instantâneo ()
hl7.fhir.us.davinci-pdex#provider-snapshot Retorna um resumo completo de todas as solicitações clínicas, de autorização prévia e não financeiras e dados de encontros dos pacientes atribuídos. Esse tipo de exportação se comporta da mesma forma
hl7.fhir.us.davinci-pdexe não está sujeito a um limite temporal.- Payer-to-Payer (
hl7.fhir.us.davinci-pdex.p2p) Permite a troca de dados entre pagadores quando um paciente muda de seguro.
- Acesso de membro (
hl7.fhir.us.davinci-pdex.member) Permite que os membros acessem seus próprios dados de saúde.
Suporte de perfil e lógica de inclusão
Para exportações de PDex, a $davinci-data-export operação usa declarações de perfil no meta.profile elemento para determinar quais recursos incluir na exportação.
ExplanationOfBenefit Tratamento de recursos
ExplanationOfBenefitOs recursos (EOB) são incluídos ou excluídos das exportações do PDex com base em suas meta.profile declarações:
ExplanationOfBenefit recursos com um perfil CARIN BB 1.x são excluídos da exportação.
ExplanationOfBenefit recursos sem
meta.profileconjunto são excluídos da exportação.ExplanationOfBenefit recursos com um perfil CARIN BB 2.x Basis são sempre incluídos, com quaisquer dados financeiros residuais removidos para que o recurso esteja em conformidade com o perfil CARIN BB 2.x Basis. Non-Financial
ExplanationOfBenefit recursos com um perfil CARIN BB 2.x que contém dados financeiros são excluídos por padrão. Quando
_includeEOB2xWoFinancial=truedefinido, eles são incluídos com os dados financeiros retirados e o recurso é transformado no perfil Basis correspondente.ExplanationOfBenefit recursos com um perfil de autorização prévia PDex estão sempre incluídos.
Precedência de perfil para remoção de dados financeiros
Quando um ExplanationOfBenefit recurso declara vários perfis, a remoção de dados financeiros tem precedência sobre a passagem. Para um recurso que declara um perfil básico (ou financeiro) e um perfil de autorização prévia PDex, a operação remove os dados financeiros antes de exportar o recurso.
Transformação de dados financeiros
Quando você configura_includeEOB2xWoFinancial=true, a operação transforma os ExplanationOfBenefit recursos do CARIN BB 2.xC4BB ExplanationOfBenefit Oral recurso é transformado emC4BB ExplanationOfBenefit Oral Basis, o que retira os dados financeiros do registro de acordo com a especificação FHIR.
A operação remove os seguintes elementos de dados financeiros em dois cenários: quando transforma um recurso financeiro do CARIN BB 2.x em seu perfil Basis (usando_includeEOB2xWoFinancial=true) e quando remove dados financeiros residuais de um recurso do CARIN BB 2.x Basis:
O
totalelementoO
paymentelementoO
benefitPeriodelementoO
benefitBalanceelementoAs entradas
adjudicationde valor (aamountfatia; entradas não financeiras, comobenefitpaymentstatusebillingnetworkstatussão preservadas)O
item.netelementoO
item.unitPriceelementoAs entradas
item.adjudicationde valores
A operação também atualiza os metadados do perfil durante a transformação:
meta.profileé atualizado para o URL canônico do perfil básicoA versão é atualizada para a versão base do CARIN BB 2.x
Os recursos existentes no armazenamento de dados não são modificados
Os recursos exportados não são mantidos de volta ao armazenamento de dados
Regras de detecção de perfil
A operação usa as seguintes regras para detectar e validar perfis:
A detecção de versão é baseada nos
meta.profileURLs canônicosUm recurso é incluído se QUALQUER um de seus perfis declarados corresponder aos critérios de exportação
A validação do perfil ocorre durante o processamento da exportação
Filtragem temporal para exportações PDex
HealthLake aplica um filtro temporal de 5 anos para os tipos de exportação Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) e Member Access (hl7.fhir.us.davinci-pdex.member). O filtro é baseado em quando o recurso foi atualizado pela última vez. Os tipos de exportação (hl7.fhir.us.davinci-pdexehl7.fhir.us.davinci-pdex#provider-snapshot) do Provider Access não estão sujeitos a nenhum limite temporal. Para os tipos de exportação temporalmente limitados, o filtro se aplica a todos os recursos, exceto aos seguintes tipos principais de recursos de atribuição, que são sempre exportados independentemente da idade:
PatientCoverageOrganizationPractitionerPractitionerRoleRelatedPersonLocationGroup
Esses recursos administrativos e demográficos são isentos porque fornecem contexto essencial para os dados exportados. As exportações de ATR não estão sujeitas a nenhuma filtragem temporal.
Solicitações de amostra
Os exemplos a seguir mostram como iniciar trabalhos de exportação para diferentes tipos de exportação.
Exportação 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" } } }
Exportação do Provider Access com remoção de dados ExplanationOfBenefit financeiros
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
Exportação instantânea do 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
Exportação de acesso de membro para um 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
Resposta da amostra
{ "datastoreId": "eaee622d8406b41eb86c0f4741201ff9", "jobStatus": "SUBMITTED", "jobId": "48d7b91dae4a64d00d54b70862f33f61" }
Relações de recursos
A operação exporta recursos com base em seus relacionamentos na Lista de Atribuição de Membros:
Group (Attribution List) ├── Patient (Members) ├── Coverage → RelatedPerson (Subscribers) ├── Practitioner (Attributed Providers) ├── PractitionerRole → Location └── Organization (Attributed Providers)
nota
O diagrama de relacionamento de recursos anterior se aplica às exportações de ATR. Para exportações de PDex, os recursos clínicos e de reclamações são descobertos automaticamente por meio da pesquisa de pacientes e não exigem referências explícitas no recurso do Grupo.
Fontes de recursos
| Recurso | Localização da fonte | Description |
|---|---|---|
Patient |
Group.member.entity |
Os pacientes que são membros da lista de atribuição |
Coverage |
Group.member.extension:coverageReference |
Cobertura que resultou na adesão do paciente |
Organization |
Group.member.extension:attributedProvider |
Organizações às quais os pacientes são atribuídos |
Practitioner |
Group.member.extension:attributedProvider |
Profissionais individuais aos quais os pacientes são atribuídos |
PractitionerRole |
Group.member.extension:attributedProvider |
Funções profissionais às quais os pacientes são atribuídos |
RelatedPerson |
Coverage.subscriber |
Assinantes da cobertura |
Location |
PractitionerRole.location |
Locais associados às funções dos profissionais |
Group |
Ponto final de entrada | A lista de atribuições em si |
Gestão de Job
- Verifique o status do trabalho
GET [base]/export/[job-id]- Cancelar trabalho
DELETE [base]/export/[job-id]
Ciclo de vida da tarefa
SUBMITTED- Job foi recebido e colocado na filaIN_PROGRESS- O trabalho está sendo processado ativamenteCOMPLETED- Job concluído com sucesso, arquivos disponíveis para downloadFAILED- Job encontrou um erro
Output Format
Formato de arquivo: NDJSON (JSON delimitado por nova linha)
Organização de arquivos: arquivos separados para cada tipo de recurso
Extensão do arquivo: .ndjson
Localização: bucket e caminho do S3 especificados
Tratamento de erros
A operação retorna HTTP 400 Bad Request com uma OperationOutcome das seguintes condições:
- Erros de autorização
-
A função do IAM especificada em
DataAccessRoleArnnão tem permissões suficientes para realizar a operação de exportação. Para obter a lista completa das permissões necessárias do S3 e do KMS, consulte Configuração de permissões para trabalhos de exportação. - Erros de validação de parâmetros
-
O
patientparâmetro não está formatado comoPatient/id,Patient/id,...Uma ou mais referências de pacientes são inválidas ou não pertencem ao Grupo especificado
O valor do
exportTypeparâmetro não é um tipo de exportação compatívelO
_typeparâmetro contém tipos de recursos que não são compatíveis com o tipo de exportação especificado.O
_typeparâmetro não contém os tipos de recursos necessários (Group,Patient,Coverage) para o tipo dehl7.fhir.us.davinci-atrexportaçãoO valor do
_includeEOB2xWoFinancialparâmetro não é um booleano válido
- Erros de validação de recursos
-
O recurso de grupo especificado não existe no armazenamento de dados
O recurso de grupo especificado não tem membros
Um ou mais membros do Grupo fazem referência a recursos do paciente que não existem no armazenamento de dados
Segurança e autorização
$davinci-data-exporté uma operação em massa de back-end autorizada por meio de permissões do IAM ou SMART em nível de sistema em escopos FHIR (OAuth 2.0); solicitações que apresentam escopos em nível de paciente ou usuário são rejeitadas. A operação não avalia os recursos de consentimento do FHIR para filtrar ou restringir os dados exportados.
Os mecanismos de autorização padrão do FHIR se aplicam
A função de acesso a dados deve ter as permissões necessárias do IAM para operações do S3 e do KMS. Para ver a lista completa das permissões necessárias, consulte Configuração de permissões para trabalhos de exportação.
Práticas recomendadas
Seleção do tipo de recurso: solicite somente os tipos de recursos necessários para minimizar o tamanho da exportação e o tempo de processamento
Time-Based Filtragem: use o
_sinceparâmetro para exportações incrementaisFiltragem de pacientes: use o
patientparâmetro quando precisar apenas de dados de membros específicosMonitoramento de trabalhos: verifique regularmente o status do trabalho para grandes exportações
Tratamento de erros: implemente a lógica de repetição adequada para trabalhos com falha
Reconhecimento do filtro temporal: para exportações Payer-to-Payer e de acesso de membros, considere o filtro temporal de 5 anos ao selecionar os tipos de recursos
Remoção de dados financeiros: use
_includeEOB2xWoFinancial=truequando precisar de dados de sinistros sem informações financeirasGerenciamento de perfil: garanta que os recursos tenham declarações de perfil apropriadas, valide os perfis de destino antes da ingestão e use o controle de versão do perfil para controlar o comportamento de exportação
Limitações
Máximo de 500 pacientes pode ser especificado no
patientparâmetroA exportação é limitada apenas às Group-level operações
Suporta apenas o conjunto predefinido de tipos de recursos para cada tipo de exportação
A saída está sempre no formato NDJSON
Payer-to-Payer e as exportações do Member Access são limitadas a 5 anos de dados clínicos e de sinistros
A transformação de dados financeiros só se aplica aos perfis CARIN BB 2.x ExplanationOfBenefit