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

curl -G https://landing-zone-api.nilo.services/fhir/resources/Schedule \
     -H "x-api-key: <apiKey>" \
     -d _count=50 \
     -d _lastUpdated=eq2013-01-14 \
     -d active=true \
     --data-urlencode actor=Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4 \
     --data-urlencode actor:identifier=https://www.acmesaude.com.br/integracao/paciente/|507823709 \
     -d date=ge2026-06-01 \
     --data-urlencode identifier=https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--guideline-patient-scheduling|90412 \
     --data-urlencode "service-type=Consulta de retorno" \
     -d specialty=Endocrinologia

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Schedule/6a2f70b4-cd39-4185-92e7-8b04f1c6ae53",
      "resource": {
        "resourceType": "Schedule",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--guideline-patient-scheduling",
            "value": "90412",
            "use": "usual"
          }
        ],
        "id": "6a2f70b4-cd39-4185-92e7-8b04f1c6ae53",
        "meta": {
          "lastUpdated": "2026-05-20T08:12:03.552000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
        },
        "active": true,
        "actor": [
          {
            "identifier": {
              "system": "https://www.acmesaude.com.br/integracao/paciente/",
              "value": "507823709",
              "use": "usual"
            },
            "type": "Patient",
            "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
          },
          {
            "identifier": {
              "system": "https://www.acmesaude.com.br/integracao/profissional/",
              "value": "5032932",
              "use": "usual"
            },
            "type": "Practitioner",
            "reference": "Practitioner/1f30c8b7-45ad-4e62-9c81-73b0e5f24a19"
          }
        ],
        "planningHorizon": {
          "start": "2026-06-15"
        },
        "specialty": [
          {
            "text": "Endocrinologia"
          }
        ],
        "serviceType": [
          {
            "text": "Consulta de retorno"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Schedule/c93a1e07-45b8-4d26-b7f1-08e5c2947da6",
      "resource": {
        "resourceType": "Schedule",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--guideline-patient-scheduling",
            "value": "90413",
            "use": "usual"
          }
        ],
        "id": "c93a1e07-45b8-4d26-b7f1-08e5c2947da6",
        "meta": {
          "lastUpdated": "2026-05-22T17:45:11.908000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM4NQ"
        },
        "active": false,
        "actor": [
          {
            "identifier": {
              "system": "https://www.acmesaude.com.br/integracao/paciente/",
              "value": "507823709",
              "use": "usual"
            },
            "type": "Patient",
            "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
          }
        ],
        "planningHorizon": {
          "end": "2026-05-22T17:45:10+00:00",
          "start": "2026-05-18"
        },
        "specialty": [
          {
            "text": "Nutrição"
          }
        ],
        "comment": "cancelled-reason:Paciente remarcou | manual-status:not_done"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Devolve as consultas previstas pelas diretrizes aplicadas aos pacientes.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

Identificador da consulta prevista, na sintaxe system|value. É sempre o identificador Nilo — este recurso não carrega chave de parceiro.

actorstringOptional

Consultas previstas de um paciente ou de um profissional, pelo id Nilo FHIR dele.

actor:identifierstringOptional

O mesmo, pelo identificador embutido na referência, na sintaxe system|value.

activeenumOptional

true para as consultas previstas em aberto, false para as encerradas.

Allowed values:

datestringOptional

Data prevista, comparada com o planningHorizon. Aceita os prefixos eq, ge e le.

service-typestringOptional

Tipo de atendimento previsto.

specialtystringOptional

Especialidade da consulta prevista.

_countintegerOptional

Quantidade de registros por página.

_lastUpdatedlist of stringsOptional

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

Response

Operação bem sucedida.

resourceTypestringDefaults to Bundle

Indica o tipo do recurso transacionado.

typeenum

Constante searchset neste endpoint.

Allowed values:

entrylist of objectsOptional

Uma entrada por consulta prevista 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