Cadastrar ou atualizar | Nilo Saúde · Interoperabilidade FHIR

curl -X POST https://landing-zone-api.nilo.services/fhir/resources/Encounter \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "class": {
    "code": "VR",
    "display": "virtual",
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode"
  },
  "period": {
    "start": "2026-04-16T19:30:00+00:00",
    "end": "2026-04-16T20:00:00+00:00"
  },
  "resourceType": "Encounter",
  "status": "finished",
  "subject": {
    "identifier": {
      "system": "https://www.acmesaude.com.br/integracao/paciente/",
      "value": "507823709",
      "use": "usual"
    },
    "type": "Patient"
  },
  "identifier": [
    {
      "system": "https://www.acmesaude.com.br/integracao/atendimento/",
      "value": "55162",
      "use": "usual"
    }
  ],
  "participant": [
    {
      "individual": {
        "identifier": {
          "system": "https://www.acmesaude.com.br/integracao/profissional/",
          "value": "5032932",
          "use": "usual"
        },
        "type": "Practitioner"
      },
      "type": [
        {
          "coding": [
            {
              "code": "ATND",
              "display": "attender",
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType"
            }
          ],
          "text": "attender"
        }
      ]
    }
  ]
}'

{
  "class": {
    "code": "VR",
    "display": "virtual",
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode"
  },
  "period": {
    "start": "2026-04-16T19:30:00+00:00",
    "end": "2026-04-16T20:00:00+00:00"
  },
  "resourceType": "Encounter",
  "status": "finished",
  "subject": {
    "identifier": {
      "system": "https://www.acmesaude.com.br/integracao/paciente/",
      "value": "507823709",
      "use": "usual"
    },
    "type": "Patient",
    "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
  },
  "id": "7c1d4e08-52ba-4f37-9e6a-3b0d81f5c294",
  "meta": {
    "lastUpdated": "2026-04-16T20:00:12.441000Z",
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
  },
  "identifier": [
    {
      "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--appointment-v3",
      "value": "318472",
      "use": "usual"
    },
    {
      "system": "https://www.acmesaude.com.br/integracao/atendimento/",
      "value": "55162",
      "use": "usual"
    }
  ],
  "participant": [
    {
      "individual": {
        "identifier": {
          "system": "https://www.acmesaude.com.br/integracao/profissional/",
          "value": "5032932",
          "use": "usual"
        },
        "type": "Practitioner",
        "reference": "Practitioner/1a9c7f52-64b8-4a3e-8d21-9f0b7c4e6d38"
      },
      "type": [
        {
          "coding": [
            {
              "code": "ATND",
              "display": "attender",
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType"
            }
          ],
          "text": "attender"
        }
      ]
    }
  ]
}

Cria o atendimento quando nenhum identifier do payload casa com um atendimento existente, e atualiza o encontrado caso contrário. O class.code decide o tipo de registro: VR e AMB criam um atendimento no prontuário — e, havendo profissional, também um agendamento —, enquanto EMER e IMP criam um evento de pronto atendimento ou de hospitalização.

Cria o atendimento quando nenhum `identifier` do payload casa com um atendimento existente, e atualiza o encontrado caso contrário. O `class.code` decide o tipo de registro: `VR` e `AMB` criam um atendimento no prontuário — e, havendo profissional, também um agendamento —, enquanto `EMER` e `IMP` criam um evento de pronto atendimento ou de hospitalização.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

classobjectRequired

Tipo do atendimento. Decide o registro que a Nilo cria.

periodobjectRequired

Início e fim do atendimento.

resourceTypestringRequiredDefaults to Encounter

Indica o tipo do recurso transacionado.

statusenumRequired

Situação do atendimento. Em VR e AMB é convertida para os três estados da plataforma; em EMER e IMP é derivada de period.end e o valor enviado é descartado.

subjectobjectRequired

O paciente atendido, por um identificador dele já cadastrado.

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

Identificador Nilo FHIR do recurso, atribuído na gravação.

metaobjectOptional

Metadados do recurso no store FHIR.

identifierlist of objectsOptional

Identificador(es) pelo qual este recurso é distinguido. É por ele que a API decide entre criar e atualizar. Obrigatório em class EMER e IMP; em VR e AMB a ausência não é recusada, mas cada envio sem ele cria um atendimento novo.

appointmentlist of objectsOptional

Agendamento já existente a que este atendimento pertence, pelo identificador dele. Aceita um único item, e só tem efeito em VR e AMB com profissional informado.

lengthobjectOptional

Duração em minutos do agendamento criado junto com o atendimento. Usada apenas quando period.end está ausente, em VR e AMB. Sem ela, a duração é de 1 minuto.

extensionlist of objectsOptional

Origem, canal e desfecho do atendimento. Lidas apenas em VR e AMB.

locationlist of objectsOptional

Local do evento, como texto livre em location.display. Lido apenas em EMER e IMP, e apenas o primeiro item.

diagnosislist of objectsOptional

Condições já cadastradas a vincular a este evento. Lido apenas em EMER e IMP.

participantlist of objectsOptional

Profissional responsável pelo atendimento. A Nilo registra um só — em VR e AMB, o primeiro item com type ATND.

Response

Operação bem sucedida.

classobject