Cadastrar ou atualizar

Aplica uma etiqueta a um paciente, ou atualiza uma já aplicada. A etiqueta vem do catálogo do ambiente; status e period têm de concordar entre si.

Authentication

x-api-keystring
API Key authentication via header

Request

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

Suas chaves da etiqueta aplicada. Obrigatório na escrita: é por elas que a API decide entre criar e atualizar.

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

Obrigatório, e tem de concordar com o period: active numa etiqueta vigente hoje, inactive numa que ainda não começou ou já terminou. Divergência entre os dois recusa a chamada. entered-in-error é aceito por conformidade e tratado exatamente como inactive; a leitura nunca o devolve. O valor é calculado na gravação e não é recalculado depois.

codeobjectRequired

Obrigatório. A etiqueta, por um código do catálogo de etiquetas do ambiente.

subjectobjectRequired

Obrigatório. O paciente que recebe a etiqueta.

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

Só resposta: identificador Nilo FHIR da etiqueta aplicada.

metaobjectOptional

Só resposta: metadados da gravação.

categorylist of objectsOptional

A categoria da etiqueta. Opcional na escrita — e, quando enviada, é conferida contra a categoria à qual a etiqueta pertence. Na leitura vem sempre, derivada da etiqueta.

periodobjectOptional

A vigência da etiqueta. Omitido numa etiqueta active, a plataforma decide o período; omitido numa inactive que ainda não existe, a chamada é recusada.

Response

Etiqueta aplicada ou atualizada. O corpo é o recurso como ficou gravado, sem envelope.

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

Suas chaves da etiqueta aplicada. Obrigatório na escrita: é por elas que a API decide entre criar e atualizar.

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

Obrigatório, e tem de concordar com o period: active numa etiqueta vigente hoje, inactive numa que ainda não começou ou já terminou. Divergência entre os dois recusa a chamada. entered-in-error é aceito por conformidade e tratado exatamente como inactive; a leitura nunca o devolve. O valor é calculado na gravação e não é recalculado depois.

codeobject

Obrigatório. A etiqueta, por um código do catálogo de etiquetas do ambiente.

subjectobject

Obrigatório. O paciente que recebe a etiqueta.

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

Só resposta: identificador Nilo FHIR da etiqueta aplicada.

metaobjectOptional

Só resposta: metadados da gravação.

categorylist of objectsOptional

A categoria da etiqueta. Opcional na escrita — e, quando enviada, é conferida contra a categoria à qual a etiqueta pertence. Na leitura vem sempre, derivada da etiqueta.

periodobjectOptional

A vigência da etiqueta. Omitido numa etiqueta active, a plataforma decide o período; omitido numa inactive que ainda não existe, a chamada é recusada.

Errors

400
Bad Request Error