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

# Renomear um plano

POST https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan
Content-Type: application/json

Altera o nome de um plano **já existente** no catálogo, encontrado pelo `identifier`. O `name` é o único dado gravado; `status` e o resto do payload são descartados. Planos novos não são criados por esta API — o catálogo é montado na implantação.

Reference: https://api-docs.nilo.services/referencia/endpoints/insurance-plan/insurance-plan-update

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

### Body (application/json)

This endpoint expects an InsurancePlan.

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

## Response

### 200

Plano alterado. O corpo é o recurso como ficou gravado, sem envelope.

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

## Errors

### 400 Bad Request Error

Rejeitado. O corpo é um `OperationOutcome`; quando a recusa é de um campo conferido por esta API, ele vem em `issue[].expression`.

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

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

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

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

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

### Plano gravado

**Response**

```json
{
  "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 Plus",
  "id": "61a4c8d2-9e35-47bb-a0f1-2c7d5e8b3f90",
  "meta": {
    "lastUpdated": "2026-08-24T12:04:18.911000Z",
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
  },
  "status": "active"
}
```

**SDK Code**

```python Plano gravado
import requests

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

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

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

print(response.json())
```

```javascript Plano gravado
const url = 'https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan';
const options = {method: 'POST', 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 Plano gravado
package main

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

func main() {

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

	req, _ := http.NewRequest("POST", 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 Plano gravado
require 'uri'
require 'net/http'

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

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

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

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

```java Plano gravado
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Plano gravado
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Plano gravado
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Plano gravado
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```

### Renomear um plano

**Request**

```json
{
  "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 Plus"
}
```

**Response**

```json
{
  "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 Plus",
  "id": "61a4c8d2-9e35-47bb-a0f1-2c7d5e8b3f90",
  "meta": {
    "lastUpdated": "2026-08-24T12:04:18.911000Z",
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
  },
  "status": "active"
}
```

**SDK Code**

```python Renomear um plano
import requests

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

payload = {
    "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 Plus"
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Renomear um plano
const url = 'https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"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 Plus"}'
};

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

```go Renomear um plano
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"resourceType\": \"InsurancePlan\",\n  \"identifier\": [\n    {\n      \"system\": \"https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2\",\n      \"value\": \"2481\",\n      \"use\": \"usual\"\n    }\n  ],\n  \"name\": \"Acme Saúde Ambulatorial Plus\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

```ruby Renomear um plano
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resourceType\": \"InsurancePlan\",\n  \"identifier\": [\n    {\n      \"system\": \"https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2\",\n      \"value\": \"2481\",\n      \"use\": \"usual\"\n    }\n  ],\n  \"name\": \"Acme Saúde Ambulatorial Plus\"\n}"

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

```java Renomear um plano
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resourceType\": \"InsurancePlan\",\n  \"identifier\": [\n    {\n      \"system\": \"https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2\",\n      \"value\": \"2481\",\n      \"use\": \"usual\"\n    }\n  ],\n  \"name\": \"Acme Saúde Ambulatorial Plus\"\n}")
  .asString();
```

```php Renomear um plano
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan', [
  'body' => '{
  "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 Plus"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Renomear um plano
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"resourceType\": \"InsurancePlan\",\n  \"identifier\": [\n    {\n      \"system\": \"https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--insurance-v2\",\n      \"value\": \"2481\",\n      \"use\": \"usual\"\n    }\n  ],\n  \"name\": \"Acme Saúde Ambulatorial Plus\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Renomear um plano
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "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 Plus"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/InsurancePlan")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```