> 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 ID

GET https://landing-zone-api.nilo.services/fhir/resources/Coverage/{id}

Devolve a cobertura pelo `id` Nilo FHIR, sem o envelope `Bundle` da busca.

Reference: https://api-docs.nilo.services/referencia/endpoints/coverage/search-by-id

## 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

### Path parameters

- `id` (string, required) — Identificador Nilo Fhir do registro que deve ser retornado.

## Response

### 200

Operação bem sucedida.

- `beneficiary` (Reference, required) — Paciente coberto pelo benefício. **Obrigatório.** Aponta para um `Patient` já cadastrado, por `identifier` ou por `reference`; a referência não cria o paciente. O `type` é assumido como `Patient` quando omitido.
- `payor` (list of Coverage_Payor, required) — Entidade pagadora. **Obrigatório pelo FHIR R4**, mas o conteúdo enviado é descartado: a leitura devolve sempre `[{ "display": "Operadora" }]`.
- `resourceType` (string, required, default: Coverage) — Indica o tipo do recurso transacionado.
- `status` (string, required) — Situação do benefício. **Obrigatório pelo FHIR R4.** Numa cobertura criada pela interface e nunca escrita por esta API, a leitura deriva o valor da vigência.
- `class` (list of Coverage_Class, optional) — Produto da operadora. O plano vai no **primeiro** item da lista, com o id do `InsurancePlan` em `value`. `name` é informativo e não é usado para localizar o plano.
- `dependent` (string, optional) — Número da carteirinha **do próprio beneficiário**, quando ele é dependente — isto é, quando `relationship` é diferente de `self`. Num titular o campo não é lido e a leitura devolve nulo.
- `extension` (list of CoverageExtensionItems, optional) — Informações adicionais que não fazem parte da definição básica do recurso. Abaixo está a única extensão que o `Coverage` reconhece; extensões externas ao contexto Nilo são gravadas no recurso e devolvidas nas leituras, sem efeito sobre a cobertura.
- `id` (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.
- `identifier` (list of Identifier, optional) — Identificador(es) da cobertura. **Ao menos um é obrigatório na escrita**: é por ele que a API decide entre criar e atualizar.
- `meta` (Meta, optional) — Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.
- `order` (double, optional) — Ordem de prioridade de uso entre as coberturas do paciente, começando em `1`. `0` é recusado.
- `period` (Period, optional) — Vigência do benefício. Envie datas puras (`YYYY-MM-DD`) — o NiloCare guarda só a data.
- `policyHolder` (Coverage_PolicyHolder, optional) — Estipulante — dono da apólice do benefício. Só o `display` é lido, em texto livre; não precisa apontar para um recurso.
- `relationship` (CodeableConcept, optional) — Relação do beneficiário com o titular da carteirinha, em `coding[0].code`. **Obrigatório na escrita.** `self` marca o próprio titular; qualquer outro código marca um dependente e muda o sentido de `subscriberId` e `dependent`.
- `subscriberId` (string, optional) — Número da carteirinha **do titular**. Quando `relationship` é `self`, é a carteirinha do próprio beneficiário; nos demais casos, a do titular a quem ele está vinculado.

## 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.

### 404 Not Found Error

Não existe cobertura com o `id` informado.

- `any`

## Types

### Reference

Uma referência de um recurso para outro.

- `identifier` (Identifier, required) — Um identificador, código que identifica alguma entidade de forma única e inequívoca. Normalmente, isso é usado para identificadores de negócios.
- `type` (string, required) — Indica o tipo do recurso referenciado.
- `display` (string, optional) — Alternativa textual para descrever a referência.
- `reference` (string, optional) — Referência direta.

### Coverage_Payor

Entidade pagadora. Obrigatório pelo FHIR R4, e por isso declarado aqui, mas o conteúdo enviado é descartado: a leitura devolve sempre `display: Operadora`.

- `display` (string, optional) — Nome da operadora. Na leitura, sempre `Operadora`.

### Coverage_Class

Classificação do benefício. A Nilo lê apenas o **primeiro** item da lista `class` e usa o seu `value` como id do plano.

- `type` (CodeableConcept, required) — Tipo da classificação. Obrigatório pelo FHIR R4. A leitura devolve sempre `text: plan`.
- `value` (string, required) — Id do `InsurancePlan` no NiloCare. Obrigatório pelo FHIR R4 quando `class` é enviado.
- `id` (string, optional) — Uma sequência de caracteres.
- `name` (string, optional) — Nome do plano. Informativo: não é usado para localizar o plano. A leitura devolve o nome cadastrado no NiloCare.

### CoverageExtensionItems

- Extension-Coverage-insurancePlan: Extension-Coverage-insurancePlan

### 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.

### Period

Um intervalo de tempo definido por uma data de início e término e, opcionalmente, horas para ambos.

- `end` (string, optional) — Uma data, data-hora ou data parcial (por exemplo, apenas ano ou ano + mês).
- `start` (string, optional) — Uma data, data-hora ou data parcial (por exemplo, apenas ano ou ano + mês).

### Coverage_PolicyHolder

Estipulante — dono da apólice do benefício. Só o `display` é lido, em texto livre: não é preciso apontar para um recurso cadastrado.

- `display` (string, optional) — Nome do estipulante.

### 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.

### 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`

### Extension-Coverage-insurancePlan

Produto da operadora, indicado por **qualquer** identificador de um `InsurancePlan` já cadastrado — inclusive o do seu próprio sistema. É a alternativa a `class[0].value`, que aceita só o id Nilo do plano. Enviando as duas formas, `class` vence. A extensão não é derivada na leitura: a resposta traz o plano em `class[0]`.

- `url` (string, optional, default: https://landing-zone-api.nilo.services/fhir/resources/StructureDefinition/insurance-plan) — Identifica o significado da extensão.
- `valueIdentifier` (Identifier, optional) — Identificador de um `InsurancePlan` já cadastrado.

### 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

**Response**

```json
{
  "beneficiary": {
    "identifier": {
      "system": "https://www.acmesaude.com.br/integracao/paciente/",
      "value": "507823709",
      "use": "usual"
    },
    "type": "Patient",
    "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
  },
  "payor": [
    {
      "display": "Operadora"
    }
  ],
  "resourceType": "Coverage",
  "status": "active",
  "class": [
    {
      "type": {
        "text": "plan"
      },
      "value": "42",
      "name": "Unimed com coparticipação SP/SP"
    }
  ],
  "id": "7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73",
  "identifier": [
    {
      "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--coverage",
      "value": "918233",
      "use": "usual"
    },
    {
      "system": "https://www.acmesaude.com.br/integracao/cobertura/",
      "value": "COB-88231",
      "use": "official"
    }
  ],
  "meta": {
    "lastUpdated": "2026-08-06T13:04:12.905000Z",
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
  },
  "order": 1,
  "relationship": {
    "coding": [
      {
        "code": "self"
      }
    ]
  },
  "subscriberId": "1352743"
}
```

**SDK Code**

```python Cobertura encontrada
import requests

url = "https://landing-zone-api.nilo.services/fhir/resources/Coverage/7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73"

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

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

print(response.json())
```

```javascript Cobertura encontrada
const url = 'https://landing-zone-api.nilo.services/fhir/resources/Coverage/7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73';
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 Cobertura encontrada
package main

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

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/Coverage/7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73"

	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 Cobertura encontrada
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/Coverage/7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73")

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 Cobertura encontrada
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/Coverage/7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Cobertura encontrada
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://landing-zone-api.nilo.services/fhir/resources/Coverage/7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Cobertura encontrada
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/Coverage/7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Cobertura encontrada
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/Coverage/7f2b91c4-3d0a-4e8b-9c11-5a6d8e2f0b73")! 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()
```