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

curl -G https://landing-zone-api.nilo.services/fhir/resources/Encounter \
     -H "x-api-key: <apiKey>" \
     -d _lastUpdated=eq2013-01-14 \
     --data-urlencode _page_token=Cjj3YopYuf%2F%2F%2F%2F%2BABd%2BbgE0m...dSANQAFoLCUSM7w9VYUqaEANglLWUugQ%3D \
     --data-urlencode class=http://terminology.hl7.org/CodeSystem/v3-ActCode|VR \
     -d date=ge2026-04-01 \
     --data-urlencode diagnosis=Condition/c61b5f58-32b0-477b-b75a-54e306952082 \
     --data-urlencode identifier=https://www.acmesaude.com.br/integracao/atendimento/|55162 \
     --data-urlencode participant=Practitioner/1a9c7f52-64b8-4a3e-8d21-9f0b7c4e6d38 \
     --data-urlencode participant-type=http://terminology.hl7.org/CodeSystem/v3-ParticipationType|ATND \
     --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/1a9c7f52-64b8-4a3e-8d21-9f0b7c4e6d38 \
     -d status=finished \
     --data-urlencode subject=Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Encounter/7c1d4e08-52ba-4f37-9e6a-3b0d81f5c294",
      "resource": {
        "class": {
          "code": "VR",
          "display": "virtual",
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode"
        },
        "period": {
          "start": "2026-04-16T19:30:00+00:00",
          "end": "2026-04-16T20:00:00+00:00"
        },
        "resourceType": "Encounter",
        "status": "finished",
        "subject": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/paciente/",
            "value": "507823709",
            "use": "usual"
          },
          "type": "Patient",
          "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
        },
        "id": "7c1d4e08-52ba-4f37-9e6a-3b0d81f5c294",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--appointment-v3",
            "value": "318472",
            "use": "usual"
          },
          {
            "system": "https://www.acmesaude.com.br/integracao/atendimento/",
            "value": "55162",
            "use": "usual"
          }
        ],
        "extension": [
          {
            "url": "https://landing-zone-api.nilo.services/fhir/resources/StructureDefinition/encounter-serviceChannel",
            "valueCodeableConcept": {
              "coding": [
                {
                  "code": "3",
                  "display": "Vídeo",
                  "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/encounter-serviceChannel"
                }
              ],
              "text": "Vídeo"
            }
          }
        ],
        "participant": [
          {
            "individual": {
              "identifier": {
                "system": "https://www.acmesaude.com.br/integracao/profissional/",
                "value": "5032932",
                "use": "usual"
              },
              "type": "Practitioner",
              "reference": "Practitioner/1a9c7f52-64b8-4a3e-8d21-9f0b7c4e6d38"
            },
            "type": [
              {
                "coding": [
                  {
                    "code": "ATND",
                    "display": "attender",
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType"
                  }
                ],
                "text": "attender"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

Identificador do atendimento, na sintaxe system|value. É a busca mais usada: reencontra o atendimento pela chave do seu próprio sistema.

patient:identifierstringOptional

Atendimentos de um paciente, pelo identificador dele, na sintaxe system|value.

patientstringOptional

Atendimentos de um paciente, pelo id Nilo FHIR dele.

subjectstringOptional

O mesmo campo que patient, e aceita o mesmo modificador :identifier.

classstringOptional

Tipo do atendimento. VR e AMB são atendimentos do prontuário, EMER e IMP são eventos.

statusstringOptional

Situação do atendimento. Os valores gravados pela plataforma são planned, in-progress e finished.

datelist of stringsOptional

Período do atendimento, com os prefixos de data do FHIR (eq, ge, le). Repetível para delimitar um intervalo.

practitionerstringOptional

Atendimentos de um profissional, pelo id Nilo FHIR dele. Aceita o modificador :identifier para filtrar pelo identificador do profissional.

participantstringOptional

O mesmo campo que practitioner, e aceita o mesmo :identifier.

participant-typestringOptional

Papel do participante. Nos atendimentos do prontuário é sempre ATND; nas consultas antigas do histórico é o código CBO da especialidade.

diagnosisstringOptional

Condição vinculada ao atendimento. Só encontra eventos EMER e IMP. Aceita o modificador :identifier.

_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

Indica a finalidade deste pacote, como ele deve ser usado.

entrylist of objectsOptional

Uma lista de recursos do pacote.

linklist of objectsOptionalRead-only

Um conjunto de links que fornecem contexto/navegação neste pacote.

Errors

400

Bad Request Error