Pular para o conteúdo principal
Docs vAtualAPI
Versão: Atual

Changelog, versionamento e depreciação

Versionamento

  • A API é versionada no caminho: /api/v1/.... Mudanças incompatíveis entram numa nova versão (/api/v2), nunca quebrando a v1 em produção.
  • O contrato é aditivo: novos campos podem ser adicionados à resposta a qualquer momento — trate campos desconhecidos de forma tolerante. As versões internas do motor/regra vêm em analysis_metadata.source_versions.
  • schema_version identifica o contrato da resposta (v2).

Política de depreciação

  • Recursos a serem removidos são anunciados aqui com antecedência mínima de 90 dias e passam a responder o header Deprecation (RFC 8594) com a data de término.
  • Endpoints administrativos seguem documentados no Swagger Admin (/docs/admin), separados das rotas de cliente.

Changelog

2026-06 — Integração hospitalar, contrato estruturado e dev experience

  • FHIR R4 (POST /fhir/$check): Bundle → RiskAssessment + DetectedIssue; perfis MedicationRequest/Statement, Condition, AllergyIntolerance, Observation, Patient, Encounter, DiagnosticReport, Practitioner.
  • CDS Hooks (/cds-services): medication-prescribe e order-select com cards.
  • HL7 v2 (POST /hl7v2/$check): MSH/PID/AL1/DG1/RXO/RXE/RXR/OBX.
  • Lote (POST /interactions/batch, até 25 itens).
  • Idempotência (Idempotency-Key) em check/batch/fhir/hl7v2/cds.
  • Webhooks: entrega com até 3 tentativas + log + replay (admin).
  • Contrato clínico estruturado (UCUM): dose+dose_unit (incl. mg/kg, mg/m2), forma/concentração/duração/indicação e códigos DCB/ATC/RxNorm/GTIN; bloco clinical_context_assessment (completude + risco residual).
  • Semântica transacional: resposta com request_id, replayed_request, billing_status; replay idempotente não é cobrado; GET /analyses/{id}/status.
  • Sandbox: chaves sm_test_ não são cobradas (billing_status: "not_charged").
  • Dev: SDKs Python e Node, coleção Postman, página de Fluxos do sistema.

Anterior

  • Governança de alertas (P2): bloco alert_governance, visões médico × farmacêutico, confirmação em crítico, métrica "alertas que mudaram a conduta", dashboard/ROI (admin).
  • Motor clínico (P1): clinical_alerts (12 validações determinísticas) + safety net offline.