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

curl -G https://landing-zone-api.nilo.services/fhir/resources/Appointment \
     -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 appointment-type=https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/appointment-type|ONLINE \
     -d date=ge2026-06-01 \
     --data-urlencode identifier=https://www.acmesaude.com.br/integracao/agendamento/|AG-3001 \
     --data-urlencode patient=Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4 \
     --data-urlencode patient:identifier=https://www.acmesaude.com.br/integracao/paciente/|507823709 \
     --data-urlencode practitioner=Practitioner/1f30c8b7-45ad-4e62-9c81-73b0e5f24a19 \
     --data-urlencode practitioner:identifier=https://www.acmesaude.com.br/integracao/profissional/|5032932 \
     -d status=booked

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Appointment/8f30c26b-5d17-4e94-a1c3-70b6e2854f19",
      "resource": {
        "resourceType": "Appointment",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--scheduling-v2",
            "value": "620914",
            "use": "usual"
          },
          {
            "system": "https://www.acmesaude.com.br/integracao/agendamento/",
            "value": "AG-3001",
            "use": "usual"
          }
        ],
        "status": "booked",
        "participant": [
          {
            "actor": {
              "identifier": {
                "system": "https://www.acmesaude.com.br/integracao/paciente/",
                "value": "507823709",
                "use": "usual"
              },
              "type": "Patient",
              "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
            },
            "status": "accepted"
          },
          {
            "actor": {
              "identifier": {
                "system": "https://www.acmesaude.com.br/integracao/profissional/",
                "value": "5032932",
                "use": "usual"
              },
              "type": "Practitioner",
              "reference": "Practitioner/1f30c8b7-45ad-4e62-9c81-73b0e5f24a19"
            },
            "status": "accepted"
          }
        ],
        "id": "8f30c26b-5d17-4e94-a1c3-70b6e2854f19",
        "meta": {
          "lastUpdated": "2026-06-01T09:12:45.208000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
        },
        "start": "2026-06-15T14:00:00+00:00",
        "end": "2026-06-15T14:30:00+00:00",
        "description": "Consulta de retorno — endocrinologia",
        "comment": "Paciente pediu horário no fim da tarde.",
        "appointmentType": {
          "coding": [
            {
              "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/appointment-type",
              "code": "ONLINE",
              "display": "Atendimento Online"
            }
          ]
        },
        "created": "2026-06-01T09:12:44+00:00",
        "contained": [
          {
            "resourceType": "Endpoint",
            "address": "https://video.nilo.services/r/9f2c41a8",
            "status": "active",
            "connectionType": {
              "code": "https"
            },
            "payloadType": [
              {
                "text": "video"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Appointment/1d74b8e0-92a6-4c15-830f-4e5a7c93d268",
      "resource": {
        "resourceType": "Appointment",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--scheduling-v2",
            "value": "620915",
            "use": "usual"
          }
        ],
        "status": "fulfilled",
        "participant": [
          {
            "actor": {
              "identifier": {
                "system": "https://www.acmesaude.com.br/integracao/paciente/",
                "value": "507823709",
                "use": "usual"
              },
              "type": "Patient",
              "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
            },
            "status": "accepted"
          },
          {
            "actor": {
              "identifier": {
                "system": "https://www.acmesaude.com.br/integracao/profissional/",
                "value": "5032932",
                "use": "usual"
              },
              "type": "Practitioner",
              "reference": "Practitioner/1f30c8b7-45ad-4e62-9c81-73b0e5f24a19"
            },
            "status": "accepted"
          }
        ],
        "id": "1d74b8e0-92a6-4c15-830f-4e5a7c93d268",
        "meta": {
          "lastUpdated": "2026-06-02T11:40:02.774000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM5OA"
        },
        "start": "2026-06-02T10:00:00+00:00",
        "end": "2026-06-02T10:40:00+00:00",
        "description": "Consulta inicial — nutrição",
        "appointmentType": {
          "coding": [
            {
              "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/appointment-type",
              "code": "IN_PERSON",
              "display": "Atendimento Presencial"
            }
          ]
        },
        "created": "2026-05-20T15:03:11+00:00"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Devolve os agendamentos entre pacientes e profissionais do seu ambiente.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

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

patientstringOptional

Agendamentos de um paciente, pelo id Nilo FHIR dele.

patient:identifierstringOptional

Agendamentos de um paciente, pelo identificador dele embutido na referência.

practitionerstringOptional

Agendamentos de um profissional, pelo id Nilo FHIR dele.

practitioner:identifierstringOptional

Agendamentos de um profissional, pelo identificador dele.

datestringOptional

Data do agendamento, comparada com o start. Aceita os prefixos eq, ge e le.

statusenumOptional

Situação do agendamento. Só os seis valores que a plataforma produz aparecem nos resultados.

appointment-typestringOptional

Modalidade, na sintaxe system|code.

_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 agendamento encontrado. 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