Matricular numa campanha

Matricula um paciente numa campanha de mensagens já configurada no ambiente. Não programa mensagem avulsa: status tem de ser active, subject.identifier é obrigatório e basedOn precisa trazer exatamente uma campanha existente.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
resourceTypestringRequiredDefaults to CommunicationRequest
Indica o tipo do recurso transacionado.
statusstringRequiredformat: "^[^\s]+(\s[^\s]+)*$"

Na mensagem programada: active enquanto está programada — inclusive atrasada —, completed depois de enviada, revoked quando cancelada, unknown em qualquer outro estado. Na matrícula em campanha: active, completed, revoked ou entered-in-error. Na escrita, só active é aceito.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"
Identificador Nilo FHIR do recurso, usado na leitura por ID.
metaobjectOptional

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

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

asap quando o envio está atrasado, routine no resto. Não é uma prioridade escolhida por ninguém — é um sinal de atraso.

subjectobjectOptional

O paciente que vai receber a mensagem. Obrigatório na escrita, e resolvido só por subject.identifier.

basedOnlist of objectsOptional

Na mensagem programada, o plano de cuidado que a gerou, quando ela veio de uma diretriz — sem reference. Na matrícula em campanha, a campanha, e aí é obrigatório na escrita, com exatamente um item.

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)))?)?)?$"
Quando a mensagem foi programada.
occurrencePeriodobjectOptional

start é quando a mensagem deve ser enviada; end é quando ela foi concluída ou cancelada, e só aparece depois disso.

Response

Paciente matriculado. O corpo é o recurso como ficou gravado, sem envelope — e ele é o recurso da matrícula, mais pobre que o de uma mensagem programada.

resourceTypestringDefaults to CommunicationRequest
Indica o tipo do recurso transacionado.
identifierlist of objectsRead-only
Identificador Nilo da mensagem programada. Este recurso nunca carrega identificadores do seu sistema.
statusstringformat: "^[^\s]+(\s[^\s]+)*$"

Na mensagem programada: active enquanto está programada — inclusive atrasada —, completed depois de enviada, revoked quando cancelada, unknown em qualquer outro estado. Na matrícula em campanha: active, completed, revoked ou entered-in-error. Na escrita, só active é aceito.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"
Identificador Nilo FHIR do recurso, usado na leitura por ID.
metaobjectOptional

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

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

asap quando o envio está atrasado, routine no resto. Não é uma prioridade escolhida por ninguém — é um sinal de atraso.

subjectobjectOptional

O paciente que vai receber a mensagem. Obrigatório na escrita, e resolvido só por subject.identifier.

recipientlist of objectsOptionalRead-only

Repete o subject — é sempre o mesmo paciente, num único item.

categorylist of objectsOptionalRead-only

Um coding cujo code traz um identificador interno da plataforma. Não é contrato — veja o guia.

basedOnlist of objectsOptional

Na mensagem programada, o plano de cuidado que a gerou, quando ela veio de uma diretriz — sem reference. Na matrícula em campanha, a campanha, e aí é obrigatório na escrita, com exatamente um item.

replaceslist of objectsOptionalRead-only

A mensagem programada anterior, quando esta é uma reprogramação.

payloadlist of objectsOptionalRead-only

O texto da mensagem, num único item com contentString. Ausente quando a mensagem não tem conteúdo montado.

notelist of objectsOptionalRead-only

Um único item com um texto de diagnóstico em formato interno. Não é contrato.

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)))?)?)?$"
Quando a mensagem foi programada.
occurrencePeriodobjectOptional

start é quando a mensagem deve ser enviada; end é quando ela foi concluída ou cancelada, e só aparece depois disso.

Errors

400
Bad Request Error
429
Too Many Requests Error