> 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/CommunicationRequest/{id}

Reference: https://api-docs.nilo.services/referencia/endpoints/communication-request/communication-request-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` (CommunicationRequest, required) — O recurso.
- `search` (CommunicationRequestEntrySearch, required) — 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

Não existe mensagem programada com o `id` informado.

- `any`

## Types

### CommunicationRequest

Mensagem programada para um paciente. Recurso somente leitura.

- `resourceType` (string, required, default: CommunicationRequest) — Indica o tipo do recurso transacionado.
- `identifier` (list of Identifier, required) — Identificador Nilo da mensagem programada. Este recurso nunca carrega identificadores do seu sistema.
- `status` (string, required) — Na mensagem programada: `active` enquanto está programada — inclusive atrasada —, `completed` depois de enviada, `revoked` quando cancelada, `unknown` em qualquer outro estado. Na matrícula em campanha: `active`, `completed`, `revoked` ou `entered-in-error`. **Na escrita, só `active` é aceito.**
- `id` (string, optional) — Identificador Nilo FHIR do recurso, usado na leitura por ID.
- `meta` (Meta, optional) — Metadados da gravação no store — versão e data da última alteração.
- `priority` (string, optional) — `asap` quando o envio está **atrasado**, `routine` no resto. Não é uma prioridade escolhida por ninguém — é um sinal de atraso.
- `subject` (Reference, optional) — O paciente que vai receber a mensagem. **Obrigatório na escrita**, e resolvido só por `subject.identifier`.
- `recipient` (list of Reference, optional) — Repete o `subject` — é sempre o mesmo paciente, num único item.
- `category` (list of CodeableConcept, optional) — Um `coding` cujo `code` traz um identificador **interno** da plataforma. Não é contrato — veja o guia.
- `basedOn` (list of CommunicationRequest_BasedOn, optional) — Na mensagem programada, o plano de cuidado que a gerou, quando ela veio de uma diretriz — sem `reference`. Na matrícula em campanha, **a campanha**, e aí é **obrigatório na escrita**, com exatamente um item.
- `replaces` (list of Reference, optional) — A mensagem programada anterior, quando esta é uma reprogramação.
- `payload` (list of CommunicationRequest_Payload, optional) — O texto da mensagem, num único item com `contentString`. Ausente quando a mensagem não tem conteúdo montado.
- `note` (list of Annotation, optional) — Um único item com um texto de diagnóstico em formato interno. Não é contrato.
- `authoredOn` (string, optional) — Quando a mensagem foi programada.
- `occurrencePeriod` (Period, optional) — `start` é quando a mensagem **deve** ser enviada; `end` é quando ela foi concluída ou cancelada, e só aparece depois disso.

### CommunicationRequestEntrySearch

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`

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

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

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

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

### CommunicationRequest_BasedOn

O plano de cuidado que gerou a mensagem, ou a campanha em que o paciente foi matriculado. O `system` do identificador diz qual dos dois é.

- `identifier` (Identifier, required) — O identificador do plano de cuidado ou da campanha. **Obrigatório na escrita da matrícula**, no `system` da campanha.
- `type` (string, optional) — `CarePlan` nas mensagens geradas por diretriz. Ausente na matrícula em campanha.
- `reference` (string, optional) — Não é preenchido neste recurso: as duas referências saem só com `identifier`.

### CommunicationRequest_Payload

O conteúdo da mensagem programada.

- `contentString` (string, required) — O texto da mensagem. É o único tipo de conteúdo que este recurso produz.

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

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

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

## Examples

**Response**

```json
{
  "fullUrl": "https://landing-zone-api.nilo.services/fhir/resources/CommunicationRequest/c81f5b40-3a29-4e76-90d5-1b47ea62c803",
  "resource": {
    "resourceType": "CommunicationRequest",
    "identifier": [
      {
        "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/jaiminho-api--scheduled-message",
        "value": "440871",
        "use": "usual"
      }
    ],
    "status": "completed",
    "id": "c81f5b40-3a29-4e76-90d5-1b47ea62c803",
    "meta": {
      "lastUpdated": "2026-06-26T03:00:12.447000Z",
      "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw"
    },
    "priority": "routine",
    "subject": {
      "identifier": {
        "system": "https://www.acmesaude.com.br/integracao/paciente/",
        "value": "507823709",
        "use": "usual"
      },
      "type": "Patient",
      "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
    },
    "category": [
      {
        "coding": [
          {
            "code": "jaiminho_api.ScheduledMessage",
            "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/communication-category"
          }
        ]
      }
    ],
    "payload": [
      {
        "contentString": "Lembrete: sua consulta de acompanhamento está marcada para a próxima semana."
      }
    ],
    "authoredOn": "2026-06-20T08:00:00+00:00",
    "occurrencePeriod": {
      "end": "2026-06-25T09:00:47+00:00",
      "start": "2026-06-25T09:00:00+00:00"
    }
  },
  "search": {
    "mode": "match"
  }
}
```

**SDK Code**

```python Mensagem programada encontrada
import requests

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

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

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

print(response.json())
```

```javascript Mensagem programada encontrada
const url = 'https://landing-zone-api.nilo.services/fhir/resources/CommunicationRequest/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 Mensagem programada encontrada
package main

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

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/CommunicationRequest/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 Mensagem programada encontrada
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/CommunicationRequest/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 Mensagem programada encontrada
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/CommunicationRequest/id")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Mensagem programada encontrada
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Mensagem programada encontrada
using RestSharp;

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

```swift Mensagem programada encontrada
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/CommunicationRequest/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()
```