Renomear um plano

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.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
resourceTypestringRequiredDefaults to InsurancePlan
Indica o tipo do recurso transacionado.
identifierlist of objectsRequired

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.

namestringRequiredformat: "^[ \r\n\t\S]+$"

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.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"

Só resposta: identificador Nilo FHIR do plano.

metaobjectOptional

Só resposta: metadados da gravação.

Response

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

resourceTypestringDefaults to InsurancePlan
Indica o tipo do recurso transacionado.
identifierlist of objects

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.

namestringformat: "^[ \r\n\t\S]+$"

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.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"

Só resposta: identificador Nilo FHIR do plano.

metaobjectOptional

Só resposta: metadados da gravação.

statusenumOptionalRead-only

Só resposta: active num plano em uso, retired num plano desativado. A situação é definida pela plataforma; enviá-la não muda nada.

Errors

400
Bad Request Error