> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.nilo.services/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.nilo.services/_mcp/server.

# Buscar por ID

GET https://landing-zone-api.nilo.services/fhir/resources/Encounter/{id}

Reference: https://api-docs.nilo.services/referencia/endpoints/encounter/search-by-id

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://landing-zone-api.nilo.services` (Production, default)
- `https://landing-zone-api.stg.nilo.services` (Staging)

## Request

### Path parameters

- `id` (string, required) — Identificador Nilo Fhir do registro que deve ser retornado.

## Response

### 200

Operação bem sucedida.

- `fullUrl` (string, required) — URL absoluta do recurso neste ambiente.
- `resource` (Encounter, required) — O atendimento.
- `search` (EncounterEntrySearch, optional) — Constante com `mode` igual a `match`, herdada da forma de busca.

## Errors

### 400 Bad Request Error

Parâmetro enviado inválido.

- `issue` (list of OperationOutcomeIssueItems, required) — Uma coleção de mensagens de erro, aviso ou informação que resultado de uma ação do sistema.
- `resourceType` (string, required, default: OperationOutcome) — Indica o tipo do recurso transacionado.

### 404 Not Found Error

Nenhum atendimento com o `id` informado.

- `issue` (list of OperationOutcomeIssueItems, required) — Uma coleção de mensagens de erro, aviso ou informação que resultado de uma ação do sistema.
- `resourceType` (string, required, default: OperationOutcome) — Indica o tipo do recurso transacionado.

## Types

### Encounter

Atendimento. O `class.code` decide o tipo de registro que a Nilo cria e quais dos campos abaixo têm efeito: `VR` e `AMB` são atendimentos do prontuário, `EMER` e `IMP` são eventos (pronto atendimento e hospitalização).

- `class` (Coding, required) — Tipo do atendimento. Decide o registro que a Nilo cria.&#x20;
- `period` (Encounter_Period, required) — Início e fim do atendimento.
- `resourceType` (string, required, default: Encounter) — Indica o tipo do recurso transacionado.
- `status` (enum, required) — 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.
  - Allowed values: `planned`, `arrived`, `triaged`, `in-progress`, `onleave`, `finished`, `cancelled`, `entered-in-error`, `unknown`
- `subject` (Reference, required) — O paciente atendido, por um identificador dele já cadastrado.
- `id` (string, optional) — Identificador Nilo FHIR do recurso, atribuído na gravação.
- `meta` (Meta, optional) — Metadados do recurso no store FHIR.
- `identifier` (list of Identifier, optional) — 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.
- `appointment` (list of Reference, optional) — 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.
- `length` (Duration, optional) — 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.
- `extension` (list of Extension, optional) — Origem, canal, desfecho e entrevista clínica do atendimento. Lidas apenas em `VR` e `AMB`. A entrevista clínica vai em `encounter-clinicalNote`, com o texto em `valueMarkdown`, uma vez só e com texto; omitida, a já gravada é mantida.
- `location` (list of Encounter_Location, optional) — Local do evento, como texto livre em `location.display`. Lido apenas em `EMER` e `IMP`, e apenas o primeiro item.
- `diagnosis` (list of Encounter_Diagnosis, optional) — Condições já cadastradas a vincular a este evento. Lido apenas em `EMER` e `IMP`.
- `participant` (list of Encounter_Participant, optional) — Profissional responsável pelo atendimento. A Nilo registra um só — em `VR` e `AMB`, o primeiro item com `individual` e `ATND` em algum `coding` de `type`.

### EncounterEntrySearch

Constante com `mode` igual a `match`, herdada da forma de busca.

- `mode` (string, optional)

### OperationOutcomeIssueItems

Uma mensagem de erro, aviso ou informação que resultado de uma ação do sistema.

- `code` (enum, optional) — Descreve o tipo do problema.
  - Allowed values: `invalid`, `structure`, `required`, `value`, `invariant`, `security`, `login`, `unknown`, `expired`, `forbidden`, `suppressed`, `processing`, `not-supported`, `duplicate`, `multiple-matches`, `not-found`, `deleted`, `too-long`, `code-invalid`, `extension`, `too-costly`, `business-rule`, `conflict`, `transient`, `lock-error`, `no-store`, `exception`, `timeout`, `incomplete`, `throttled`, `informational`
- `details` (CodeableConcept, optional) — Detalhes adicionais sobre os códigos de resultado da operação de erro.
- `diagnostics` (string, optional) — Informações de diagnóstico adicionais sobre o problema
- `expression` (list of string, optional) — FHIR Path (caminho) do(s) elemento(s) relacionado(s) ao problema.
- `severity` (enum, optional) — Indica o resultado do processamento apesar do problema indicado.
  - Allowed values: `fatal`, `error`, `warning`, `information`

### Coding

Código definido por um sistema de terminologia.

- `code` (string, optional) — Código de identificação de um termo no sistema terminológico.
- `display` (string, optional) — Representação textual definida pelo sistema terminológico.
- `system` (string, optional) — Identidade do sistema terminológico.

### Encounter_Period

Intervalo do atendimento. `start` é obrigatório; `end`, quando enviado, tem de ser maior que `start`.

- `start` (string, required) — Início do atendimento.
- `end` (string, optional) — Fim do atendimento. Ausente, o atendimento é tratado como em andamento.

### Reference

Uma referência de um recurso para outro.

- `identifier` (Identifier, required) — Um identificador, código que identifica alguma entidade de forma única e inequívoca. Normalmente, isso é usado para identificadores de negócios.
- `type` (string, required) — Indica o tipo do recurso referenciado.
- `display` (string, optional) — Alternativa textual para descrever a referência.
- `reference` (string, optional) — Referência direta.

### Meta

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

- `lastUpdated` (string, optional) — Um instante no tempo (necessário conhecer pelo menos até o nível de segundos).
- `versionId` (string, optional) — 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.

### Identifier

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

- `system` (string, required) — O namespace para o valor do identificador. O cliente deve usar o seu próprio namespace.
- `value` (string, required) — O código de identificação único. Cliente deve usar o seu próprio.
- `use` (enum, optional) — A finalidade deste identificador.
  - Allowed values: `usual`, `official`, `temp`, `secondary`, `old`

### Duration

- `value` (double, required) — Um número racional com precisão implícita.
- `id` (string, optional) — Uma sequência de caracteres.

### Extension

Optional Extension Element - found in all resources.

- `id` (string, optional) — Identificador(es) pelo qual este recurso é distinguido.
- `extension` (list of Extension, optional) — Pode ser usado para representar informações adicionais que não fazem parte da definição básica do elemento.
- `url` (string, optional) — Fonte da definição do código de extensão - um nome lógico ou uma URL.
- `valueBase64Binary` (string, optional)
- `valueBoolean` (boolean, optional)
- `valueCanonical` (string, optional)
- `valueCode` (string, optional)
- `valueDate` (string, optional)
- `valueDateTime` (string, optional)
- `valueDecimal` (double, optional)
- `valueId` (string, optional)
- `valueInstant` (string, optional)
- `valueInteger` (double, optional)
- `valueMarkdown` (string, optional)
- `valueOid` (string, optional)
- `valuePositiveInt` (double, optional)
- `valueString` (string, optional)
- `valueTime` (string, optional)
- `valueUnsignedInt` (double, optional)
- `valueUri` (string, optional)
- `valueUrl` (string, optional)
- `valueUuid` (string, optional)
- `valueAddress` (Address, optional) — Um endereço expresso usando convenções postais.
- `valueAge` (Age, optional)
- `valueAnnotation` (Annotation, optional) — Uma nota de texto que também contém informações sobre quem fez o declaração e quando.
- `valueAttachment` (Attachment, optional) — For referring to data content defined in other formats.
- `valueCodeableConcept` (CodeableConcept, optional) — 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.
- `valueCoding` (Coding, optional) — Código definido por um sistema de terminologia.
- `valueContactPoint` (ContactPoint, optional) — Detalhes para todos os tipos de pontos de contato mediados por tecnologia para uma pessoa ou organização, incluindo telefone, e-mail, etc.
- `valueCount` (Count, optional)
- `valueDistance` (Distance, optional)
- `valueDuration` (Duration, optional)
- `valueHumanName` (HumanName, optional) — Um nome de um humano com texto, peças e informações de uso.
- `valueIdentifier` (Identifier, optional) — Um identificador, código que identifica alguma entidade de forma única e inequívoca. Normalmente, isso é usado para identificadores de negócios.
- `valueMoney` (Money, optional) — An amount of economic utility in some recognized currency.
- `valuePeriod` (Period, optional) — Um intervalo de tempo definido por uma data de início e término e, opcionalmente, horas para ambos.
- `valueQuantity` (Quantity, optional) — Uma quantidade medida (ou uma quantidade que pode potencialmente ser medida). Observação que os valores medidos incluem valores que não são quantificados com precisão, incluindo valores envolvendo unidades arbitrárias e moedas flutuantes.
- `valueRange` (Range, optional)
- `valueRatio` (Ratio, optional)
- `valueReference` (Reference, optional) — Uma referência de um recurso para outro.
- `valueSampledData` (SampledData, optional)
- `valueSignature` (Signature, optional)
- `valueTiming` (Timing, optional)
- `valueContactDetail` (ContactDetail, optional)
- `valueContributor` (Contributor, optional)
- `valueDataRequirement` (DataRequirement, optional)
- `valueExpression` (Expression, optional)
- `valueParameterDefinition` (ParameterDefinition, optional)
- `valueRelatedArtifact` (RelatedArtifact, optional)
- `valueTriggerDefinition` (TriggerDefinition, optional)
- `valueUsageContext` (UsageContext, optional)
- `valueDosage` (Dosage, optional) — Indica como o medicamento foi, é ou deve ser tomado pelo paciente.
- `valueMeta` (Meta, optional) — Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.

### Encounter_Location

Local onde o evento aconteceu. Lido apenas em `EMER` e `IMP`.

- `location` (Encounter_Location_Reference, required) — O local, como texto livre.

### Encounter_Diagnosis

Vínculo entre o evento e uma condição já cadastrada. Lido apenas em `EMER` e `IMP`.

- `condition` (Reference, required) — A condição, por um identificador dela já cadastrado. A condição precisa existir antes — este campo não a cria.

### Encounter_Participant

Participante do atendimento. No envio, o profissional responsável: `individual` com um identificador dele e `type` `Practitioner`.

- `individual` (Reference, optional) — O profissional, por um identificador dele já cadastrado. O `type` da referência tem de ser `Practitioner`.
- `type` (list of Encounter_Participant_CodeableConcept, optional) — Papel do participante. Em `VR` e `AMB` é obrigatório em **cada** item de `participant`, com ao menos um `coding` com `code` preenchido; o responsável é o primeiro item com `individual` e `ATND`. Itens com outro código são aceitos e ignorados. Em `EMER` e `IMP` não é lido.

### 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.

- `coding` (list of Coding, optional) — Código definido por um sistema de terminologia.
- `text` (string, optional) — Representação de texto simples do conceito.

### Address

Um endereço expresso usando convenções postais.

- `city` (string, optional) — O nome da cidade, vila, subúrbio, comunidade ou centro de entrega.
- `country` (string, optional) — Uma nação comumente entendida ou geralmente aceita.
- `district` (string, optional) — O nome da área administrativa.
- `line` (list of string, optional) — Este componente contém o número da casa, número do apartamento, nome da rua, direção da rua, número da caixa postal, dicas de entrega e informações de endereço semelhantes.
- `postalCode` (string, optional) — Um código postal (CEP) que designa uma região definida pelo serviço postal.
- `state` (string, optional) — Subunidade de um país (UF).
- `text` (string, optional) — Especifica o endereço completo como deve ser exibido, por exemplo, em uma etiqueta postal. Isso pode ser fornecido em vez de ou com as peças específicas.
- `type` (enum, optional) — Distingue entre endereços físicos (aqueles que você pode visitar) e endereços de correspondência (por exemplo, caixas postais e atendimento comercial). A maioria dos endereços são ambos.
  - Allowed values: `postal`, `physical`, `both`
- `use` (enum, optional) — A finalidade deste endereço.
  - Allowed values: `home`, `work`, `temp`, `old`, `billing`

### Age

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `value` (double, optional) — Um número racional com precisão implícita.
- `comparator` (enum, optional)
  - Allowed values: `<`, `<=`, `>=`, `>`
- `unit` (string, optional) — A human-readable form of the unit.
- `system` (string, optional) — Uma referência de identificador de recurso uniforme (RFC 3986) usado como "namespace".
- `code` (Element, optional)

### Annotation

Uma nota de texto que também contém informações sobre quem fez o declaração e quando.

- `authorReference` (Reference, optional) — O indivíduo responsável por fazer a anotação.
- `text` (string, optional) — O conteúdo da anotação.
- `time` (string, optional) — Quando a anotação foi feita.

### Attachment

For referring to data content defined in other formats.

- `contentType` (string, optional) — Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
- `creation` (string, optional) — The date that the attachment was first created.
- `data` (string, optional) — The actual data of the attachment - a sequence of bytes, base64 encoded.
- `hash` (string, optional) — The calculated hash of the data using SHA-1. Represented using base64.
- `id` (string, optional) — Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- `language` (string, optional) — The human language of the content. The value can be any valid value according to BCP 47.
- `size` (double, optional) — The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
- `title` (string, optional) — A label or set of text to display in place of the data.
- `url` (string, optional) — A location where the data can be accessed.

### ContactPoint

Detalhes para todos os tipos de pontos de contato mediados por tecnologia para uma pessoa ou organização, incluindo telefone, e-mail, etc.

- `system` (enum, optional) — Meio tecnológico de contato.
  - Allowed values: `phone`, `fax`, `email`, `pager`, `url`, `sms`, `other`
- `use` (enum, optional) — Identifica a finalidade do ponto de contato.
  - Allowed values: `home`, `work`, `temp`, `old`, `mobile`
- `value` (string, optional) — Os detalhes reais do ponto de contato.

### Count

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `value` (double, optional) — Um número racional com precisão implícita.
- `comparator` (enum, optional)
  - Allowed values: `<`, `<=`, `>=`, `>`
- `unit` (string, optional) — Uma sequência de caracteres.
- `_unit` (Element, optional)
- `system` (string, optional) — Uma referência de identificador de recurso uniforme (RFC 3986) usado como "namespace".
- `_system` (Element, optional)
- `code` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `_code` (Element, optional)

### Distance

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `value` (double, optional) — Um número racional com precisão implícita.
- `_value` (Element, optional)
- `comparator` (enum, optional)
  - Allowed values: `<`, `<=`, `>=`, `>`
- `_comparator` (Element, optional)
- `unit` (string, optional) — Uma sequência de caracteres.
- `_unit` (Element, optional)
- `system` (string, optional) — Uma referência de identificador de recurso uniforme (RFC 3986) usado como "namespace".
- `_system` (Element, optional)
- `code` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `_code` (Element, optional)

### HumanName

Um nome de um humano com texto, peças e informações de uso.

- `family` (string, optional) — Nome de família (muitas vezes chamado 'Sobrenome')
- `given` (list of string, optional) — Nome (sem sobrenome), particionado e ordenado.
- `period` (Period, optional) — Intervalo em que o nome era ou é válido. No `Patient`, preencher `period.end` num nome com `use: usual` é o que **apaga** o nome social — qualquer data serve, é a presença do campo que remove o valor.
- `text` (string, optional) — Representação de texto do nome completo
- `use` (enum, optional) — Identifica a finalidade deste nome.
  - Allowed values: `usual`, `official`, `temp`, `nickname`, `anonymous`, `old`, `maiden`

### Money

An amount of economic utility in some recognized currency.

- `currency` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `id` (string, optional) — Uma sequência de caracteres.
- `value` (double, optional) — Um número racional com precisão implícita.

### Period

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

- `end` (string, optional) — Uma data, data-hora ou data parcial (por exemplo, apenas ano ou ano + mês).
- `start` (string, optional) — Uma data, data-hora ou data parcial (por exemplo, apenas ano ou ano + mês).

### Quantity

Uma quantidade medida (ou uma quantidade que pode potencialmente ser medida). Observação que os valores medidos incluem valores que não são quantificados com precisão, incluindo valores envolvendo unidades arbitrárias e moedas flutuantes.

- `code` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `comparator` (enum, optional) — Como o valor deve ser entendido e representado - se o valor real é maior ou menor que o valor declarado devido a questões de medição; por exemplo. se o comparador for "\<" , então o real valor é \< valor declarado.
  - Allowed values: `<`, `<=`, `>=`, `>`
- `system` (string, optional) — Uma referência de identificador de recurso uniforme (RFC 3986) usado como "namespace".
- `unit` (string, optional) — Uma sequência de caracteres.
- `value` (double, optional) — Um número racional com precisão implícita.

### Range

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `low` (Quantity, optional) — Uma quantidade medida (ou uma quantidade que pode potencialmente ser medida). Observação que os valores medidos incluem valores que não são quantificados com precisão, incluindo valores envolvendo unidades arbitrárias e moedas flutuantes.
- `high` (Quantity, optional) — Uma quantidade medida (ou uma quantidade que pode potencialmente ser medida). Observação que os valores medidos incluem valores que não são quantificados com precisão, incluindo valores envolvendo unidades arbitrárias e moedas flutuantes.

### Ratio

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `numerator` (Quantity, optional) — Uma quantidade medida (ou uma quantidade que pode potencialmente ser medida). Observação que os valores medidos incluem valores que não são quantificados com precisão, incluindo valores envolvendo unidades arbitrárias e moedas flutuantes.
- `denominator` (Quantity, optional) — Uma quantidade medida (ou uma quantidade que pode potencialmente ser medida). Observação que os valores medidos incluem valores que não são quantificados com precisão, incluindo valores envolvendo unidades arbitrárias e moedas flutuantes.

### SampledData

- `origin` (Quantity, required) — Uma quantidade medida (ou uma quantidade que pode potencialmente ser medida). Observação que os valores medidos incluem valores que não são quantificados com precisão, incluindo valores envolvendo unidades arbitrárias e moedas flutuantes.
- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `period` (double, optional) — Um número racional com precisão implícita.
- `_period` (Element, optional)
- `factor` (double, optional) — Um número racional com precisão implícita.
- `_factor` (Element, optional)
- `lowerLimit` (double, optional) — Um número racional com precisão implícita.
- `_lowerLimit` (Element, optional)
- `upperLimit` (double, optional) — Um número racional com precisão implícita.
- `_upperLimit` (Element, optional)
- `dimensions` (double, optional) — An integer with a value that is positive (e.g. >0)
- `_dimensions` (Element, optional)
- `data` (string, optional) — Uma sequência de caracteres.
- `_data` (Element, optional)

### Signature

- `type` (list of Coding, required)
- `who` (Reference, required) — Uma referência de um recurso para outro.
- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `when` (string, optional) — Um instante no tempo (necessário conhecer pelo menos até o nível de segundos).
- `_when` (Element, optional)
- `onBehalfOf` (Reference, optional) — Uma referência de um recurso para outro.
- `targetFormat` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `_targetFormat` (Element, optional)
- `sigFormat` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `_sigFormat` (Element, optional)
- `data` (string, optional) — A stream of bytes
- `_data` (Element, optional)

### Timing

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `modifierExtension` (list of Extension, optional)
- `event` (list of string, optional)
- `_event` (list of Element, optional)
- `repeat` (Timing_Repeat, optional)
- `code` (CodeableConcept, optional) — 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.

### ContactDetail

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `name` (string, optional) — Uma sequência de caracteres.
- `_name` (Element, optional)
- `telecom` (list of ContactPoint, optional)

### Contributor

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `type` (enum, optional)
  - Allowed values: `author`, `editor`, `reviewer`, `endorser`
- `_type` (Element, optional)
- `name` (string, optional) — Uma sequência de caracteres.
- `_name` (Element, optional)
- `contact` (list of ContactDetail, optional)

### DataRequirement

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `type` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `_type` (Element, optional)
- `profile` (list of string, optional)
- `subjectCodeableConcept` (CodeableConcept, optional) — 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.
- `subjectReference` (Reference, optional) — Uma referência de um recurso para outro.
- `mustSupport` (list of string, optional)
- `_mustSupport` (list of Element, optional)
- `codeFilter` (list of DataRequirement_CodeFilter, optional)
- `dateFilter` (list of DataRequirement_DateFilter, optional)
- `limit` (double, optional) — An integer with a value that is positive (e.g. >0)
- `_limit` (Element, optional)
- `sort` (list of DataRequirement_Sort, optional)

### Expression

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `description` (string, optional) — Uma sequência de caracteres.
- `_description` (Element, optional)
- `name` (string, optional) — 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.
- `_name` (Element, optional)
- `language` (enum, optional)
  - Allowed values: `text/cql`, `text/fhirpath`, `application/x-fhir-query`
- `_language` (Element, optional)
- `expression` (string, optional) — Uma sequência de caracteres.
- `_expression` (Element, optional)
- `reference` (string, optional) — Uma referência de identificador de recurso uniforme (RFC 3986) usado como "namespace".
- `_reference` (Element, optional)

### ParameterDefinition

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `name` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `_name` (Element, optional)
- `use` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `_use` (Element, optional)
- `min` (double, optional)
- `_min` (Element, optional)
- `max` (string, optional) — Uma sequência de caracteres.
- `_max` (Element, optional)
- `documentation` (string, optional) — Uma sequência de caracteres.
- `_documentation` (Element, optional)
- `type` (string, optional) — Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.
- `_type` (Element, optional)
- `profile` (string, optional) — Um URI que se refere a um recurso por seu URL canônico (recursos com uma propriedade url). O tipo canônico difere de um uri por ter um significado especial nesta especificação e por poder ter uma versão anexada, separada por uma barra vertical (|). Observe que o tipo canônico não é usado para os URLs canônicos reais que são o destino dessas referências, mas para os URIs que se referem a eles e podem ter o sufixo da versão neles.

### RelatedArtifact

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `type` (enum, optional)
  - Allowed values: `documentation`, `justification`, `citation`, `predecessor`, `successor`, `derived-from`, `depends-on`, `composed-of`
- `_type` (Element, optional)
- `label` (string, optional) — Uma sequência de caracteres.
- `_label` (Element, optional)
- `display` (string, optional) — Uma sequência de caracteres.
- `_display` (Element, optional)
- `citation` (string, optional) — Uma string que pode conter a sintaxe do Markdown para opcional processamento por um mecanismo de apresentação de remarcação.
- `_citation` (Element, optional)
- `url` (string, optional) — A URI that is a literal reference
- `_url` (Element, optional)
- `document` (Attachment, optional) — For referring to data content defined in other formats.
- `resource` (string, optional) — Um URI que se refere a um recurso por seu URL canônico (recursos com uma propriedade url). O tipo canônico difere de um uri por ter um significado especial nesta especificação e por poder ter uma versão anexada, separada por uma barra vertical (|). Observe que o tipo canônico não é usado para os URLs canônicos reais que são o destino dessas referências, mas para os URIs que se referem a eles e podem ter o sufixo da versão neles.

### TriggerDefinition

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `type` (enum, optional)
  - Allowed values: `named-event`, `periodic`, `data-changed`, `data-added`, `data-modified`, `data-removed`, `data-accessed`, `data-access-ended`
- `_type` (Element, optional)
- `name` (string, optional) — Uma sequência de caracteres.
- `_name` (Element, optional)
- `timingTiming` (Timing, optional)
- `timingReference` (Reference, optional) — Uma referência de um recurso para outro.
- `timingDate` (string, optional)
- `_timingDate` (Element, optional)
- `timingDateTime` (string, optional)
- `_timingDateTime` (Element, optional)
- `data` (list of DataRequirement, optional)
- `condition` (Expression, optional)

### UsageContext

- `code` (Coding, required) — Código definido por um sistema de terminologia.
- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `valueCodeableConcept` (CodeableConcept, optional) — 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.
- `valueQuantity` (Quantity, optional) — Uma quantidade medida (ou uma quantidade que pode potencialmente ser medida). Observação que os valores medidos incluem valores que não são quantificados com precisão, incluindo valores envolvendo unidades arbitrárias e moedas flutuantes.
- `valueRange` (Range, optional)
- `valueReference` (Reference, optional) — Uma referência de um recurso para outro.

### Dosage

Indica como o medicamento foi, é ou deve ser tomado pelo paciente.

- `text` (string, optional) — Representação textual.

### Encounter_Location_Reference

Referência ao local do evento. A Nilo guarda o local como texto: mande `display`. Um `identifier` de um `Location` já cadastrado também é aceito, e o nome dele é usado como texto.

- `display` (string, optional) — Nome do local, texto livre.
- `identifier` (Identifier, optional) — Identificador de um `Location` já cadastrado, em lugar do texto.

### Encounter_Participant_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.

- `coding` (list of Encounter_Participant_Coding, required) — Código definido por um sistema de terminologia.
- `text` (string, optional) — Representação de texto simples do conceito.

### Element

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)

### Timing_Repeat

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `modifierExtension` (list of Extension, optional)
- `boundsDuration` (Duration, optional)
- `boundsRange` (Range, optional)
- `boundsPeriod` (Period, optional) — Um intervalo de tempo definido por uma data de início e término e, opcionalmente, horas para ambos.
- `count` (double, optional) — An integer with a value that is positive (e.g. >0)
- `_count` (Element, optional)
- `countMax` (double, optional) — An integer with a value that is positive (e.g. >0)
- `_countMax` (Element, optional)
- `duration` (double, optional) — Um número racional com precisão implícita.
- `_duration` (Element, optional)
- `durationMax` (double, optional) — Um número racional com precisão implícita.
- `_durationMax` (Element, optional)
- `durationUnit` (enum, optional)
  - Allowed values: `s`, `min`, `h`, `d`, `wk`, `mo`, `a`
- `_durationUnit` (Element, optional)
- `frequency` (double, optional) — An integer with a value that is positive (e.g. >0)
- `_frequency` (Element, optional)
- `frequencyMax` (double, optional) — An integer with a value that is positive (e.g. >0)
- `_frequencyMax` (Element, optional)
- `period` (double, optional) — Um número racional com precisão implícita.
- `_period` (Element, optional)
- `periodMax` (double, optional) — Um número racional com precisão implícita.
- `_periodMax` (Element, optional)
- `periodUnit` (enum, optional)
  - Allowed values: `s`, `min`, `h`, `d`, `wk`, `mo`, `a`
- `_periodUnit` (Element, optional)
- `dayOfWeek` (list of string, optional)
- `_dayOfWeek` (list of Element, optional)
- `timeOfDay` (list of string, optional)
- `_timeOfDay` (list of Element, optional)
- `when` (list of enum, optional)
  - Allowed values: `MORN`, `MORN.early`, `MORN.late`, `NOON`, `AFT`, `AFT.early`, `AFT.late`, `EVE`, `EVE.early`, `EVE.late`, `NIGHT`, `PHS`, `HS`, `WAKE`, `C`, `CM`, `CD`, `CV`, `AC`, `ACM`, `ACD`, `ACV`, `PC`, `PCM`, `PCD`, `PCV`
- `_when` (list of Element, optional)
- `offset` (double, optional) — An integer with a value that is not negative (e.g. >= 0)
- `_offset` (Element, optional)

### DataRequirement_CodeFilter

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `modifierExtension` (list of Extension, optional)
- `path` (string, optional) — Uma sequência de caracteres.
- `_path` (Element, optional)
- `searchParam` (string, optional) — Uma sequência de caracteres.
- `_searchParam` (Element, optional)
- `valueSet` (string, optional) — Um URI que se refere a um recurso por seu URL canônico (recursos com uma propriedade url). O tipo canônico difere de um uri por ter um significado especial nesta especificação e por poder ter uma versão anexada, separada por uma barra vertical (|). Observe que o tipo canônico não é usado para os URLs canônicos reais que são o destino dessas referências, mas para os URIs que se referem a eles e podem ter o sufixo da versão neles.
- `code` (list of Coding, optional)

### DataRequirement_DateFilter

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `modifierExtension` (list of Extension, optional)
- `path` (string, optional) — Uma sequência de caracteres.
- `_path` (Element, optional)
- `searchParam` (string, optional) — Uma sequência de caracteres.
- `_searchParam` (Element, optional)
- `valueDateTime` (string, optional)
- `_valueDateTime` (Element, optional)
- `valuePeriod` (Period, optional) — Um intervalo de tempo definido por uma data de início e término e, opcionalmente, horas para ambos.
- `valueDuration` (Duration, optional)

### DataRequirement_Sort

- `id` (string, optional) — Uma sequência de caracteres.
- `extension` (list of Extension, optional)
- `modifierExtension` (list of Extension, optional)
- `path` (string, optional) — Uma sequência de caracteres.
- `_path` (Element, optional)
- `direction` (enum, optional)
  - Allowed values: `ascending`, `descending`
- `_direction` (Element, optional)

### Encounter_Participant_Coding

Código definido por um sistema de terminologia.

- `code` (string, required) — Código de identificação de um termo no sistema terminológico. `ATND` marca o profissional responsável; outros códigos são aceitos e ignorados.
- `display` (string, optional) — Representação textual definida pelo sistema terminológico.
- `system` (string, optional) — Identidade do sistema terminológico.

## Examples

**Response**

```json
{
  "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/Encounter/7c1d4e08-52ba-4f37-9e6a-3b0d81f5c294",
  "resource": {
    "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"
      }
    ],
    "extension": [
      {
        "url": "https://landing-zone-api.nilo.services/fhir/resources/StructureDefinition/encounter-admitSource",
        "valueCodeableConcept": {
          "coding": [
            {
              "code": "1",
              "display": "Busca ativa",
              "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/encounter-admitSource"
            }
          ],
          "text": "Busca ativa"
        }
      },
      {
        "url": "https://landing-zone-api.nilo.services/fhir/resources/StructureDefinition/encounter-serviceChannel",
        "valueCodeableConcept": {
          "coding": [
            {
              "code": "3",
              "display": "Vídeo",
              "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/encounter-serviceChannel"
            }
          ],
          "text": "Vídeo"
        }
      },
      {
        "url": "https://landing-zone-api.nilo.services/fhir/resources/StructureDefinition/encounter-dischargeDisposition",
        "valueCodeableConcept": {
          "coding": [
            {
              "code": "7",
              "display": "Alta",
              "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/encounter-dischargeDisposition"
            }
          ],
          "text": "Alta"
        }
      },
      {
        "url": "https://landing-zone-api.nilo.services/fhir/resources/StructureDefinition/encounter-clinicalNote",
        "valueMarkdown": "## Queixa principal\nCefaleia há 3 dias.\n\n## História da doença atual\nDor frontal, pulsátil, pior no fim do dia. Nega febre e vômitos.\n\n## Antecedentes\n- Hipertensão em uso de losartana 50 mg\n- Nega alergias"
      }
    ],
    "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"
          }
        ]
      }
    ]
  },
  "search": {
    "mode": "match"
  }
}
```

**SDK Code**

```python Atendimento encontrado
import requests

url = "https://landing-zone-api.nilo.services/fhir/resources/Encounter/id"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Atendimento encontrado
const url = 'https://landing-zone-api.nilo.services/fhir/resources/Encounter/id';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Atendimento encontrado
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/Encounter/id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Atendimento encontrado
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/Encounter/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Atendimento encontrado
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://landing-zone-api.nilo.services/fhir/resources/Encounter/id")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Atendimento encontrado
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://landing-zone-api.nilo.services/fhir/resources/Encounter/id', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Atendimento encontrado
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/Encounter/id");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Atendimento encontrado
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/Encounter/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```