Appointment

Cadastrar ou atualizar

Cria um agendamento ou atualiza um existente, reconhecido pelo identifier. Exige start, end e exatamente um participante paciente e um profissional.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
resourceTypestringRequiredDefaults to Appointment
Indica o tipo do recurso transacionado.
identifierlist of objectsRequired

Suas chaves do agendamento. Obrigatório na escrita: é por elas que a API decide entre criar e atualizar. A leitura devolve o seu identificador ao lado do identificador Nilo, no system .../NamingSystem/care-api--scheduling-v2.

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

Obrigatório. Na escrita, oito valores são aceitos, mas eles colapsam em quatro situações da plataforma — veja o guia. Na leitura, o valor devolvido é o da situação, não o que você enviou.

participantlist of objectsRequired

Obrigatório: exatamente um participante de tipo Patient e um de tipo Practitioner. Nem zero, nem dois de cada.

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

Só resposta: identificador Nilo FHIR do agendamento.

metaobjectOptional

Só resposta: metadados da gravação.

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

Obrigatório na escrita. Início previsto do agendamento. Na leitura pode faltar num agendamento cancelado, cujas datas a plataforma às vezes limpa.

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

Obrigatório na escrita, e tem de ser maior que o start. Na leitura pode faltar num agendamento cancelado.

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

O título do agendamento. Repare que é o description do FHIR que guarda o título — o texto livre vai no comment.

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

Observações do agendamento, em texto livre. Omiti-lo numa atualização apaga a observação na plataforma, mas o recurso preserva o valor anterior — para zerar os dois lados, mande o campo vazio.

appointmentTypeobjectOptional

A modalidade do atendimento. Omitido na escrita, o agendamento nasce online.

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: quando o agendamento foi criado.

Response

Agendamento criado ou atualizado. O corpo é o recurso como ficou gravado, sem envelope.

resourceTypestringDefaults to Appointment
Indica o tipo do recurso transacionado.
identifierlist of objects

Suas chaves do agendamento. Obrigatório na escrita: é por elas que a API decide entre criar e atualizar. A leitura devolve o seu identificador ao lado do identificador Nilo, no system .../NamingSystem/care-api--scheduling-v2.

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

Obrigatório. Na escrita, oito valores são aceitos, mas eles colapsam em quatro situações da plataforma — veja o guia. Na leitura, o valor devolvido é o da situação, não o que você enviou.

participantlist of objects

Obrigatório: exatamente um participante de tipo Patient e um de tipo Practitioner. Nem zero, nem dois de cada.

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

Só resposta: identificador Nilo FHIR do agendamento.

metaobjectOptional

Só resposta: metadados da gravação.

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

Obrigatório na escrita. Início previsto do agendamento. Na leitura pode faltar num agendamento cancelado, cujas datas a plataforma às vezes limpa.

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

Obrigatório na escrita, e tem de ser maior que o start. Na leitura pode faltar num agendamento cancelado.

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

O título do agendamento. Repare que é o description do FHIR que guarda o título — o texto livre vai no comment.

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

Observações do agendamento, em texto livre. Omiti-lo numa atualização apaga a observação na plataforma, mas o recurso preserva o valor anterior — para zerar os dois lados, mande o campo vazio.

appointmentTypeobjectOptional

A modalidade do atendimento. Omitido na escrita, o agendamento nasce online.

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: quando o agendamento foi criado.

containedlist of objectsOptionalRead-only

Só resposta, e só nos agendamentos online com sala criada: um Endpoint cujo address é o link da sala de vídeo. A sala é criada de forma assíncrona, depois da resposta do POST, e depende de a funcionalidade estar habilitada no seu ambiente.

Errors

400
Bad Request Error