Duas visões do catálogo
A árvore documental separa APIs publicadas no DevPortal e APIs presentes no Micro Integrator.
| Fronteira | Papel | Exemplos encontrados |
|---|---|---|
| DevPortal / API Manager | Interfaces publicadas e governadas para consumidores | FHIR, MHD, EHRPoster, consentimento, usuário e SCIM |
| Micro Integrator | Mediação e composição de serviços internos | MPIService, MHDService, EHRRunnerService, Binary, notificações e registro |
| Adaptadores | Integrações específicas com sistemas e fornecedores | MvVivaceAdapter, Connector e NotificaGovBr |
APIs no DevPortal
As 18 entradas abaixo aparecem individualmente no sumário principal. Cobertura indica quanto o arquivo de origem permite explicar, não a maturidade do serviço em execução.
| API | Área didática | Cobertura na fonte | Arquivo de origem |
|---|---|---|---|
| Admin | Administração | Detalhada | apis-gerenciadas-hu-digital/apis-no-devportal/admin.md |
| APPC | Consentimento / IHE | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/appc.md |
| ConnectorMonitor | Operação de conectores | Nominal | apis-gerenciadas-hu-digital/apis-no-devportal/connectormonitor.md |
| Consentimento | Privacidade e autorização | Parcial | apis-gerenciadas-hu-digital/apis-no-devportal/consentimento.md |
| EHRPoster | Ingestão clínica | Detalhada | apis-gerenciadas-hu-digital/apis-no-devportal/api-ehrposter.md |
| EHRRunner | Consulta clínica | Detalhada | apis-gerenciadas-hu-digital/apis-no-devportal/bundle-fhir-para-sumario-de-saude-do-paciente.md |
| FHIR | Recursos clínicos FHIR | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/fhir.md |
| Media | Mídia e binários | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/media.md |
| MHD | Documentos clínicos / IHE MHD | Parcial | apis-gerenciadas-hu-digital/apis-no-devportal/fhir-mhd.md |
| MPI | Identidade do paciente | Detalhada | apis-gerenciadas-hu-digital/apis-no-devportal/fhir-patient.md |
| MvVivaceAdapter | Integração de imagens | Parcial | apis-gerenciadas-hu-digital/apis-no-devportal/mvvivaceadapter.md |
| OAuth-Validator | Autorização | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/oauth-validator.md |
| PassRecoveryService | Recuperação de acesso | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/passrecoveryservice.md |
| PIXManager | Correlação de identidade | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/pixmanager.md |
| SCIM | Provisionamento de usuários | Parcial | apis-gerenciadas-hu-digital/apis-no-devportal/scim.md |
| SIGN-UP | Cadastro de usuário | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/sign-up.md |
| User | Conta e perfil de usuário | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/user.md |
| ValidarCNS | Validação de identificador | Breve | apis-gerenciadas-hu-digital/apis-no-devportal/validarcns.md |
APIs no Micro Integrator
O sumário nomeia 17 serviços do Micro Integrator. A maioria dos arquivos é um marcador curto; eles permanecem visíveis para descoberta, sem operações inventadas.
| API | Área didática | Cobertura na fonte | Arquivo de origem |
|---|---|---|---|
| Binary | Binários clínicos | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/binary.md |
| Connector | Mediação de conectores | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/connector.md |
| ConsentService | Consentimento | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/consentservice.md |
| EHRRunnerAdmin | Administração EHRRunner | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/ehrrunneradmin.md |
| EHRRunnerService | Consulta clínica | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/ehrrunnerservice.md |
| IntrospectionTokenServices | Introspecção de token | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/introspectiontokenservices.md |
| MHDService | Documentos / IHE MHD | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/mhdservice.md |
| MPIService | Identidade do paciente | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/mpiservice.md |
| Notifica1hora | Notificação programada | Breve | apis-gerenciadas-hu-digital/apis-no-micro-integrator/api-notifica1hora.md |
| Notificacoes | Notificações | Detalhada | apis-gerenciadas-hu-digital/apis-no-micro-integrator/api-notificacoes.md |
| NotificaGovBr | Integração gov.br | Parcial | apis-gerenciadas-hu-digital/apis-no-micro-integrator/notificagovbr.md |
| PIX | Correlação de identidade | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/pix.md |
| PractitionerPractitionerRole | Profissional e papel | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/practitionerpractitionerrole.md |
| RegistrationServices | Registro | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/registrationservices.md |
| registryCompositeApplication | Registro de aplicação | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/registrycompositeapplication.md |
| registryCompositeExporter | Exportação de registro | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/registrycompositeexporter.md |
| User-EBSERH | Usuário institucional | Nominal | apis-gerenciadas-hu-digital/apis-no-micro-integrator/user-ebserh.md |
17serviços nomeados
14registros nominais
1registro breve
2parcial ou detalhado
Famílias por responsabilidade
Depois de localizar os nomes, agrupar por resultado de negócio ajuda a compreender as relações.
- Informação clínica: FHIR, EHRPoster, EHRRunner, MHD, MHDService e Binary.
- Identidade clínica: MPI, MPIService, PIX, PIXManager e ValidarCNS.
- Identidade de acesso: OAuth-Validator, IntrospectionTokenServices, SCIM, SIGN-UP, PassRecoveryService, User e User-EBSERH.
- Privacidade: Consentimento, ConsentService e APPC.
- Operação: Admin, ConnectorMonitor, Connector, EHRRunnerAdmin e componentes registryComposite.
- Comunicação: Notifica1hora, Notificacoes e NotificaGovBr.
- Integrações específicas: MvVivaceAdapter, PractitionerPractitionerRole e RegistrationServices.
Consumidor
↓ API publicada
API Manager / DevPortal
↓ política e mediação
Micro Integrator
├── identidade / consentimento
├── MPI / FHIR / MHD
└── documentos / notificações
↓
Repositórios e sistemas integradosComo interpretar a cobertura
Cobertura documental e disponibilidade operacional são dimensões diferentes.
| Rótulo | Critério editorial | Uso seguro |
|---|---|---|
| Detalhada | Há descrição extensa, exemplos ou estrutura de contrato | Permite estudo com sanitização e confirmação de versão |
| Parcial | Há descrição relevante, mas não contrato completo | Serve para orientação de escopo |
| Breve | Há poucos registros além do título | Confirma presença e algum contexto |
| Nominal | Arquivo é essencialmente um marcador de nome | Confirma apenas a entrada no catálogo |
Como consultar uma API com segurança
A documentação de treinamento deve ser combinada com o contrato aprovado do ambiente autorizado.
- 1Definir o caso
Escolher a família responsável pelo resultado desejado.
- 2Localizar a entrada
Usar os catálogos nominais desta página e conferir a fonte relativa.
- 3Confirmar o contrato
Consultar a especificação publicada e a versão autorizada no ambiente.
- 4Obter acesso
Usar o processo institucional; nunca copiar credenciais de documentação.
- 5Testar com segurança
Usar dados sintéticos e observar validação, autorização, retorno e auditoria.