Buscar por ID

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.

identifierlist of objects

Conjunto de identificadores do profissional (chave no seu sistema, e-mail, CPF, registro em conselho, ids Nilo). Ao menos um é obrigatório. Só os system habilitados para a sua unidade de cuidado na implantação decidem entre criar e atualizar; um payload em que nenhum identificador use um desses system é recusado. O e-mail usa o system urn:ietf:rfc:6530, o CPF usa https://servicos.receita.fazenda.gov.br/servicos/cpf/ e o registro em conselho usa {host}/fhir/resources/NamingSystem/NiloClassCouncil/, com o valor no formato conselho-UF-número.

namelist of objects

Nomes do profissional. É obrigatório um item com use: official — dele sai o nome cadastrado, de text ou da junção de given e family. Itens com outro use são ignorados. A leitura devolve um único nome, sempre em text.

resourceTypestringDefaults to Practitioner
Indica o tipo do recurso transacionado.
activebooleanOptional

Se o cadastro do profissional está em uso ativo. A leitura devolve sempre true — a Nilo não expõe profissional inativo por este recurso. Enviado na requisição, é ignorado.

addresslist of objectsOptional

Locais de atendimento do profissional. Apenas os itens com use: work são considerados; os demais são ignorados. O logradouro é lido de line, nesta ordem: line[0] rua, line[1] número (S/N quando ausente) e line[2] complemento. Os endereços de trabalho que estavam gravados e não vêm no payload são desvinculados do profissional.

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 do profissional para fins de registro. male, female e other são preservados; qualquer outro valor, ou a ausência do campo, é gravado como não informado e lido como unknown.

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.

metaobjectOptional

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

qualificationlist of objectsOptional

Especialidades do profissional, uma por item. Cada item precisa de um coding com o system do CBO (http://www.saude.gov.br/fhir/r4/CodeSystem/BRCBO) e um código existente no catálogo. period.end no passado encerra a especialidade.

telecomlist of objectsOptional

Contatos do profissional. Somente o item com system: phone é lido, e havendo mais de um vale o último. A leitura devolve o telefone com use: mobile. E-mail não vai aqui — vai em identifier, no system urn:ietf:rfc:6530.

Errors

400
Bad Request Error
404
Not Found Error