Subscription

Criar ou desligar uma assinatura

Cria uma assinatura de webhook, com status: requested, ou desliga uma existente, com status: off. Só o canal rest-hook é suportado.

Authentication

x-api-keystring
API Key authentication via header

Request

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

Obrigatório. Na criação, tem de ser requested. Para desligar uma assinatura, envie off. A leitura devolve também active, depois do aperto de mão, e error, quando ele falhou.

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

Obrigatório. O tipo de recurso a observar — Patient, Encounter —, opcionalmente com parâmetros de busca depois de ?. O tipo tem de ser um recurso FHIR válido.

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

Obrigatório pelo FHIR, e sem efeito na plataforma: o texto é seu. Depois da primeira mudança de situação da assinatura, a leitura passa a devolver -.

channelobjectRequired

Obrigatório. Para onde a notificação vai.

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

Só resposta: identificador Nilo FHIR da assinatura.

metaobjectOptional

Traz, em tag[0].code, o identificador da assinatura na plataforma. Este recurso não tem identifier, e é por essa etiqueta que ele é reencontrado.

contactlist of objectsOptional

Contatos para avisos sobre a assinatura. Só system: email é aceito, e o endereço é validado.

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))$"

Só resposta: preenchido quando a assinatura é desligada.

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

Só resposta: o erro que derrubou o aperto de mão, quando o status é error.

Response

Assinatura criada ou desligada. O corpo é o recurso como ficou gravado, sem envelope.

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

Obrigatório. Na criação, tem de ser requested. Para desligar uma assinatura, envie off. A leitura devolve também active, depois do aperto de mão, e error, quando ele falhou.

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

Obrigatório. O tipo de recurso a observar — Patient, Encounter —, opcionalmente com parâmetros de busca depois de ?. O tipo tem de ser um recurso FHIR válido.

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

Obrigatório pelo FHIR, e sem efeito na plataforma: o texto é seu. Depois da primeira mudança de situação da assinatura, a leitura passa a devolver -.

channelobject

Obrigatório. Para onde a notificação vai.

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

Só resposta: identificador Nilo FHIR da assinatura.

metaobjectOptional

Traz, em tag[0].code, o identificador da assinatura na plataforma. Este recurso não tem identifier, e é por essa etiqueta que ele é reencontrado.

contactlist of objectsOptional

Contatos para avisos sobre a assinatura. Só system: email é aceito, e o endereço é validado.

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))$"

Só resposta: preenchido quando a assinatura é desligada.

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

Só resposta: o erro que derrubou o aperto de mão, quando o status é error.

Errors

400
Bad Request Error