Cadastrar ou atualizar

Aplica uma diretriz a um paciente, e atualiza o plano quando ele já existe. O `status` enviado é o que decide: `draft` põe o paciente na fila de alocação, `active` aplica a diretriz na hora, e `completed`, `revoked` ou `entered-in-error` encerram um plano já existente. O plano é reconhecido pelo `identifier`; sem nenhum que case, o reconhecimento cai no par `subject` + `instantiatesCanonical`.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
instantiatesCanonicallist of stringsRequired

A diretriz a aplicar, pela URL do PlanDefinition correspondente. Só o primeiro item da lista é lido. A diretriz precisa estar ativa e dentro da vigência.

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

Exigido pelo FHIR R4 e não lido pela Nilo: o valor não escolhe modo de aplicação nem nível de autoridade. Envie order, que é o valor que todas as leituras trazem.

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

Na escrita, escolhe o que acontece. draft põe o paciente na fila de alocação e cria apenas o recurso FHIR; active aplica a diretriz na hora; completed encerra o plano como concluído; revoked e entered-in-error cancelam o plano e as atividades futuras; on-hold devolve o plano ao estado pendente. Um plano revoked ou completed não aceita mais nenhuma atualização. Na leitura, é a situação do plano na plataforma — e é só aí que aparece unknown, que a escrita recusa.

subjectobjectRequired

Paciente que recebe o plano, por um identificador dele. type tem de ser Patient, e o paciente precisa já existir e estar ativo.

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

Só resposta: data em que o plano do paciente foi criado, sem hora.

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

Só resposta: descrição da diretriz aplicada.

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

Só resposta: o identificador Nilo FHIR do recurso.

identifierlist of objectsOptional

Identificadores do plano. É por aqui que a escrita reconhece um plano já existente; sem nenhum, o reconhecimento cai no par paciente + diretriz.

metaobjectOptional

Só resposta: metadados da gravação no store FHIR.

periodobjectOptional

Só resposta: início e fim da aplicação da diretriz ao paciente.

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

Só resposta: nome da diretriz aplicada.

Response

Operação bem sucedida.

instantiatesCanonicallist of strings

A diretriz a aplicar, pela URL do PlanDefinition correspondente. Só o primeiro item da lista é lido. A diretriz precisa estar ativa e dentro da vigência.

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

Exigido pelo FHIR R4 e não lido pela Nilo: o valor não escolhe modo de aplicação nem nível de autoridade. Envie order, que é o valor que todas as leituras trazem.

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

Na escrita, escolhe o que acontece. draft põe o paciente na fila de alocação e cria apenas o recurso FHIR; active aplica a diretriz na hora; completed encerra o plano como concluído; revoked e entered-in-error cancelam o plano e as atividades futuras; on-hold devolve o plano ao estado pendente. Um plano revoked ou completed não aceita mais nenhuma atualização. Na leitura, é a situação do plano na plataforma — e é só aí que aparece unknown, que a escrita recusa.

subjectobject

Paciente que recebe o plano, por um identificador dele. type tem de ser Patient, e o paciente precisa já existir e estar ativo.

activitylist of objectsOptionalRead-only

Só resposta. Itens gerados pela diretriz para este paciente: consultas previstas, tarefas, questionários e mensagens programadas. Um plano ainda na fila de alocação volta sem esta lista.

categorylist of objectsOptionalRead-only

Só resposta. Tipo da diretriz aplicada, em texto livre: care_line para linha de cuidado e protocol para protocolo. Não vem com coding.

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

Só resposta: data em que o plano do paciente foi criado, sem hora.

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

Só resposta: descrição da diretriz aplicada.

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

Só resposta: o identificador Nilo FHIR do recurso.

identifierlist of objectsOptional

Identificadores do plano. É por aqui que a escrita reconhece um plano já existente; sem nenhum, o reconhecimento cai no par paciente + diretriz.

metaobjectOptional

Só resposta: metadados da gravação no store FHIR.

notelist of objectsOptionalRead-only

Só resposta. Aparece apenas quando a aplicação em massa da diretriz falhou para este paciente: traz o motivo da falha, e o plano vem com status igual a entered-in-error.

periodobjectOptional

Só resposta: início e fim da aplicação da diretriz ao paciente.

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

Só resposta: nome da diretriz aplicada.

Errors

400
Bad Request Error
429
Too Many Requests Error