Pular para o conteúdo principal

Cadastrar/atualizar

Endpoint

POST /fhir/resources/CommunicationRequest

Autenticação🔓 Chave de API
StatusImplementado

Modelagem da API - Request​

OpçãoTipoRequeridoDescriçãoExemplo
x-api-keystringSim

Chave de autenticação do cliente, fornecida durante a configuração do ambiente.

Content-TypestringSimapplication/json


Exemplo de requisição CURL

curl --request POST \
--url https://landing-zone-api.nilo.services/fhir/resources/CommunicationRequest \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '{
"resourceType": "CommunicationRequest",
"identifier": [
  {
    "use": "usual",
    "system": "https://sistemadocliente.com/campanha-paciente",
    "value": "9960"
  }
],
"basedOn": [
  {
    "identifier": {
      "use": "usual",
      "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/jaiminho-api--campaign",
      "value": "2564"
    }
  }
],
"status": "active",
"subject": {
  "identifier": {
    "use": "usual",
    "system": "https://sistemadocliente.com/pacientes",
    "value": "2146"
  }
}
}'


Modelagem da API - Response​

Operação bem sucedida.

resourceType
any
Value: "CommunicationRequest"
id
string (id) ^[A-Za-z0-9\-\.]{{1,64}}$

Qualquer combinação de letras, números, "-" e ".", com um limite de 64 caracteres. (Pode ser um número inteiro, um OID não prefixado, UUID ou qualquer outro padrão de identificador que atenda a essas restrições.) Os IDs não diferenciam maiúsculas de minúsculas.

object (Meta)

Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.

implicitRules
string (uri) ^\S*$

Uma referência de identificador de recurso uniforme (RFC 3986) usado como "namespace".

language
string (code) ^[^\s]+(\s[^\s]+)*$

Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.

object (Narrative)
Array of objects (Resource)
Array of objects (Extension)
Array of objects (Extension)
Array of objects (Identifier)
required
Array of objects (Reference)

identificador da campanha que vai ser enviada. Um array com apenas um item.

Array of objects (Reference)
object (Identifier)

Um identificador, código que identifica alguma entidade de forma única e inequívoca. Normalmente, isso é usado para identificadores de negócios.

status
required
string
Enum: "draft" "active" "on-hold" "revoked" "completed" "entered-in-error" "unknown"

Somente active é suportado.

object (CodeableConcept)

Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde.

Array of objects (CodeableConcept)
priority
string (code) ^[^\s]+(\s[^\s]+)*$

Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.

doNotPerform
boolean (boolean) ^true|false$

Valor de "verdadeiro" ou "falso".

Array of objects (CodeableConcept)
required
object (Reference)

O identifier do paciente que vai receber a campanha.

Array of objects (Reference)
object (Reference)

Uma referência de um recurso para outro.

Array of objects (CommunicationRequest_Payload)
occurrenceDateTime
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...
object (Period)

Um intervalo de tempo definido por uma data de início e término e, opcionalmente, horas para ambos.

authoredOn
string (dateTime) ^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Uma data, data-hora ou data parcial (por exemplo, apenas ano ou ano + mês).

object (Reference)

Uma referência de um recurso para outro.

Array of objects (Reference)
object (Reference)

Uma referência de um recurso para outro.

Array of objects (CodeableConcept)
Array of objects (Reference)
Array of objects (Annotation)
{
  • "resourceType": "CommunicationRequest",
  • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
  • "meta": {
    },
  • "implicitRules": "string",
  • "language": "string",
  • "text": {
    },
  • "contained": [
    ],
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "basedOn": [
    ],
  • "replaces": [
    ],
  • "groupIdentifier": {
    },
  • "status": "draft",
  • "statusReason": {
    },
  • "category": [
    ],
  • "priority": "string",
  • "doNotPerform": true,
  • "medium": [
    ],
  • "subject": {
    },
  • "about": [
    ],
  • "encounter": {
    },
  • "payload": [
    ],
  • "occurrenceDateTime": "string",
  • "occurrencePeriod": {
    },
  • "authoredOn": "2022-05-23T19:00:00+00:00",
  • "requester": {
    },
  • "recipient": [
    ],
  • "sender": {
    },
  • "reasonCode": [
    ],
  • "reasonReference": [
    ],
  • "note": [
    ]
}