Visão Geral de Modelos de Documento
A clínica pode personalizar o papel timbrado e o layout dos documentos que o sistema gera em PDF (receita, pedido de exames, atestado, declaração, orçamento etc.). Cada modelo é um template do pdfme salvo por tipo e por versão.
Autenticação necessária
Todas as rotas exigem o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Isolamento por conta (multi-tenant)
Os modelos são da conta do token. Versões excluídas nunca são retornadas.
Base
https://api-dev.imagemais.com.br/api/document-templates
Rotas e permissões
| Método | Rota | Permissão | Descrição |
|---|---|---|---|
GET | /document-templates | — (só autenticado) | Modelos em uso, um por tipo |
GET | /document-templates/{type}/versions | read_document_templates | Histórico de versões de um tipo |
GET | /document-templates/{type}/versions/{version} | read_document_templates | Uma versão, com o modelo |
POST | /document-templates/{type} | update_document_templates | Salva o modelo (cria a próxima versão e a põe em uso) |
POST | /document-templates/{type}/versions/{version}/activate | update_document_templates | Põe uma versão salva em uso |
DELETE | /document-templates/{type}/versions/{version} | delete_document_templates | Exclui uma versão do histórico |
DELETE | /document-templates/{type} | update_document_templates | Volta o tipo ao modelo padrão do sistema |
Tipos de documento
LETTERHEADPRESCRIPTIONEXAMSREFERRALMEDICAL_CERTIFICATEDECLARATIONLIFESTYLE_ADVICEAPPOINTMENT_RECEIPTPROCEDURE_REFERRALBUDGETCOLLECTION_RECEIPTSTANDALONE_DECLARATIONRAPID_TEST_HISTORY
Como funciona o versionamento
- Salvar nunca sobrescreve. Cada
POST /document-templates/{type}cria a versão seguinte (1, 2, 3…), que passa a valer. O número de uma versão nunca se repete, mesmo que a anterior tenha sido excluída. - Só uma versão por tipo fica em uso (
active: true). - Tipo sem versão em uso usa o modelo padrão do sistema (definido no front).
- Voltar ao padrão não apaga nada: desativa a versão em uso, e as versões continuam no histórico para serem reativadas.
- A versão em uso não pode ser excluída.
Blocos obrigatórios
O modelo só é salvo se tiver, em alguma página, o bloco que o gerador preenche (por name e type):
| Tipo | Bloco (name) | type |
|---|---|---|
LETTERHEAD | assinatura | image |
PRESCRIPTION | itens | table |
EXAMS | exames | list |
REFERRAL, MEDICAL_CERTIFICATE, DECLARATION, LIFESTYLE_ADVICE, STANDALONE_DECLARATION | texto | text |
APPOINTMENT_RECEIPT | horario | text |
PROCEDURE_REFERRAL | procedimento | text |
BUDGET, COLLECTION_RECEIPT | exames | table |
RAPID_TEST_HISTORY | testes | table |
O papel timbrado (LETTERHEAD) precisa ainda ter, em algum texto do modelo, as variáveis {titulo}, {data}, {paciente}, {medico} e {crm}.