Pular para o conteúdo principal

Grupo de pacientes

Contexto NiloCare


Esse endpoint permite aos clientes Nilo Saúde manipular os grupos de pacientes da plataforma NiloCare.

Mapeamento de Campos

Recurso FHIR: Group

#CampoExpressão de caminho no objeto FHIR
1Nomename
dica

O campo name é persistido no grupo. O identifier é obrigatório e usado como chave de upsert (ver abaixo). O campo active também não é armazenado — ele controla o ciclo de vida do grupo (ver abaixo). Os demais atributos do payload (type, actual, etc.) são aceitos por conformidade com o FHIR, mas não são armazenados nem afetam o sistema.

Especificações de comportamento FHIR - NiloCare


Identificação e upsert

O campo identifier é obrigatório e é usado como chave de deduplicação: se já existir um grupo com o mesmo identifier, a requisição é tratada como atualização; caso contrário, um novo grupo é criado. Enviar um payload sem identifier resulta em erro.

Na resposta, o sistema adiciona automaticamente um identifier do próprio NiloCare (system .../fhir/resources/NamingSystem/care-api--cohort, cujo value é o identificador interno do grupo). Esse identifier pode ser usado para consultar o grupo posteriormente.

Ciclo de vida (active)

O campo active não representa um status armazenado; ele controla o ciclo de vida do grupo:

  • active: true — cria ou atualiza o grupo normalmente.
  • active: falseremove o grupo do NiloCare.

Regras de negócio aplicadas:

  • Um grupo não pode ser criado com active: false.
  • Um grupo não pode ser removido (active: false) enquanto contém pacientes associados.

Os cenários de erro correspondentes estão documentados em Cadastrar/Atualizar.