Coverage

Buscar por parâmetros

Authentication

x-api-keystring
API Key authentication via header

Query parameters

_lastUpdatedlist of stringsOptional

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

_page_tokenstringOptional

Seleciona a página de um resultado paginado.

identifierstringOptional

Identificador da cobertura, na sintaxe system|value. É a busca mais usada: reencontra a cobertura pela chave do seu próprio sistema.

patient:identifierstringOptional
Paciente coberto, pelo **identificador** dele, na sintaxe `system|value`. É o filtro para listar as coberturas de um paciente sem precisar do `id` Nilo FHIR — basta a chave que você já usa no seu sistema. O modificador `:identifier` também vale para `beneficiary`.
patientstringOptional

Paciente coberto, pelo id Nilo FHIR, no formato Patient/{id}. Use patient:identifier quando você tem o identificador do paciente em vez do id.

beneficiarystringOptional

Mesmo campo que patient — Coverage.beneficiary. Os dois nomes são equivalentes no FHIR R4.

statusenumOptional

Situação da cobertura.

Allowed values:
dependentstringOptional

Número da carteirinha gravado em dependent — ou seja, a carteirinha de um beneficiário dependente. A carteirinha de um titular fica em subscriberId, para o qual o FHIR R4 não define parâmetro de busca.

class-valuestringOptional

Id do plano, o mesmo valor enviado em class[0].value.

class-typestringOptional

Tipo da classificação em class[0].type. A Nilo grava sempre plan, então este filtro só separa registros vindos de outra origem.

policy-holderstringOptional

Estipulante. A Nilo grava o estipulante apenas como texto em policyHolder.display, sem referência a um recurso — este filtro casa por referência e por isso raramente encontra algo.

Response

Operação bem sucedida.

resourceTypestringDefaults to Bundle
Indica o tipo do recurso transacionado.
typeenum
Indica a finalidade deste pacote, como ele deve ser usado.
entrylist of objectsOptional
Uma lista de recursos do pacote.

Errors

400
Bad Request Error