Pular para o conteúdo principal

Consultar

EndpointGET /fhir/resources/Appointment
Autenticação🔓 Chave de API
StatusImplementado

Modelagem da API - Request​

Exemplo de requisição CURL
curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Appointment \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Headers

OpçãoTipoRequeridoDescriçãoExemplo
x-api-keystringSimChave de autenticação do cliente, fornecida durante a configuração do ambiente.
Content-TypestringSimapplication/json

Parâmetros de caminho

OpçãoTipoRequeridoDescriçãoExemplo
IDstringNãoUUID do recurso FHIR.ba200cfa-dae0-46cf-81a0-008e3f7414b4

Parâmetros de Query

Você poderá utilizar todos os parâmetros de pesquisa disponíveis do recurso canônico.

https://hl7.org/fhir/R4/appointment.html#search

Filtros suportados​

Dos parâmetros de pesquisa canônicos do Appointment, os que efetivamente retornam resultados são os correspondentes aos campos preenchidos pela integração:

NomeTipoDescriçãoExpressão de caminho
identifiertokenIdentificador do agendamento, no formato system|value. Aceita tanto o identificador da Nilo quanto o do sistema de origem.Appointment.identifier
statustokenSituação do agendamento (ex.: booked, cancelled, noshow, fulfilled).Appointment.status
datedateData/hora prevista de início. Aceita prefixos de comparação (ge, le, gt, lt).Appointment.start
patientreferencePaciente do agendamento.Appointment.participant.actor
practitionerreferenceProfissional do agendamento.Appointment.participant.actor
actorreferenceQualquer participante (paciente ou profissional).Appointment.participant.actor
appointment-typetokenModalidade do atendimento (ONLINE ou IN_PERSON).Appointment.appointmentType
part-statustokenSituação da participação — sempre accepted nos agendamentos gerados pela Nilo.Appointment.participant.status
Campos sem filtro

description, comment, created e a sala de vídeo (contained) são retornados no recurso, mas não possuem parâmetro de pesquisa no FHIR R4 e portanto não podem ser usados como filtro.


Exemplo de requisição CURL por identificador do sistema de origem

curl --request GET \
--url 'https://landing-zone-api.nilo.services/fhir/resources/Appointment?identifier=https://www.acmesaude.com.br/integracao/agendamento/|AG-98765' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'


Exemplo de requisição CURL por paciente e período

curl --request GET \
--url 'https://landing-zone-api.nilo.services/fhir/resources/Appointment?patient.identifier=https://www.acmesaude.com.br/integracao/paciente/|1234&date=ge2026-01-01&status=booked' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'


Modelagem da API - Response​

Operação bem sucedida.
Array of objects

Uma lista de recursos do pacote.

Array of objects

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

resourceType
required
string
Default: "Bundle"

Indica o tipo do recurso transacionado.

type
required
string
Enum: "document" "message" "transaction" "transaction-response" "batch" "batch-response" "history" "searchset" "collection"

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

{
  • "entry": [
    ],
  • "link": [
    ],
  • "resourceType": "Bundle",
  • "type": "searchset"
}