> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.nilo.services/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.nilo.services/_mcp/server.

# Buscar por parâmetros

GET https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan

Devolve o catálogo de planos de saúde do seu ambiente. É por aqui que se descobre o id do plano a usar em `Coverage.class[0].value`.

Reference: https://api-docs.nilo.services/referencia/endpoints/insurance-plan/insurance-plan-search-by-params

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://landing-zone-api.nilo.services` (Production, default)
- `https://landing-zone-api.stg.nilo.services` (Staging)

## Request

### Query parameters

- `identifier` (string, optional) — Identificador do plano, na sintaxe `system|value`. Os planos do catálogo trazem o identificador Nilo; uma chave sua só encontra o plano se você a tiver gravado nele.
- `name` (string, optional) — Parte do nome do plano.
- `status` (enum, optional) — Situação do plano: `active` num plano em uso, `retired` num plano desativado.
  - Allowed values: `active`, `retired`
- `_count` (integer, optional) — Quantidade de registros por página.
- `_lastUpdated` (list of string, optional) — Data de última alteração dos registros que devem ser retornado.

## Response

### 200

Operação bem sucedida.

- `resourceType` (string, required, default: Bundle) — Indica o tipo do recurso transacionado.
- `type` (enum, required) — Constante `searchset` neste endpoint.
  - Allowed values: `searchset`
- `entry` (list of InsurancePlan_Entry, optional) — Uma entrada por plano encontrado. Vazia quando não há resultados.
- `link` (list of BundleInsurancePlanLinkItems, optional) — Navegação do resultado. Havendo próxima página, ela vem pronta em `next`.

## Errors

### 400 Bad Request Error

Parâmetro enviado inválido.

- `issue` (list of OperationOutcomeIssueItems, required) — Uma coleção de mensagens de erro, aviso ou informação que resultado de uma ação do sistema.
- `resourceType` (string, required, default: OperationOutcome) — Indica o tipo do recurso transacionado.

## Types

### InsurancePlan_Entry

Envelope da leitura por `id`. Não é um `Bundle`, mas também não é o recurso nu: o plano está em `resource`.

- `fullUrl` (string, required) — URL absoluta do recurso neste ambiente.
- `resource` (InsurancePlan, required) — O plano de saúde.
- `search` (InsurancePlanEntrySearch, optional) — Constante com `mode` igual a `match`, herdada da forma de busca.

### BundleInsurancePlanLinkItems

- `relation` (string, optional) — Uma relação conforme a definição RFC8288.
- `url` (string, optional) — Link de referência.

### OperationOutcomeIssueItems

Uma mensagem de erro, aviso ou informação que resultado de uma ação do sistema.

- `code` (enum, optional) — Descreve o tipo do problema.
  - Allowed values: `invalid`, `structure`, `required`, `value`, `invariant`, `security`, `login`, `unknown`, `expired`, `forbidden`, `suppressed`, `processing`, `not-supported`, `duplicate`, `multiple-matches`, `not-found`, `deleted`, `too-long`, `code-invalid`, `extension`, `too-costly`, `business-rule`, `conflict`, `transient`, `lock-error`, `no-store`, `exception`, `timeout`, `incomplete`, `throttled`, `informational`
- `details` (CodeableConcept, optional) — Detalhes adicionais sobre os códigos de resultado da operação de erro.
- `diagnostics` (string, optional) — Informações de diagnóstico adicionais sobre o problema
- `expression` (list of string, optional) — FHIR Path (caminho) do(s) elemento(s) relacionado(s) ao problema.
- `severity` (enum, optional) — Indica o resultado do processamento apesar do problema indicado.
  - Allowed values: `fatal`, `error`, `warning`, `information`

### InsurancePlan

Plano de saúde do catálogo do seu ambiente: o convênio, o plano ou o benefício que uma cobertura de paciente nomeia. É o alvo de `Coverage.class[0].value` e da extensão `insurance-plan` da cobertura. Na escrita, só o `name` é gravado.

- `resourceType` (string, required, default: InsurancePlan) — Indica o tipo do recurso transacionado.
- `identifier` (list of Identifier, required) — Suas chaves do plano. **Obrigatório na escrita**: é por elas que a API encontra o plano a alterar. A leitura devolve o seu identificador ao lado do identificador Nilo do plano, no `system` `.../NamingSystem/care-api--insurance-v2`, cujo `value` é o mesmo id usado em `Coverage.class[0].value`.
- `name` (string, required) — Nome do plano, como ele aparece na cobertura do paciente. **É o único dado que a plataforma grava** — todo o resto do payload é descartado. No máximo 200 caracteres.
- `id` (string, optional) — Só resposta: identificador Nilo FHIR do plano.
- `meta` (Meta, optional) — Só resposta: metadados da gravação.
- `status` (enum, optional) — Só resposta: `active` num plano em uso, `retired` num plano desativado. A situação é definida pela plataforma; enviá-la não muda nada.
  - Allowed values: `active`, `retired`

### InsurancePlanEntrySearch

Constante com `mode` igual a `match`, herdada da forma de busca.

- `mode` (string, optional)

### CodeableConcept

Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde.

- `coding` (list of Coding, optional) — Código definido por um sistema de terminologia.
- `text` (string, optional) — Representação de texto simples do conceito.

### Identifier

Um identificador, código que identifica alguma entidade de forma única e inequívoca. Normalmente, isso é usado para identificadores de negócios.

- `system` (string, required) — O namespace para o valor do identificador. O cliente deve usar o seu próprio namespace.
- `value` (string, required) — O código de identificação único. Cliente deve usar o seu próprio.
- `use` (enum, optional) — A finalidade deste identificador.
  - Allowed values: `usual`, `official`, `temp`, `secondary`, `old`

### Meta

Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.

- `lastUpdated` (string, optional) — Um instante no tempo (necessário conhecer pelo menos até o nível de segundos).
- `versionId` (string, optional) — Qualquer combinação de letras, números, "-" e ".", com um limite de 64 caracteres. (Pode ser um número inteiro, um OID não prefixado, UUID ou qualquer outro padrão de identificador que atenda a essas restrições.) Os IDs não diferenciam maiúsculas de minúsculas.

### Coding

Código definido por um sistema de terminologia.

- `code` (string, optional) — Código de identificação de um termo no sistema terminológico.
- `display` (string, optional) — Representação textual definida pelo sistema terminológico.
- `system` (string, optional) — Identidade do sistema terminológico.

## Examples

### Busca com resultados

**Response**

```json
{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan/61a4c8d2-9e35-47bb-a0f1-2c7d5e8b3f90",
      "resource": {
        "resourceType": "InsurancePlan",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2",
            "value": "2481",
            "use": "usual"
          }
        ],
        "name": "Acme Saúde Ambulatorial",
        "id": "61a4c8d2-9e35-47bb-a0f1-2c7d5e8b3f90",
        "status": "active"
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan/0d7f3e51-8c26-4a90-bb14-7e5a1c9d2408",
      "resource": {
        "resourceType": "InsurancePlan",
        "identifier": [
          {
            "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2",
            "value": "1907",
            "use": "usual"
          }
        ],
        "name": "Acme Saúde Básico (encerrado)",
        "id": "0d7f3e51-8c26-4a90-bb14-7e5a1c9d2408",
        "status": "retired"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": []
}
```

**SDK Code**

```python Busca com resultados
import requests

url = "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan"

querystring = {"_count":"50","_lastUpdated":"[\"eq2013-01-14\"]","identifier":"https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2|2481","name":"Ambulatorial","status":"active"}

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Busca com resultados
const url = 'https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Busca com resultados
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Busca com resultados
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Busca com resultados
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Busca com resultados
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Busca com resultados
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Busca com resultados
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Busca sem resultados

**Response**

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

**SDK Code**

```python Busca sem resultados
import requests

url = "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan"

querystring = {"_count":"50","_lastUpdated":"[\"eq2013-01-14\"]","identifier":"https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2|2481","name":"Ambulatorial","status":"active"}

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Busca sem resultados
const url = 'https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Busca sem resultados
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Busca sem resultados
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Busca sem resultados
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Busca sem resultados
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Busca sem resultados
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Busca sem resultados
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan?_count=50&_lastUpdated=%5B%22eq2013-01-14%22%5D&identifier=https%3A%2F%2Flanding-zone-api.nilo.services%2Ffhir%2Fresources%2FNamingSystem%2Fcare-api--insurance-v2%7C2481&name=Ambulatorial&status=active")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```