Pular para o conteúdo principal

Cadastrar/atualizar

Endpoint

POST /fhir/resources/Appointment

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/Appointment \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '{
  "resourceType": "Appointment",
  "identifier": [
      {
          "use": "usual",
          "system": "https://sistemadocliente.com/agendamentos",
          "value": "7736"
      }
  ],
  "status": "waitlist",
  "description": "Descição do agendamento",
  "start": "2024-09-28T20:32:56.528762+00:00",
  "end": "2024-09-28T21:02:56.528762+00:00",
  "created": "2024-09-27T20:30:56.528762+00:00",
  "comment": "Comentários sobre o agendamento",
  "participant": [
      {
          "actor": {
              "type": "Patient",
              "identifier": {
                  "system": "https://sistemadocliente.com/pacientes",
                  "value": "152"
              }
          },
          "status": "accepted"
      },
      {
          "actor": {
              "type": "Practitioner",
              "identifier": {
                  "system": "https://sistemadocliente.com/profissionais",
                  "use": "usual",
                  "value": "2027"
              }
          },
          "status": "accepted"
      }
  ]
}'


Modelagem da API - Response​

Operação bem sucedida.

resourceType
required
any
Value: "Appointment"
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)
required
Array of objects (Identifier)

identificador único para o Appointment.

status
required
any
Enum: "proposed" "pending" "booked" "arrived" "fulfilled" "cancelled" "noshow" "entered-in-error" "checked-in" "waitlist"
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)
Array of objects (CodeableConcept)
Array of objects (CodeableConcept)
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)
Array of objects (Reference)
priority
number (unsignedInt) ^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

description
string (string) ^[ \r\n\t\S]+$

Título da agenda

Array of objects (Reference)
start
required
string (instant) ^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Date/Time que o atendimento deve ocorrer

end
required
string (instant) ^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Date/Time que o atendimento deve terminar.

minutesDuration
number (positiveInt) ^[1-9][0-9]*$

An integer with a value that is positive (e.g. >0)

Array of objects (Reference)
created
string (dateTime) ^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Date/Time do agendamento

comment
string (string) ^[ \r\n\t\S]+$

Descrição.

patientInstruction
string (string) ^[ \r\n\t\S]+$

Uma sequência de caracteres.

Array of objects (Reference)
required
Array of objects (Appointment_Participant)

Lista de participantes do agendamento. Precisar ser exatamente dois, um com type = Patient e um com type = Practitioner.

Array of objects (Period)
{
  • "resourceType": "Appointment",
  • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
  • "meta": {
    },
  • "implicitRules": "string",
  • "language": "string",
  • "text": {
    },
  • "contained": [
    ],
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "status": "proposed",
  • "cancelationReason": {
    },
  • "serviceCategory": [
    ],
  • "serviceType": [
    ],
  • "specialty": [
    ],
  • "appointmentType": {
    },
  • "reasonCode": [
    ],
  • "reasonReference": [
    ],
  • "priority": 0,
  • "description": "string",
  • "supportingInformation": [
    ],
  • "start": "2022-05-25T18:42:06.551129+00:00",
  • "end": "2022-05-25T18:42:06.551129+00:00",
  • "minutesDuration": 0,
  • "slot": [
    ],
  • "created": "2022-05-23T19:00:00+00:00",
  • "comment": "string",
  • "patientInstruction": "string",
  • "basedOn": [
    ],
  • "participant": [
    ],
  • "requestedPeriod": [
    ]
}