Insurance Plan

Buscar por parâmetros

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.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

identifierstringOptional

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.

namestringOptional
Parte do nome do plano.
statusenumOptional

Situação do plano: active num plano em uso, retired num plano desativado.

Allowed values:
_countintegerOptional

Quantidade de registros por página.

_lastUpdatedlist of stringsOptional

Data de última alteração dos registros que devem ser retornado.

_page_tokenstringOptional

Seleciona a página de um resultado paginado.

Response

Operação bem sucedida.

resourceTypestringDefaults to Bundle
Indica o tipo do recurso transacionado.
typeenum

Constante searchset neste endpoint.

entrylist of objectsOptional

Uma entrada por plano encontrado. Vazia quando não há resultados.

Errors

400
Bad Request Error