Cadastrar ou atualizar
Authentication
Request
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.
Entidade pagadora. Obrigatório pelo FHIR R4, mas o conteúdo enviado é descartado: a leitura devolve sempre [{ "display": "Operadora" }].
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.
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.
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.
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.
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.
Identificador(es) da cobertura. Ao menos um é obrigatório na escrita: é por ele que a API decide entre criar e atualizar.
Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.
Ordem de prioridade de uso entre as coberturas do paciente, começando em 1. 0 é recusado.
Vigência do benefício. Envie datas puras (YYYY-MM-DD) — o NiloCare guarda só a data.
Estipulante — dono da apólice do benefício. Só o display é lido, em texto livre; não precisa apontar para um recurso.
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.
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.
Response
Operação bem sucedida.
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.
Entidade pagadora. Obrigatório pelo FHIR R4, mas o conteúdo enviado é descartado: a leitura devolve sempre [{ "display": "Operadora" }].
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.
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.
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.
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.
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.
Identificador(es) da cobertura. Ao menos um é obrigatório na escrita: é por ele que a API decide entre criar e atualizar.
Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.
Ordem de prioridade de uso entre as coberturas do paciente, começando em 1. 0 é recusado.
Vigência do benefício. Envie datas puras (YYYY-MM-DD) — o NiloCare guarda só a data.
Estipulante — dono da apólice do benefício. Só o display é lido, em texto livre; não precisa apontar para um recurso.
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.
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.