Consultar

Endpoint	GET /fhir/resources/Media
Autenticação	🔓 Chave de API
Status	Implementado

Modelagem da API - Request

---

Headers

Opção	Tipo	Requerido	Descrição				Exemplo
x-api-key	string	Sim	Chave de autenticação do cliente, fornecida durante a configuração do ambiente.
Content-Type	string	Sim					application/json

Parâmetros de caminho

Opção	Tipo	Requerido	Descrição			Exemplo
ID	string	Não	UUID do recurso FHIR.			ba200cfa-dae0-46cf-81a0-008e3f7414b4

Parâmetros de Query

Você poderá utilizar todos os parâmetros de pesquisa disponíveis do recurso canônico.

https://hl7.org/fhir/R4/media.html#search

Exemplos de Requisições

Listar arquivos

Listar os arquivos

curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Media \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Buscar arquivos de um paciente

Buscar Media pelo identificador do paciente

curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Media?patient.identifier=https://www.acmesaude.com.br/integracao/paciente|456 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Buscar um arquivo pelo identificador do NiloCare

Buscar Media pelo identificador do NiloCare

curl --request GET \
--url https://landing-zone-api.nilo.services/fhir/resources/Media?identifier=https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/care-api--file-storage|12345 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <inserir API Key aqui>'

Parâmetros de busca suportados

Somente subject / patient e identifier são úteis na prática (além dos parâmetros de paginação _lastUpdated, _count e _page_token), porque apenas esses campos são preenchidos pelo NiloCare.

• status é sempre completed, portanto filtrar por ele não restringe nada.
• type, encounter, createdDateTime, operator, device, note e content.contentType não são preenchidos.
• A busca por identifier aceita tanto o identifier enviado na criação quanto o do NiloCare, já que os dois são preservados no recurso.

Modelagem da API - Response

---

dica

A resposta traz apenas quatro campos preenchidos:

• identifier — o identifier enviado na criação, acrescido de um identifier do próprio NiloCare (system .../fhir/resources/NamingSystem/care-api--file-storage), cujo value é o identificador interno do arquivo. Arquivos criados dentro do NiloCare retornam apenas o segundo;
• status — sempre completed;
• subject — com o reference e o identifier do paciente;
• content — apenas com url e title; contentType, size, data e hash não são retornados. O title é o nome com que o arquivo foi armazenado, e não necessariamente o que foi enviado: como o content.title só é preservado no envio em base64, arquivos enviados por URL retornam o nome gerado pelo NiloCare.

Arquivos criados dentro do NiloCare também são retornados.

A consulta não devolve somente PDFs

A consulta expõe todos os arquivos associados ao paciente, e não apenas os enviados por integração: anexos de outros canais (imagens, áudios e vídeos do chat, por exemplo) também aparecem como Media. Como o content.contentType não é preenchido, use a extensão do content.title se a sua integração só deve tratar documentos.

content.url é uma referência interna

O campo content.url traz o caminho interno de armazenamento do arquivo — em geral no formato patients/{id}/document/{timestamp}_arquivo.pdf, embora o formato varie conforme a origem do arquivo — e não um link público para download. Não utilize esse valor diretamente em uma requisição GET.

✔ 200

Operação bem sucedida.

	Array of objects Uma lista de recursos do pacote.
	Array of objects Um conjunto de links que fornecem contexto/navegação neste pacote.
resourceType required	string Default: "Bundle" Indica o tipo do recurso transacionado.
type required	string Enum: "document" "message" "transaction" "transaction-response" "batch" "batch-response" "history" "searchset" "collection" Indica a finalidade deste pacote, como ele deve ser usado.

{

• "entry": [

  • {

    • "fullUrl": "{host}/fhir/resources/.../7d154473-...-a5ce077ef77f",
    • "request": {

      • "method": "POST",
      • "url": "Patient"

      },
    • "resource": {

      • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
      • "meta": {

        • "lastUpdated": "2022-05-25T18:42:06.551129+00:00",
        • "versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"

        },
      • "resourceType": "Media",
      • "identifier": [

        • {

          • "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
          • "use": "usual",
          • "value": "12345"

          }

        ],
      • "status": "completed",
      • "subject": {

        • "identifier": {

          • "system": "https://www.acmesaude.com.br/integracao/paciente",
          • "value": "456"

          },
        • "type": "Patient"

        },
      • "content": {

        • "contentType": "application/pdf",
        • "url": "https://arquivos.acmesaude.com.br/laudos/laudo-77001.pdf",
        • "data": "JVBERi0xLjQKJeLjz9MK...",
        • "title": "Laudo do exame",
        • "size": 20481,
        • "hash": "string"

        }

      },
    • "search": {

      • "mode": "match"

      }

    }

  ],
• "link": [

  • {

    • "relation": "next",
    • "url": "{host}/fhir/resources/Patient?_page_token=Cjj3YopYuf%2F%2F%2F%2F%2BABd%2BbgE0m...dSANQAFoLCUSM7w9VYUqaEANglLWUugQ%3D"

    }

  ],
• "resourceType": "Bundle",
• "type": "searchset"

}

✘ 400

Parâmetro enviado inválido.

required	Array of objects Uma coleção de mensagens de erro, aviso ou informação que resultado de uma ação do sistema.
resourceType required	string Default: "OperationOutcome" Indica o tipo do recurso transacionado.

{

• "issue": [

  • {

    • "code": "exception",
    • "details": {

      • "text": "Parâmetro enviado inválido"

      },
    • "severity": "error"

    }

  ],
• "resourceType": "OperationOutcome"

}

✘ 500

Erro inesperado.