Buscar por ID

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

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Identificador Nilo Fhir do registro que deve ser retornado.

Response

Operação bem sucedida.

beneficiaryobject

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.

payorlist of objects

Entidade pagadora. Obrigatório pelo FHIR R4, mas o conteúdo enviado é descartado: a leitura devolve sempre [{ "display": "Operadora" }].

resourceTypestringDefaults to Coverage
Indica o tipo do recurso transacionado.
statusstringformat: "^[^\s]+(\s[^\s]+)*$"

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.

classlist of objectsOptional

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.

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

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.

extensionlist of objectsOptional

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.

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

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.

identifierlist of objectsOptional

Identificador(es) da cobertura. Ao menos um é obrigatório na escrita: é por ele que a API decide entre criar e atualizar.

metaobjectOptional

Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.

orderdoubleOptional

Ordem de prioridade de uso entre as coberturas do paciente, começando em 1. 0 é recusado.

periodobjectOptional

Vigência do benefício. Envie datas puras (YYYY-MM-DD) — o NiloCare guarda só a data.

policyHolderobjectOptional

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

relationshipobjectOptional

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.

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

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
404
Not Found Error