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

curl -G https://landing-zone-api.nilo.services/fhir/resources/CommunicationRequest \
     -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 \
     -d authored=ge2026-06-01 \
     --data-urlencode identifier=https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/jaiminho-api--scheduled-message|440871 \
     -d occurrence=ge2026-06-01 \
     --data-urlencode patient=Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4 \
     --data-urlencode patient:identifier=https://www.acmesaude.com.br/integracao/paciente/|507823709 \
     -d priority=asap \
     --data-urlencode recipient=Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4 \
     --data-urlencode replaces=CommunicationRequest/c81f5b40-3a29-4e76-90d5-1b47ea62c803 \
     -d status=active \
     --data-urlencode subject=Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/CommunicationRequest/c81f5b40-3a29-4e76-90d5-1b47ea62c803",
      "resource": {
        "resourceType": "CommunicationRequest",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/jaiminho-api--scheduled-message",
            "value": "440871",
            "use": "usual"
          }
        ],
        "status": "active",
        "id": "c81f5b40-3a29-4e76-90d5-1b47ea62c803",
        "meta": {
          "lastUpdated": "2026-06-26T03:00:12.447000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
        },
        "priority": "asap",
        "subject": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/paciente/",
            "value": "507823709",
            "use": "usual"
          },
          "type": "Patient",
          "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
        },
        "recipient": [
          {
            "identifier": {
              "system": "https://www.acmesaude.com.br/integracao/paciente/",
              "value": "507823709",
              "use": "usual"
            },
            "type": "Patient",
            "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
          }
        ],
        "category": [
          {
            "coding": [
              {
                "code": "jaiminho_api.ScheduledMessage",
                "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/communication-category"
              }
            ]
          }
        ],
        "basedOn": [
          {
            "identifier": {
              "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--patient-care-line",
              "value": "77120",
              "use": "usual"
            },
            "type": "CarePlan"
          }
        ],
        "payload": [
          {
            "contentString": "Lembrete: sua consulta de acompanhamento está marcada para a próxima semana."
          }
        ],
        "authoredOn": "2026-06-20T08:00:00+00:00",
        "occurrencePeriod": {
          "start": "2026-06-25T09:00:00+00:00"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Devolve as mensagens programadas para os pacientes do seu ambiente.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

Identificador da mensagem programada, na sintaxe system|value. É sempre o identificador Nilo.

patientstringOptional

Mensagens de um paciente, pelo id Nilo FHIR dele.

patient:identifierstringOptional

Mensagens de um paciente, pelo identificador dele.

subjectstringOptional

O mesmo que patient.

recipientstringOptional

O mesmo paciente, pelo outro campo que o repete.

statusenumOptional

Situação da mensagem programada.

Allowed values:

priorityenumOptional

asap traz as mensagens atrasadas; routine, as demais.

Allowed values:

occurrencestringOptional

Data programada de envio, com os prefixos eq, ge e le.

authoredstringOptional

Data em que a mensagem foi programada, com os prefixos eq, ge e le.

replacesstringOptional

A mensagem programada que esta substitui, pelo id Nilo FHIR dela.

categorystringOptional

Categoria, na sintaxe system|code. O código é um identificador interno — veja o guia.

_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 recurso 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