Documentação pública
Consulta pública das estruturas do modelo canônico Conexxa, com blocos, campos, títulos e descrições em formato de dicionário de dados.
O CCOM (Conexxa Canonical Order Model) é o contrato canônico de dados usado para representar pedidos, itens, participantes, anexos, eventos e devolutivas em integrações da Conexxa Health. Ele padroniza a semântica do negócio e desacopla a origem do canal de comunicação da estrutura operacional interna.
Esta página tem caráter público e documental. Aqui você encontra blocos e campos do modelo, com nomes, títulos e descrições objetivas, sem detalhar a tradução ou implementação de cada integração.
Versão atual
0.2.0
Status
Público
Uso geral
Integrações
Dicionário de dados
Bloco
Versão e perfil do modelo canônico.
schema.name
Nome do modelo
Valor fixo do modelo canônico: CCOM.
schema.version
Versão do modelo
Versão semântica do contrato, por exemplo 0.2.0.
schema.profile
Perfil
Perfil aplicável ao contexto do pedido, como opme, medication ou supplies.
Bloco
Identidade técnica e origem da mensagem.
envelope.messageId
Message ID
Identificador único da mensagem.
envelope.company_id
Company ID
Identificador canônico da empresa responsável pelo pedido.
envelope.correlationId
Correlation ID
Identificador de correlação do fluxo completo.
envelope.idempotencyKey
Idempotency key
Chave para garantir processamento único e evitar duplicidade.
envelope.source.channel
Canal de origem
Origem do dado: TISS_XML, REST_JSON, CSV, webhook, banco ou conector específico.
envelope.occurredAt
Momento do evento
Data/hora do evento registrado pelo canal de origem.
Bloco
Dados principais do pedido e contexto de negócio.
order.id
ID do pedido
Identificador canônico do pedido dentro do CCOM.
order.businessKey
Business key
Identificador do negócio utilizado pela empresa ou sistema origem.
order.type
Tipo de pedido
Categoria principal do pedido, como OPME, medicamento ou material.
order.status
Status
Estado canônico do pedido no workflow.
order.externalIdentifiers[]
Identificadores externos
Lista de valores externos vinculados ao pedido e à origem.
Bloco
Empresa responsável pelo pedido.
company.id
Company ID
Identificador canônico da empresa no modelo.
company.name
Razão social
Nome da empresa ou organização associada ao pedido.
company.ansRegistration
Registro ANS
Identificador operacional, quando aplicável ao contexto da operadora.
company.segment
Segmento
Categoria funcional da empresa, como operadora, hospital ou fornecedor.
Bloco
Beneficiário associado ao atendimento.
beneficiary.id
ID do beneficiário
Identificador canônico do beneficiário do pedido.
beneficiary.cardNumber
Número da carteira
Número do cartão do beneficiário, quando permitido e mascarado.
beneficiary.name
Nome
Nome do beneficiário, quando necessário ao fluxo.
beneficiary.birthDate
Data de nascimento
Data de nascimento do beneficiário, quando aplicável.
Bloco
Contexto assistencial e clínico do atendimento.
careContext.guideNumber
Número da guia
Guia ou documento assistencial associado ao pedido.
careContext.serviceCharacter
Caracterização do serviço
Código do tipo de serviço ou atendimento.
careContext.clinicalIndication
Indicação clínica
Descrição clínica ou justificação do atendimento.
careContext.admission
Internação
Dados de internação, quando houver contexto de hospitalização.
Bloco
Itens de pedido, materiais, serviços ou OPME.
items[].id
ID do item
Identificador canônico do item dentro do pedido.
items[].lineNumber
Linha ou sequência
Número sequencial do item no pedido.
items[].category
Categoria
Categoria do item, como OPME, medicamento, material ou serviço.
items[].description
Descrição
Descrição legível do item.
items[].quantity
Quantidade
Quantidade solicitada ou autorizada do item.
items[].unit
Unidade
Unidade de medida ou código de referência do item.
items[].status
Status do item
Estado do item no workflow do pedido.
Bloco
Documentos, evidências e anexos vinculados.
attachments[].id
ID do anexo
Identificador do documento ou arquivo anexo.
attachments[].type
Tipo
Tipo do anexo, como imagem, PDF, laudo ou contrato.
attachments[].classification
Classificação
Nível de sensibilidade do documento.
attachments[].relatedTo
Relacionamento
Referência ao pedido, item, autorização ou documento relacionado.
Bloco
Autorizações, decisões e respostas do processo.
authorizations[].id
ID da autorização
Identificador canônico da decisão.
authorizations[].status
Status
Estado da autorização: PENDING, AUTHORIZED, DENIED, CANCELLED ou EXPIRED.
authorizations[].scope
Escopo
Pedido e itens sobre os quais a decisão se aplica.
authorizations[].validity
Validade
Início e fim da validade da autorização.
authorizations[].decisionReasons[]
Motivos da decisão
Códigos e textos de justificativa e resposta técnica.
Bloco
Linha do tempo técnica e operacional.
events[].eventId
Event ID
Identificador único e imutável do evento.
events[].eventType
Tipo de evento
Tipo controlado do evento do workflow ou do conector.
events[].occurredAt
Momento do evento
Data/hora em que o evento ocorreu.
events[].actor
Ator
Usuário, sistema, conector ou workflow que gerou o evento.
events[].traceId
Trace ID
Correlação técnica com telemetria e rastreio do processamento.
Bloco
Campos complementares para evolução controlada.
extensions[].namespace
Namespace
Identificador do espaço de extensão do campo adicional.
extensions[].version
Versão da extensão
Versão do schema da extensão.
extensions[].owner
Responsável
Empresa, conector ou módulo responsável pela extensão.
extensions[].data
Dados
Objeto validado pela extensão e específico para o uso do parceiro ou do conector.
Histórico de versões
v0.2.0
Versão pública atual
Escopo ampliado para operadoras e hospitais.
v0.1.0
Versão anterior
Estrutura inicial do modelo canônico.
O CCOM segue versionamento semântico e mantém compatibilidade controlada. Mudanças maiores exigem revisão explícita de adaptadores e conectores.
Contatos
Suporte e contato
Para dúvidas técnicas, implementação, compatibilidade ou suporte operacional do modelo, utilize a página de suporte da Conexxa Health ou envie mensagem para o contato oficial.