Skip to navigation

Cadastrar ou atualizar

Cria uma tarefa da equipe de cuidado ou atualiza uma existente, reconhecida pelo identifier. Exige description, for, owner e o prazo em restriction.period.end. Com a extensão task-recurrence, a criação gera uma série de tarefas recorrentes.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
descriptionstringRequiredformat: "^[ \r\n\t\S]+$"

O que deve ser feito. Na tarefa da equipe é o texto escrito por quem a criou; no questionário do paciente é o nome do questionário, ou a palavra Questionário quando o nome não está disponível. Obrigatório na escrita.

forobjectRequired

O paciente a que a tarefa se refere. Obrigatório na escrita.

identifierlist of objectsRequired

Identificadores da tarefa. O identificador Nilo diz de qual das duas origens ela vem: …/NamingSystem/cogsworth-api--to-do na tarefa da equipe e …/NamingSystem/hippocrates-api--patient-questionnaire no questionário do paciente. Na escrita, o identificador do seu sistema é obrigatório e é a chave da atualização; ele volta ao lado do identificador Nilo.

intentstringRequiredformat: "^[^\s]+(\s[^\s]+)*$"

Constante order. Não distingue nada e não vale filtrar por ele. Na escrita, qualquer outro valor é recusado.

resourceTypestringRequiredDefaults to Task
Indica o tipo do recurso transacionado.
statusstringRequiredformat: "^[^\s]+(\s[^\s]+)*$"

O andamento da tarefa. Só três dos valores do FHIR são produzidos, e não há como distinguir uma tarefa cancelada de uma tarefa aberta. Na escrita são os mesmos três valores, e mudá-lo muda o andamento no NiloCare. Uma série recorrente só pode nascer requested.

authoredOnstringOptionalformat: "^([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)))?)?)?$"

Data de criação da tarefa, sem hora. Só na tarefa da equipe — o questionário do paciente não traz este campo.

codeobjectOptional

O que a tarefa é, em text e sem coding. Na tarefa da equipe é o tipo de tarefa configurado pelo cliente; no questionário do paciente é a constante patient-questionnaire. Na escrita, text precisa ser igual ao nome de um tipo de tarefa ativo no NiloCare; sem code, a tarefa fica sem tipo.

executionPeriodobjectOptional

Na tarefa da equipe, start repete a data de criação e end só existe depois de concluída — datas sem hora. No questionário do paciente é o período de vigência, com hora, e end pode vir antes de o questionário ser respondido. Não é o prazo da tarefa da equipe: esse está em restriction.period.end. Na escrita só end é lido, e só com status: completed, como o momento da conclusão.

extensionlist of objectsOptional

Na tarefa da equipe, a recorrência da série a que ela pertence: um item com url …/StructureDefinition/task-recurrence e a regra em valueString, no formato RRULE do RFC 5545 (por exemplo, FREQ=WEEKLY;BYDAY=MO,WE;COUNT=6). Na escrita, só é lida na criação — enviada com uma tarefa que já existe, é ignorada. Na leitura, a regra volta com o início da série em DTSTART e o fim em UNTIL, os dois em UTC com hora; um COUNT enviado volta convertido em UNTIL. Pode vir em mais de um item, e some quando a série é encerrada.

groupIdentifierobjectOptional

Na tarefa da equipe que faz parte de uma série, o identificador Nilo da série (…/NamingSystem/cogsworth-api--to-do-generator). Todas as ocorrências da série têm o mesmo valor. Ausente na tarefa avulsa e no questionário do paciente. Enviado na escrita, é ignorado.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"
Identificador Nilo FHIR do recurso, usado na leitura por ID.
lastModifiedstringOptionalformat: "^([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)))?)?)?$"

Última alteração da tarefa. Na tarefa da equipe vem só a data; no questionário do paciente vem data e hora.

metaobjectOptional

Metadados da gravação no store — versão e data da última alteração.

ownerobjectOptional

O profissional responsável por executar a tarefa. Só na tarefa da equipe — o questionário do paciente não traz responsável, mesmo quando a plataforma tem um. Obrigatório na escrita.

prioritystringOptionalformat: "^[^\s]+(\s[^\s]+)*$"

A prioridade da tarefa. Só na tarefa da equipe. A correspondência com os níveis da plataforma não é a que o nome do código sugere — veja a página do guia. Na escrita, routine grava a prioridade Baixa; sem priority, uma tarefa nova nasce Normal e uma existente mantém a que tem.

requesterobjectOptional

O profissional que solicitou a tarefa. Só na tarefa da equipe, e ausente nas criadas automaticamente por uma diretriz. Opcional na escrita.

restrictionobjectOptional

O prazo da tarefa, em period.end. Só na tarefa da equipe. period.start nunca vem preenchido. Obrigatório na escrita; na criação de uma série é a data da primeira ocorrência.

Response

Tarefa criada ou atualizada. O corpo é o recurso como ficou gravado, sem envelope. Na série recorrente, é a primeira ocorrência.

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

O que deve ser feito. Na tarefa da equipe é o texto escrito por quem a criou; no questionário do paciente é o nome do questionário, ou a palavra Questionário quando o nome não está disponível. Obrigatório na escrita.

forobject

O paciente a que a tarefa se refere. Obrigatório na escrita.

identifierlist of objects

Identificadores da tarefa. O identificador Nilo diz de qual das duas origens ela vem: …/NamingSystem/cogsworth-api--to-do na tarefa da equipe e …/NamingSystem/hippocrates-api--patient-questionnaire no questionário do paciente. Na escrita, o identificador do seu sistema é obrigatório e é a chave da atualização; ele volta ao lado do identificador Nilo.

intentstringformat: "^[^\s]+(\s[^\s]+)*$"

Constante order. Não distingue nada e não vale filtrar por ele. Na escrita, qualquer outro valor é recusado.

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

O andamento da tarefa. Só três dos valores do FHIR são produzidos, e não há como distinguir uma tarefa cancelada de uma tarefa aberta. Na escrita são os mesmos três valores, e mudá-lo muda o andamento no NiloCare. Uma série recorrente só pode nascer requested.

authoredOnstringOptionalformat: "^([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)))?)?)?$"

Data de criação da tarefa, sem hora. Só na tarefa da equipe — o questionário do paciente não traz este campo.

codeobjectOptional

O que a tarefa é, em text e sem coding. Na tarefa da equipe é o tipo de tarefa configurado pelo cliente; no questionário do paciente é a constante patient-questionnaire. Na escrita, text precisa ser igual ao nome de um tipo de tarefa ativo no NiloCare; sem code, a tarefa fica sem tipo.

executionPeriodobjectOptional

Na tarefa da equipe, start repete a data de criação e end só existe depois de concluída — datas sem hora. No questionário do paciente é o período de vigência, com hora, e end pode vir antes de o questionário ser respondido. Não é o prazo da tarefa da equipe: esse está em restriction.period.end. Na escrita só end é lido, e só com status: completed, como o momento da conclusão.

extensionlist of objectsOptional

Na tarefa da equipe, a recorrência da série a que ela pertence: um item com url …/StructureDefinition/task-recurrence e a regra em valueString, no formato RRULE do RFC 5545 (por exemplo, FREQ=WEEKLY;BYDAY=MO,WE;COUNT=6). Na escrita, só é lida na criação — enviada com uma tarefa que já existe, é ignorada. Na leitura, a regra volta com o início da série em DTSTART e o fim em UNTIL, os dois em UTC com hora; um COUNT enviado volta convertido em UNTIL. Pode vir em mais de um item, e some quando a série é encerrada.

groupIdentifierobjectOptional

Na tarefa da equipe que faz parte de uma série, o identificador Nilo da série (…/NamingSystem/cogsworth-api--to-do-generator). Todas as ocorrências da série têm o mesmo valor. Ausente na tarefa avulsa e no questionário do paciente. Enviado na escrita, é ignorado.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"
Identificador Nilo FHIR do recurso, usado na leitura por ID.
lastModifiedstringOptionalformat: "^([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)))?)?)?$"

Última alteração da tarefa. Na tarefa da equipe vem só a data; no questionário do paciente vem data e hora.

metaobjectOptional

Metadados da gravação no store — versão e data da última alteração.

notelist of objectsOptionalRead-only

As anotações de andamento da tarefa, uma por item, com o texto em text e o momento em time — este com data e hora, ao contrário das outras datas desta origem. Só na tarefa da equipe.

outputlist of objectsOptionalRead-only

O questionário atribuído e a resposta dele, um item cada, distinguidos por type.text (questionnaire e questionnaire-response). Só no questionário do paciente, e ausente enquanto não houver nenhum dos dois.

ownerobjectOptional

O profissional responsável por executar a tarefa. Só na tarefa da equipe — o questionário do paciente não traz responsável, mesmo quando a plataforma tem um. Obrigatório na escrita.

performerTypelist of objectsOptionalRead-only

A especialidade do responsável, em text e sem coding. Vem em um único item, com a primeira especialidade dele. Só na tarefa da equipe.

prioritystringOptionalformat: "^[^\s]+(\s[^\s]+)*$"

A prioridade da tarefa. Só na tarefa da equipe. A correspondência com os níveis da plataforma não é a que o nome do código sugere — veja a página do guia. Na escrita, routine grava a prioridade Baixa; sem priority, uma tarefa nova nasce Normal e uma existente mantém a que tem.

requesterobjectOptional

O profissional que solicitou a tarefa. Só na tarefa da equipe, e ausente nas criadas automaticamente por uma diretriz. Opcional na escrita.

restrictionobjectOptional

O prazo da tarefa, em period.end. Só na tarefa da equipe. period.start nunca vem preenchido. Obrigatório na escrita; na criação de uma série é a data da primeira ocorrência.

Errors

400
Bad Request Error