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

curl -G https://landing-zone-api.nilo.services/fhir/resources/Communication \
     -H "x-api-key: <apiKey>" \
     -d _count=50 \
     -d _lastUpdated=eq2013-01-14 \
     --data-urlencode identifier=https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/parrot-api--whats-app-message|9911204 \
     -d received=ge2026-07-01 \
     --data-urlencode recipient=Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4 \
     --data-urlencode recipient:identifier=https://www.acmesaude.com.br/integracao/paciente/|507823709 \
     --data-urlencode sender=Practitioner/1f30c8b7-45ad-4e62-9c81-73b0e5f24a19 \
     --data-urlencode sender:identifier=https://www.acmesaude.com.br/integracao/profissional/|5032932 \
     -d sent=ge2026-07-01 \
     -d status=completed

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Communication/a3f802d6-71b4-4e59-9c07-52d148ba3e91",
      "resource": {
        "resourceType": "Communication",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/parrot-api--whats-app-message",
            "value": "9911204",
            "use": "usual"
          }
        ],
        "status": "completed",
        "id": "a3f802d6-71b4-4e59-9c07-52d148ba3e91",
        "meta": {
          "lastUpdated": "2026-07-02T14:31:13.004000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
        },
        "medium": [
          {
            "coding": [
              {
                "code": "REMOTE",
                "display": "remote presence",
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode"
              }
            ],
            "text": "remote presence"
          }
        ],
        "sent": "2026-07-02T14:31:08+00:00",
        "received": "2026-07-02T14:31:12+00:00",
        "sender": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/profissional/",
            "value": "5032932",
            "use": "usual"
          },
          "type": "Practitioner",
          "reference": "Practitioner/1f30c8b7-45ad-4e62-9c81-73b0e5f24a19"
        },
        "recipient": [
          {
            "identifier": {
              "system": "https://www.acmesaude.com.br/integracao/paciente/",
              "value": "507823709",
              "use": "usual"
            },
            "type": "Patient",
            "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
          }
        ],
        "payload": [
          {
            "contentString": "Bom dia! Sua consulta é amanhã às 14h."
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Communication/7e40b915-c2d8-4a63-81f7-06e93a2c5478",
      "resource": {
        "resourceType": "Communication",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/parrot-api--whats-app-message",
            "value": "9911207",
            "use": "usual"
          }
        ],
        "status": "completed",
        "id": "7e40b915-c2d8-4a63-81f7-06e93a2c5478",
        "meta": {
          "lastUpdated": "2026-07-02T14:40:55.318000Z",
          "versionId": "MTc4NjAyMTQ1MjkwNTAwMDQwMg"
        },
        "medium": [
          {
            "coding": [
              {
                "code": "REMOTE",
                "display": "remote presence",
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode"
              }
            ],
            "text": "remote presence"
          }
        ],
        "sent": "2026-07-02T14:40:51+00:00",
        "sender": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/paciente/",
            "value": "507823709",
            "use": "usual"
          },
          "type": "Patient",
          "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
        },
        "payload": [
          {
            "contentString": "Confirmado, obrigada!"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Devolve as mensagens trocadas com os pacientes pela conversa da plataforma.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

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

senderstringOptional

Mensagens de um remetente, pelo id Nilo FHIR dele.

sender:identifierstringOptional

Mensagens de um remetente, pelo identificador dele.

recipientstringOptional

Mensagens para um paciente, pelo id Nilo FHIR dele.

recipient:identifierstringOptional

Mensagens para um paciente, pelo identificador dele.

statusenumOptional

Situação de entrega da mensagem.

Allowed values:

sentstringOptional

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

receivedstringOptional

Data de entrega, com os prefixos eq, ge e le.

mediumstringOptional

Aceito, e inútil: toda mensagem é REMOTE.

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