Cadastrar ou atualizar | Nilo Saúde · Interoperabilidade FHIR

curl -X POST https://landing-zone-api.nilo.services/fhir/resources/PlanDefinition \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "resourceType": "PlanDefinition",
  "identifier": [
    {
      "system": "https://www.acmesaude.com.br/integracao/diretriz/",
      "value": "DM2",
      "use": "usual"
    }
  ],
  "name": "Acompanhamento de diabetes tipo 2",
  "status": "active",
  "description": "Linha de cuidado para pacientes com diabetes tipo 2 em acompanhamento contínuo.",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code": "order-set"
      }
    ]
  },
  "url": "https://www.acmesaude.com.br/diretrizes/diabetes-tipo-2"
}'

{
  "resourceType": "PlanDefinition",
  "identifier": [
    {
      "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--care-line",
      "value": "412",
      "use": "usual"
    },
    {
      "system": "https://www.acmesaude.com.br/integracao/diretriz/",
      "value": "DM2",
      "use": "usual"
    }
  ],
  "name": "Acompanhamento de diabetes tipo 2",
  "status": "active",
  "id": "5d81f3b6-04e7-4a29-9c50-b6127ea38d41",
  "meta": {
    "lastUpdated": "2026-03-02T09:41:55.318000Z",
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
  },
  "description": "Linha de cuidado para pacientes com diabetes tipo 2 em acompanhamento contínuo.",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code": "order-set",
        "display": "Order Set"
      }
    ]
  },
  "url": "https://www.acmesaude.com.br/diretrizes/diabetes-tipo-2",
  "effectivePeriod": {
    "start": "2025-01-01T00:00:00+00:00"
  }
}

Cria uma diretriz ou atualiza uma existente, reconhecida pelo identifier. Grava nome, descrição e tipo. Uma diretriz criada por aqui nasce vazia — as consultas, tarefas, questionários e mensagens dela são montados pela equipe no Nilo Care.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

resourceTypestringRequiredDefaults to PlanDefinition

Indica o tipo do recurso transacionado.

identifierlist of objectsRequired

Suas chaves da diretriz. Obrigatório na escrita: é por elas que a API decide entre criar e atualizar. A leitura devolve o seu identificador ao lado do identificador Nilo da diretriz, no system .../NamingSystem/hippocrates-api--care-line.

namestringRequiredformat: "^[ \r\n\t\S]+$"

Nome da diretriz, como a equipe a vê. No máximo 100 caracteres.

statusstringRequiredformat: "^[^\s]+(\s[^\s]+)*$"

Exigido pelo FHIR R4 e descartado na gravação: a vigência é definida na plataforma. Envie active. Na leitura, active numa diretriz vigente e retired fora da vigência — e só uma diretriz active pode ser aplicada a um paciente.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"

Só resposta: identificador Nilo FHIR da diretriz.

metaobjectOptional

Só resposta: metadados da gravação.

descriptionstringOptionalformat: "^[ \r\n\t\S]+$"

Descrição da diretriz.

typeobjectOptional

Linha de cuidado ou protocolo. Omitido, uma diretriz existente preserva o tipo que tem e uma diretriz nova nasce como linha de cuidado.

urlstringOptionalformat: "^\S*$"

Uma URL canônica sua para esta diretriz. Não é guardada pela plataforma, mas fica no recurso e serve para referenciá-la em CarePlan.instantiatesCanonical sem precisar do id do recurso. Precisa ser única: uma URL já usada por outra diretriz recusa a chamada com 409.

effectivePeriodobjectOptional

Só resposta: a vigência da diretriz, definida na plataforma. É o que decide o status. Enviá-la não tem efeito.

Response

Diretriz criada ou atualizada. O corpo é o recurso como ficou gravado, sem envelope.

resourceTypestringDefaults to PlanDefinition

Indica o tipo do recurso transacionado.

identifierlist of objects

namestringformat: "^[ \r\n\t\S]+$"