Desenhamos, perfilamos, publicamos e mantemos guias de implementação FHIR — do alcance institucional de uma organização a especificações nacionais e regionais — em R4 e R5, com regras de conformidade que os implementadores podem validar por conta própria.
Um guia de implementação não é documentação: é o contrato de conformidade.
O FHIR define recursos deliberadamente flexíveis para servir a qualquer país e a qualquer domínio clínico. Essa mesma flexibilidade explica por que dois sistemas «compatíveis com FHIR» podem ser incapazes de se entender. Um guia de implementação fecha essa distância: fixa quais recursos são usados, quais elementos são obrigatórios, quais terminologias se aplicam, quais identificadores são reconhecidos, como a informação é buscada e o que um sistema precisa cumprir para ser considerado conforme. Na Meddyg construímos esses guias como especificações executáveis — perfis, ValueSets, exemplos, regras e testes publicados como pacote instalável — e não como documentos que cada implementador interpreta à sua maneira.
Alcances
Dois alcances, o mesmo rigor técnico
O método é o mesmo. O que muda é quem governa a especificação, quantos implementadores dependem dela e quanto custa errar.
Institucional / organizacional
Uma organização e os sistemas que operam sob sua autoridade.
Nacional / regional
Uma jurisdição inteira, ou vários países que precisam reportar sob um mesmo formato.
Quem governa
Institucional / organizacionalUm comitê técnico interno. Os acordos são feitos entre áreas da mesma organização: clínica, TI, qualidade e segurança da informação.
Nacional / regionalUma autoridade de saúde, uma mesa técnica nacional ou um organismo regional, com instituições que não se reportam entre si e ainda assim precisam convergir.
Quem implementa
Institucional / organizacionalOs sistemas próprios e os dos fornecedores diretos: prontuário eletrônico, laboratório, imagens, farmácia, faturamento, portais do paciente.
Nacional / regionalTodo o ecossistema: instituições públicas e privadas, fornecedores de software e redes de intercâmbio, com níveis de maturidade muito distintos.
Como se decide
Institucional / organizacionalCiclos curtos. É possível iterar com os implementadores reais na mesma semana e corrigir sobre casos concretos.
Nacional / regionalCiclos longos, consulta pública e revisão formal. Cada decisão de perfilamento afeta dezenas de implementadores ao mesmo tempo.
Como se publica
Institucional / organizacionalPublicação interna ou em domínio próprio, com o pacote disponível para os fornecedores. Não exige balotagem nem consulta externa.
Nacional / regionalPublicação formal: URLs canônicas estáveis, jurisdição declarada, histórico de versões e pacote disponível em registros públicos.
Como se versiona
Institucional / organizacionalAlinhado ao calendário de releases dos sistemas da organização — um calendário que a organização controla.
Nacional / regionalVersionamento semântico com política de compatibilidade e períodos de transição anunciados. Quebrar um guia nacional custa anos de recuperação.
Como se exige conformidade
Institucional / organizacionalComo cláusula contratual e critério de aceite: um fornecedor é conforme quando sua implementação valida contra o pacote publicado.
Nacional / regionalComo condição de habilitação para se conectar, com testes de conformidade, ambiente de certificação e, quando aplicável, connectathons.
Quem mantém
Institucional / organizacionalA equipe interna, com acompanhamento da Meddyg enquanto a organização consolida sua própria capacidade de perfilamento.
Nacional / regionalUm processo permanente: recebimento de solicitações de mudança, releases planejados e suporte contínuo aos implementadores.
Os dois alcances compartilham o mesmo pipeline técnico e os mesmos artefatos de conformidade. A diferença está na governança, na política de versões e no custo de uma mudança incompatível.
Metodologia
Como construímos um guia de implementação
Sete etapas. Cada uma produz artefatos que são validados e publicados — não entregáveis intermediários que ficam dentro de um documento.
De onde vem o guia: as SMART Guidelines da OMS
Um guia de implementação não nasce de um documento em branco. A OMS define uma escada de cinco níveis para descer de uma norma clínica narrativa até um software que a executa e pode ser testado, e um guia FHIR é exatamente o nível L3. Quando o domínio já tem um DAK publicado —o nível L2—, suas personas, processos, elementos de dados, indicadores e requisitos são o insumo de que parte o perfilamento, em vez de serem reconstruídos do zero em cada país.
Os cinco níveis
L1Narrativa: a norma tal como é publicada
L2DAK: personas, processos, elementos de dados, lógica, indicadores e requisitos
L3Legível por máquina: perfis FHIR, terminologia e lógica em CQL
L4Executável: testado contra casos e dados de referência
L5Melhoria contínua: a evidência de uso realimenta a norma
Usamos as SMART Guidelines como modelo de referência e método de trabalho. Não é um projeto entregue à OMS: é o modelo com que organizamos o trabalho quando existe uma norma clínica por trás do guia.
01
Casos de uso e alcance
Definimos quais intercâmbios o guia cobre e quais ficam explicitamente de fora. Atores, cenários, gatilhos e o percurso completo de cada transação, de ponta a ponta.
Artefatos
Documento de alcance
Atores e sistemas participantes
Cenários de intercâmbio
Critérios de sucesso
Em um guia institucional
Os casos nascem de dores concretas: um resultado que não chega, um atendimento duplicado, um relatório que alguém monta à mão todo mês.
Em um guia nacional ou regional
Os casos nascem de um mandato: uma norma de notificação compulsória, um programa de saúde pública ou um compromisso regional de reporte.
02
Modelo de informação e mapeamento para FHIR
Antes de perfilar, acordamos o que cada dado significa. Modelamos a informação clínica do domínio e decidimos qual recurso FHIR a representa — e quando a resposta certa é uma extensão em vez de forçar um recurso.
Artefatos
Modelo lógico
Dicionário de dados
Mapeamento dado → recurso e elemento
Registro de decisões de desenho
Em um guia institucional
O mapeamento é feito contra os modelos que já existem nos sistemas da organização, incluindo suas particularidades históricas.
Em um guia nacional ou regional
O mapeamento é feito contra a norma e contra o core nacional, para que o novo guia dependa dele em vez de redefini-lo por conta própria.
03
Perfilamento e extensões
Restringimos os recursos ao que o caso de uso exige: cardinalidades, must-support, slicing, tipos permitidos e invariantes expressas em FHIRPath. As extensões são definidas somente quando o dado não cabe no recurso base.
Artefatos
StructureDefinition (perfis)
StructureDefinition (extensões)
Invariantes FHIRPath
Convenções de identificadores
Em um guia institucional
Perfilamento apertado: dá para restringir com firmeza porque o universo de sistemas é conhecido e delimitado.
Em um guia nacional ou regional
Perfilamento prudente: cada obrigatoriedade deixa algum implementador de fora, então o que se exige hoje fica separado do que se anuncia para o próximo release.
04
Terminologia e semântica
Compartilhar estruturas não é compartilhar significado. Definimos os vocabulários de cada elemento, a força do binding e as equivalências com os códigos locais já em uso.
Artefatos
CodeSystem
ValueSet
ConceptMap
Força de binding por elemento
Regras de versionamento terminológico
Em um guia institucional
Resolvem-se as tabelas de códigos próprias de cada sistema e sua equivalência com o vocabulário padrão, sem obrigar a substituí-las de imediato.
Em um guia nacional ou regional
Define-se quem publica e mantém os ValueSets nacionais e sob quais condições se distribuem vocabulários licenciados, como o SNOMED CT®.
05
Conformidade e capacidade
O guia declara o que um sistema conforme precisa ser capaz de fazer: quais operações expõe, quais buscas suporta, quais perfis aceita e o que deve rejeitar. Sem isso, «conforme» não é verificável por ninguém.
Artefatos
CapabilityStatement
SearchParameter
OperationDefinition
Exemplos válidos e exemplos que devem falhar
Regras de conformidade por ator
Em um guia institucional
A conformidade vira cláusula contratual e critério de aceite para receber uma entrega de um fornecedor.
Em um guia nacional ou regional
A conformidade vira requisito de habilitação: sem ela, um sistema não se conecta ao ecossistema.
06
Publicação
Escrevemos o guia em FSH e o compilamos com SUSHI e o IG Publisher, dentro de um pipeline de integração contínua que executa o relatório de QA a cada mudança. A saída é um site navegável e um pacote instalável.
Artefatos
Fontes FSH e sushi-config
Pipeline CI com relatório de QA
Site publicado do guia
Pacote FHIR versionado
URLs canônicas
Em um guia institucional
É publicado em um domínio da organização e entregue aos fornecedores como parte da documentação de integração.
Em um guia nacional ou regional
É publicado com jurisdição declarada, histórico de versões e presença em registros públicos, com a URL canônica como identidade permanente de cada artefato.
07
Validação, adoção e manutenção
Um guia que ninguém consegue implementar não serve. Validamos os exemplos com o validador oficial, preparamos material e testes para os implementadores, acompanhamos as primeiras integrações e deixamos o ciclo de mudanças aberto.
Artefatos
Exemplos validados
TestScript e plano de testes
Guia para implementadores
Processo de solicitações de mudança
Política de versionamento
Em um guia institucional
Acompanhamos a primeira integração real até que ela valide de ponta a ponta em produção, e não apenas no ambiente de testes.
Em um guia nacional ou regional
Organizam-se testes de conectividade e connectathons, e o suporte aos implementadores é sustentado durante todo o período de adoção.
Estratégia de versão
R4 e R5: a versão é uma decisão de ecossistema
A pergunta certa não é qual versão é melhor, e sim com quem o seu sistema precisa conversar e por quanto tempo. Trabalhamos nas duas e, quando o ecossistema exige, sustentamos ambas ao mesmo tempo.
R4
FHIR R4 · 4.0.1
A versão com a maior base instalada.
É a versão implementada pela maioria dos servidores, bibliotecas e produtos comerciais que hoje estão em produção.
É a exigida por muitas licitações e por integrações já contratadas, que não serão renegociadas por causa de uma troca de versão.
Boa parte do ecossistema de guias publicados e das ferramentas de teste está construída sobre ela.
É a escolha natural quando o guia precisa funcionar contra sistemas que sua organização não controla.
R5
FHIR R5 · 5.0.0
Recursos mais maduros para domínios em que o R4 ficava curto.
Recursos e elementos que no R4 eram insuficientes chegam mais completos, o que reduz a quantidade de extensões próprias a inventar.
É a versão sobre a qual a Meddyg desenhou, perfilou e publicou os guias do ecossistema de saúde da Costa Rica.
É a escolha natural quando se define um ecossistema novo e se controla o calendário dos implementadores.
Vale verificar o suporte real da versão nos servidores e ferramentas do projeto antes de comprometê-la em uma especificação.
Convivência e migração
Quase nenhum ecossistema troca de versão de um dia para o outro. O normal é que R4 e R5 convivam por anos, e essa convivência se projeta em vez de improvisar.
Declarar a versão de referência do guia e quais versões de FHIR cada endpoint aceita, de forma explícita e verificável.
Usar extensões cross-version quando um dado que só existe em uma versão precisa trafegar na outra, em vez de inventar uma extensão própria que ninguém mais entenderá.
Manter o mapeamento entre os perfis equivalentes de cada versão, para que migrar não signifique redesenhar o guia.
Publicar o guia nas duas versões quando o ecossistema justifica, a partir de um mesmo modelo de informação e de um mesmo pipeline.
Anunciar a transição com um período de sobreposição real, para que nenhum implementador fique de fora do intercâmbio de um release para o outro.
Isolar a tradução entre versões na camada de integração, e não em cada sistema cliente, para pagar esse custo uma única vez.
Resultados
O que sua organização recebe
Tudo o que um implementador precisa para construir, validar e demonstrar conformidade sem depender de uma reunião conosco.
Pacote FHIR publicável
O guia compilado e versionado, instalável com as ferramentas padrão do ecossistema.
Perfis e extensões
StructureDefinitions com cardinalidades, must-support, slicing e invariantes documentadas.
ValueSets e ConceptMaps
Terminologias, força de binding e equivalências entre os códigos locais e os padrões.
Exemplos validados
Instâncias que passam no validador, incluindo casos limite e exemplos que devem falhar.
CapabilityStatement e buscas
O que um sistema conforme expõe: operações, parâmetros de busca e perfis aceitos.
Fontes e pipeline
Repositório com FSH, configuração e integração contínua, para que o guia siga vivo sem nós.
Política de versionamento
Regras de compatibilidade, numeração e transição entre releases do guia.
Material para implementadores
Documentação inicial, plano de testes e acompanhamento das primeiras integrações.
Experiência
Guias que construímos
Especificações publicadas e em uso, não exercícios de laboratório. Cada uma define o contrato de conformidade de um intercâmbio que acontece hoje.
Perfis para o intercâmbio de relatórios de estudos de imagens médicas.
Papel da MeddygColaboração no desenho, perfilamento e publicação.
Nacional
Notificação compulsória, vacinas e resultados de laboratório — EDUS/CCSS
Guia para a notificação de doenças de notificação compulsória, vacinas e resultados de laboratório. A Meddyg implementou e colocou em produção o primeiro servidor FHIR que receberia essas notificações do EDUS/CCSS e, posteriormente, de outros estabelecimentos de saúde.
Papel da MeddygParticipação no desenho, perfilamento e publicação do guia, e implementação da infraestrutura receptora.
Regional
Notificação regional de ESAVI
Primeiro guia de implementação HL7® FHIR® para a notificação regional de ESAVI (Eventos Supostamente Atribuíveis à Vacinação e Imunização), junto com o desenho da infraestrutura que receberia essas notificações.
Papel da MeddygParte da equipe da Meddyg participou como consultora no desenho do guia e no desenho e implementação da infraestrutura receptora.
Nacional
Assinatura digital de recursos FHIR — Banco Central da Costa Rica
Integração do formato JAdES dentro do GAUDI, a plataforma de assinatura digital e selagem do BCCR. Não é um guia em si: é exatamente o tipo de regra de conformidade — como se assina e como se verifica um recurso — que um guia precisa declarar para que o não repúdio seja exigível.
Papel da MeddygAssistência técnica para que as equipes do BCCR habilitassem a assinatura de recursos FHIR.
Os guias acima são de alcance nacional e regional. O mesmo método — modelo de informação, perfis, terminologia, conformidade e publicação — é o que aplicamos em guias institucionais, com ciclos mais curtos e governança interna.
Perfil
Para quem é este serviço?
O método é o mesmo; o que muda é o que está em jogo quando a especificação fica ambígua.
Autoridades nacionais de saúde
Ministérios e órgãos reguladores que precisam normatizar como o país reporta e troca informação. O guia transforma a norma escrita em algo verificável.
Seguridade social e redes públicas
Sistemas de cobertura nacional com muitos estabelecimentos e fornecedores. O guia define o que se exige de cada um, sem negociar caso a caso.
Organismos regionais e programas multipaís
Iniciativas em que vários países precisam reportar sob um mesmo formato sem abrir mão das particularidades de cada um.
Redes de intercâmbio (HIE)
Ecossistemas que incorporam novos participantes e precisam de um contrato técnico repetível, em vez de um acordo diferente por conexão.
Hospitais e redes hospitalares
Organizações com vários sistemas clínicos que querem parar de negociar o formato a cada nova integração.
Laboratórios e centros de imagem
Resultados e laudos que precisam chegar a múltiplos receptores externos com a mesma estrutura e os mesmos códigos.
Fornecedores de software de saúde
Produtos que precisam demonstrar conformidade com um guia nacional, ou construir o seu para ordenar a integração com os clientes.
Autodiagnóstico
Reconhece algum destes problemas?
Dizemos que somos «compatíveis com FHIR», mas cada integração é negociada do zero.
Cada fornecedor interpreta o padrão à sua maneira e todas as interpretações são defensáveis.
Temos uma norma de notificação escrita em prosa e ninguém sabe traduzi-la em estruturas.
Não conseguimos decidir se um sistema é conforme sem um especialista revisando mensagens à mão.
Publicamos perfis, mas não exemplos nem testes que os implementadores possam executar.
Nosso guia vive em um documento que já não coincide com o que os sistemas fazem.
Cada instituição define os seus próprios códigos para o mesmo conceito clínico.
Precisamos decidir entre R4 e R5 e as opiniões internas estão divididas.
Temos um guia em R4 e o ecossistema ao qual devemos nos conectar avançou para R5.
Ninguém sabe quem aprova uma mudança na especificação nem quando sai a próxima versão.
Cada release do guia quebra integrações que já estavam funcionando.
Um fornecedor passou na revisão e em produção envia dados que não conseguimos processar.
Se alguma destas situações descreve a sua organização, um guia de implementação é a forma de transformar o acordo em uma regra que se pode validar.
Precisa que «conforme» signifique algo verificável?
Um guia de implementação transforma normas e acordos em regras que um sistema pode validar antes de entrar em produção.