Cadastrar ou atualizar

Cria o paciente quando nenhum `identifier` enviado casa com um cadastro existente, e atualiza o cadastro encontrado caso contrário. A atualização é parcial: campo ausente ou nulo preserva o valor atual, de modo que não há como apagar um dado já gravado por esta rota. A exceção é `gender`: omitido, ele grava `other` por cima do sexo atual em vez de preservá-lo. Reenvie-o em toda atualização, mesmo quando o alvo da escrita for outro campo.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
identifierlist of objectsRequired

Conjunto de identificadores do paciente (CPF, chave no seu sistema, ids Nilo). Ao menos um é obrigatório, e o system enviado precisa estar entre os namespaces habilitados para a sua unidade de cuidado na implantação — é por ele que a Nilo decide se cria um paciente novo ou atualiza um existente. O CPF usa o system https://servicos.receita.fazenda.gov.br/servicos/cpf/ e deve ter exatamente 11 dígitos.

resourceTypestringRequiredDefaults to Patient
Indica o tipo do recurso transacionado.
activebooleanOptional

Se o cadastro do paciente está em uso ativo. Traduz para o status do paciente no NiloCare conforme os padrões da unidade de cuidado. Se você também enviar a extensão patient-status, os dois precisam concordar.

addresslist of objectsOptional

Endereço residencial do paciente. Apenas o primeiro item é considerado. O logradouro é lido de line, nesta ordem: line[0] rua, line[1] número (S/N quando ausente) e line[2] complemento.

birthDatestringOptionalformat: "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$"

A data de nascimento do indivíduo.

containedlist of objectsOptional

Grupos a que o paciente pertence, enviados como recursos contidos. Cada Group precisa já existir — a escrita é recusada se algum identificador não for encontrado. Use contained quando o paciente pertence a mais de um grupo; não combine com as extensões de grupo.

deceasedDateTimestringOptionalformat: "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$"

A data e hora do falecimento do indivíduo.

extensionlist of objectsOptional

Informações adicionais que não fazem parte da definição básica do recurso. Abaixo estão as extensões usadas no contexto Nilo; extensões externas a esse contexto são ignoradas.

genderenumOptional

Sexo administrativo do paciente. Apenas male e female são gravados como enviados; other e unknown são gravados como other. Para identidade de gênero, use a extensão patient-genderIdentity.

Único campo do recurso que não segue a regra da atualização parcial: omitido, grava other por cima do sexo atual em vez de preservá-lo. Reenvie-o em toda escrita. Na leitura ele nunca vem nulo.

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

Só resposta: id do paciente no store FHIR, atribuído pela Nilo. É por ele que se faz a leitura direta. Enviado na requisição, é ignorado.

managingOrganizationobjectOptional

Unidade de cuidado responsável pelo paciente. Precisa referenciar uma unidade já cadastrada. Se omitida, vale a unidade que o paciente já tem ou, na criação, a unidade padrão do care provider.

maritalStatusobjectOptional

Estado civil do paciente. Reconhece os códigos S, M, D e W de v3-MaritalStatus e UNK de v3-NullFlavor; qualquer outro código é gravado como UNK.

metaobjectOptional

Só resposta: versão e data da última alteração do recurso no store FHIR.

namelist of objectsOptional

Nomes do paciente. É obrigatório um item com use: official no cadastro — dele sai o nome legal, de text ou da junção de given e family. Um item com use: usual vira o nome social; preencher period.end nele apaga o nome social.

telecomlist of objectsOptional

Contatos do paciente. O telefone passa por validação de elegibilidade para WhatsApp e um número reprovado recusa a escrita — a menos que venha com use: old ou use: temp, casos em que é apenas descartado. Envie assim os números de baixa confiança, para não sobrescrever um contato mais atual.

Response

Operação bem sucedida.

identifierlist of objects

Conjunto de identificadores do paciente (CPF, chave no seu sistema, ids Nilo). Ao menos um é obrigatório, e o system enviado precisa estar entre os namespaces habilitados para a sua unidade de cuidado na implantação — é por ele que a Nilo decide se cria um paciente novo ou atualiza um existente. O CPF usa o system https://servicos.receita.fazenda.gov.br/servicos/cpf/ e deve ter exatamente 11 dígitos.

resourceTypestringDefaults to Patient
Indica o tipo do recurso transacionado.
activebooleanOptional

Se o cadastro do paciente está em uso ativo. Traduz para o status do paciente no NiloCare conforme os padrões da unidade de cuidado. Se você também enviar a extensão patient-status, os dois precisam concordar.

addresslist of objectsOptional

Endereço residencial do paciente. Apenas o primeiro item é considerado. O logradouro é lido de line, nesta ordem: line[0] rua, line[1] número (S/N quando ausente) e line[2] complemento.

birthDatestringOptionalformat: "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$"

A data de nascimento do indivíduo.

containedlist of objectsOptional

Grupos a que o paciente pertence, enviados como recursos contidos. Cada Group precisa já existir — a escrita é recusada se algum identificador não for encontrado. Use contained quando o paciente pertence a mais de um grupo; não combine com as extensões de grupo.

communicationlist of objectsOptionalRead-only

Idioma de comunicação com o paciente. Devolvido sempre como pt-BR; enviado na requisição, é ignorado.

deceasedDateTimestringOptionalformat: "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$"

A data e hora do falecimento do indivíduo.

extensionlist of objectsOptional

Informações adicionais que não fazem parte da definição básica do recurso. Abaixo estão as extensões usadas no contexto Nilo; extensões externas a esse contexto são ignoradas.

genderenumOptional

Sexo administrativo do paciente. Apenas male e female são gravados como enviados; other e unknown são gravados como other. Para identidade de gênero, use a extensão patient-genderIdentity.

Único campo do recurso que não segue a regra da atualização parcial: omitido, grava other por cima do sexo atual em vez de preservá-lo. Reenvie-o em toda escrita. Na leitura ele nunca vem nulo.

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

Só resposta: id do paciente no store FHIR, atribuído pela Nilo. É por ele que se faz a leitura direta. Enviado na requisição, é ignorado.

managingOrganizationobjectOptional

Unidade de cuidado responsável pelo paciente. Precisa referenciar uma unidade já cadastrada. Se omitida, vale a unidade que o paciente já tem ou, na criação, a unidade padrão do care provider.

maritalStatusobjectOptional

Estado civil do paciente. Reconhece os códigos S, M, D e W de v3-MaritalStatus e UNK de v3-NullFlavor; qualquer outro código é gravado como UNK.

metaobjectOptional

Só resposta: versão e data da última alteração do recurso no store FHIR.

namelist of objectsOptional

Nomes do paciente. É obrigatório um item com use: official no cadastro — dele sai o nome legal, de text ou da junção de given e family. Um item com use: usual vira o nome social; preencher period.end nele apaga o nome social.

telecomlist of objectsOptional

Contatos do paciente. O telefone passa por validação de elegibilidade para WhatsApp e um número reprovado recusa a escrita — a menos que venha com use: old ou use: temp, casos em que é apenas descartado. Envie assim os números de baixa confiança, para não sobrescrever um contato mais atual.

Errors

400
Bad Request Error
409
Conflict Error
429
Too Many Requests Error