Buscar por parâmetros | Nilo Saúde · Interoperabilidade FHIR

curl -G https://landing-zone-api.nilo.services/fhir/resources/PlanDefinition \
     -H "x-api-key: <apiKey>" \
     -d _count=50 \
     -d _lastUpdated=eq2013-01-14 \
     --data-urlencode _page_token=Cjj3YopYuf%2F%2F%2F%2F%2BABd%2BbgE0m...dSANQAFoLCUSM7w9VYUqaEANglLWUugQ%3D \
     --data-urlencode identifier=https://www.acmesaude.com.br/integracao/diretriz/|DM2 \
     -d name=Acompanhamento \
     -d status=active \
     --data-urlencode type=http://terminology.hl7.org/CodeSystem/plan-definition-type|order-set \
     --data-urlencode url=https://www.acmesaude.com.br/diretrizes/diabetes-tipo-2

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/PlanDefinition/5d81f3b6-04e7-4a29-9c50-b6127ea38d41",
      "resource": {
        "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"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/PlanDefinition/b7420ce9-1d68-43a5-8f01-e6329ba5d7c2",
      "resource": {
        "resourceType": "PlanDefinition",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--care-line",
            "value": "388",
            "use": "usual"
          }
        ],
        "name": "Pós-operatório de artroplastia",
        "status": "retired",
        "id": "b7420ce9-1d68-43a5-8f01-e6329ba5d7c2",
        "meta": {
          "lastUpdated": "2026-01-15T13:02:44.907000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM4MA"
        },
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
              "code": "clinical-protocol",
              "display": "Clinical Protocol"
            }
          ]
        },
        "effectivePeriod": {
          "end": "2026-01-15T00:00:00+00:00",
          "start": "2024-02-01T00:00:00+00:00"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Devolve as diretrizes do seu ambiente. É por aqui que se descobre a URL a usar em CarePlan.instantiatesCanonical.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

Identificador da diretriz, na sintaxe system|value. Aceita a sua chave ou o identificador Nilo da diretriz.

statusenumOptional

Situação da diretriz. Só as active podem ser aplicadas a um paciente.

Allowed values:

namestringOptional

Nome da diretriz. A busca casa pelo início do nome, não por qualquer trecho dele.

urlstringOptional

A URL canônica exata da diretriz, quando você tiver definido uma.

typestringOptional

Tipo da diretriz, na sintaxe system|code. order-set é linha de cuidado, clinical-protocol é protocolo.

_countintegerOptional

Quantidade de registros por página.

_lastUpdatedlist of stringsOptional

Data de última alteração dos registros que devem ser retornado.

_page_tokenstringOptional

Seleciona a página de um resultado paginado.

Response

Operação bem sucedida.

resourceTypestringDefaults to Bundle

Indica o tipo do recurso transacionado.

typeenum

Constante searchset neste endpoint.

entrylist of objectsOptional

Uma entrada por diretriz encontrada. Vazia quando não há resultados.

linklist of objectsOptionalRead-only

Navegação do resultado. Havendo próxima página, ela vem pronta em next.

Errors

400

Bad Request Error