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

curl -G https://landing-zone-api.nilo.services/fhir/resources/CarePlan \
     -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 date=ge2026-01-01 \
     --data-urlencode identifier=https://www.acmesaude.com.br/integracao/plano-de-cuidado/|349223 \
     --data-urlencode instantiates-canonical=https://landing-zone-api.nilo.services/fhir/resources/PlanDefinition/aba72582-f9fb-49ea-b316-73b8dba2a4d7 \
     --data-urlencode status=active,on-hold \
     --data-urlencode subject=Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4 \
     --data-urlencode subject.identifier=https://www.acmesaude.com.br/integracao/paciente/|507823709

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/CarePlan/3f21a0d5-9c74-4b18-a6e2-51d8c93f7ab0",
      "resource": {
        "instantiatesCanonical": [
          "https://landing-zone-api.nilo.services/fhir/resources/PlanDefinition/aba72582-f9fb-49ea-b316-73b8dba2a4d7"
        ],
        "intent": "order",
        "resourceType": "CarePlan",
        "status": "active",
        "subject": {
          "identifier": {
            "system": "https://www.acmesaude.com.br/integracao/paciente/",
            "value": "507823709",
            "use": "usual"
          },
          "type": "Patient",
          "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
        },
        "activity": [
          {
            "detail": {
              "description": "Medicina de Família e Comunidade",
              "kind": "Appointment",
              "scheduledPeriod": {
                "end": "2026-05-11",
                "start": "2026-05-04"
              },
              "status": "not-started"
            }
          },
          {
            "progress": [
              {
                "text": "scheduled"
              }
            ],
            "reference": {
              "identifier": {
                "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--scheduling-v2",
                "value": "702914",
                "use": "usual"
              },
              "type": "Appointment"
            }
          },
          {
            "progress": [
              {
                "text": "in-progress"
              }
            ],
            "reference": {
              "identifier": {
                "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/cogsworth-api--to-do",
                "value": "88214",
                "use": "usual"
              },
              "type": "Task"
            }
          },
          {
            "progress": [
              {
                "text": "requested"
              }
            ],
            "reference": {
              "identifier": {
                "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--patient-questionnaire",
                "value": "31905",
                "use": "usual"
              },
              "type": "Task"
            }
          },
          {
            "progress": [
              {
                "text": "completed"
              }
            ],
            "reference": {
              "identifier": {
                "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/jaiminho-api--scheduled-message",
                "value": "55407",
                "use": "usual"
              },
              "type": "CommunicationRequest"
            }
          }
        ],
        "category": [
          {
            "text": "care_line"
          }
        ],
        "created": "2026-04-16",
        "description": "Acompanhamento longitudinal de pacientes com diabetes tipo 2.",
        "id": "3f21a0d5-9c74-4b18-a6e2-51d8c93f7ab0",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--patient-care-line",
            "value": "184532",
            "use": "usual"
          },
          {
            "system": "https://www.acmesaude.com.br/integracao/plano-de-cuidado/",
            "value": "349223",
            "use": "usual"
          }
        ],
        "period": {
          "start": "2026-04-16"
        },
        "title": "Diabetes tipo 2"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}

Authentication

x-api-keystring

API Key authentication via header

Query parameters

identifierstringOptional

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

subject.identifierstringOptional

Planos de um paciente, pelo identificador dele, na sintaxe system|value. É a forma que a própria plataforma usa para reencontrar o plano de um paciente.

subjectstringOptional

Planos de um paciente, pelo id Nilo FHIR dele.

instantiates-canonicalstringOptional

Planos que aplicam uma diretriz, pela URL do PlanDefinition dela. Combinado com subject.identifier, é o par que identifica o plano de um paciente numa diretriz.

statusstringOptional

Situação do plano. Aceita vários valores separados por vírgula, que funcionam como um “ou”.

datelist of stringsOptional

Período de aplicação do plano, com os prefixos de data do FHIR (eq, ge, le). Repetível para delimitar um intervalo.

_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 plano encontrado. Ausente ou 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