Consultar

Endpoint	GET /fhir/resources/Flag
Autenticação	🔓 Chave de API
Status	Implementado

Modelagem da API - Request

---

Exemplo de requisição CURL

curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Flag \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Headers

Opção	Tipo	Requerido	Descrição				Exemplo
x-api-key	string	Sim	Chave de autenticação do cliente, fornecida durante a configuração do ambiente.
Content-Type	string	Sim					application/json

Parâmetros de caminho

Opção	Tipo	Requerido	Descrição			Exemplo
ID	string	Não	UUID 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/flag.html#search

Filtros suportados

Dos parâmetros de busca canônicos do Flag, apenas os campos preenchidos pelo NiloCare podem ser usados como filtro:

Parâmetro	Suportado	Observação
identifier	✅	Identificador do NiloCare ou do sistema de origem do cliente
subject / patient	✅	Referência ao paciente (aceita busca encadeada por identifier)
date	✅	Corresponde a Flag.period
author	⚠️	Não preenchido pelo NiloCare — só retorna as tags em que o próprio cliente enviou o campo
encounter	⚠️	Não preenchido pelo NiloCare — só retorna as tags em que o próprio cliente enviou o campo

Observação

status, code e category são preenchidos no recurso, mas não são parâmetros de busca do Flag no FHIR R4 — portanto não podem ser usados como filtro.

Exemplos de filtros

Filtro por paciente

Filtro por CPF do paciente

curl --request GET \
--url "https://landing-zone-api.nilo.services/fhir/resources/Flag?subject.identifier=https://servicos.receita.fazenda.gov.br/servicos/cpf/%7C12345678900" \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Observação

• O valor 12345678900 é um CPF fictício. Um valor real deve ser utilizado.

Filtro por identificador da tag

Filtro pelo identificador do sistema de origem

curl --request GET \
--url "https://landing-zone-api.nilo.services/fhir/resources/Flag?identifier=http://sistemaorigem.cliente.com/flag%7C12345" \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Observação

• O system http://sistemaorigem.cliente.com/flag é um valor fictício. Deve-se utilizar o mesmo system enviado na criação da tag.
• Para consultar pelo identificador interno do NiloCare, utilize o system https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--patient-tag.

Filtro por vigência

Tags com vigência iniciada a partir de uma data

curl --request GET \
--url "https://landing-zone-api.nilo.services/fhir/resources/Flag?date=ge2025-01-01" \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Modelagem da API - Response

---

✔ 200

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": [

  • {

    • "fullUrl": "{host}/fhir/resources/.../7d154473-...-a5ce077ef77f",
    • "request": {

      • "method": "POST",
      • "url": "Patient"

      },
    • "resource": {

      • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
      • "meta": {

        • "lastUpdated": "2022-05-25T18:42:06.551129+00:00",
        • "versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"

        },
      • "resourceType": "Flag",
      • "category": [

        • {

          • "coding": [

            • {

              • "code": "12",
              • "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/flag-category"

              }

            ]

          }

        ],
      • "code": {

        • "coding": [

          • {

            • "code": "79",
            • "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/flag-code"

            }

          ]

        },
      • "author": {

        • "display": "string",
        • "identifier": {

          • "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
          • "use": "usual",
          • "value": "12345"

          },
        • "reference": "string",
        • "type": "string"

        },
      • "encounter": {

        • "display": "string",
        • "identifier": {

          • "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
          • "use": "usual",
          • "value": "12345"

          },
        • "reference": "string",
        • "type": "string"

        },
      • "identifier": [

        • {

          • "system": "http://sistemaorigem.cliente.com/flag",
          • "value": "12345"

          }

        ],
      • "period": {

        • "end": "2026-02-01T00:00:00+00:00",
        • "start": "2026-01-01T00:00:00+00:00"

        },
      • "status": "active",
      • "subject": {

        • "identifier": {

          • "system": "https://servicos.receita.fazenda.gov.br/servicos/cpf/",
          • "use": "official",
          • "value": "12345678900"

          },
        • "type": "Patient"

        }

      },
    • "search": {

      • "mode": "match"

      }

    }

  ],
• "link": [

  • {

    • "relation": "next",
    • "url": "{host}/fhir/resources/Patient?_page_token=Cjj3YopYuf%2F%2F%2F%2F%2BABd%2BbgE0m...dSANQAFoLCUSM7w9VYUqaEANglLWUugQ%3D"

    }

  ],
• "resourceType": "Bundle",
• "type": "searchset"

}

✘ 400

Parâmetro enviado inválido.

required	Array of objects Uma coleção de mensagens de erro, aviso ou informação que resultado de uma ação do sistema.
resourceType required	string Default: "OperationOutcome" Indica o tipo do recurso transacionado.

{

• "issue": [

  • {

    • "code": "exception",
    • "details": {

      • "text": "Parâmetro enviado inválido"

      },
    • "severity": "error"

    }

  ],
• "resourceType": "OperationOutcome"

}

✘ 500

Erro inesperado.