API REST

GET /v1/exams/{exam_id}

Busca um exame

4eb9d27

GET /v1/exams/{exam_id}

Busca e decifra um exame: o conteúdo mais novo, ou version_id.

Parâmetros de caminho #

exam_id string obrigatório

O id do documento do exame.

Parâmetros de query #

version_id string

Lê esta versão confirmada em vez do conteúdo mais novo.
include_draft boolean

Lê o rascunho do editor web quando é mais novo que a versão corrente (a regra do app web).

Respostas #

200 Successful Response
- index object obrigatório
  
  O que o cofre sabe sobre um paciente/exame/modelo (`docs/PROTOCOL.md §8`): chaves, fluxos, metadado em claro. Todo campo aqui é algo que o próprio cofre lê para rotear e autorizar. O conteúdo clínico nunca aparece neste modelo: ele vive no objeto selado de cada versão, e um resumo selado curto (nome, título) vive em `encrypted_index`, que só quem tem a DEK abre. Exatamente um `security_group_id` por documento: compartilhar um paciente com outra equipe é copiá-lo, nunca compartilhar a chave.
- version_id object
- draft_rev object
- record object obrigatório
  
  O conteúdo de uma versão de exame (`ExamContent` no app web) — o laudo e o contexto clínico. `report_lexical` é o estado do editor web (JSON do Lexical, como string) e é a fonte da verdade; `report_html` é derivado dele para leitores que nunca abrem o editor. Grave os dois ao produzir um laudo, senão o editor web abre um documento vazio.
- summary object
400 O cofre recusou a requisição como inválida.
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
401 Sem certificado de cliente, ou a sessão do SDK foi recusada ou expirou (`session_expired`).
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
402 O workspace não tem crédito para isto.
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
403 CN não permitido, permissão negada, ou sem chave para o security group do dado (`group_key_unavailable`).
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
404 Não encontrado — também um nó lido sob um grupo ao qual não pertence.
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
409 Uma versão pendente ou mais nova, um replay, ou um upload que não chegou ao armazenamento.
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
422 O corpo ou a query falhou na validação (`invalid_request`).
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
429 Limite de taxa, depois de o backoff do SDK desistir.
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
500 Um envelope não abriu (`crypto_error`, sem detalhe de propósito).
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
502 O cofre falhou, ou respondeu fora do protocolo (`protocol_error`).
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

curl --cert client.crt --key client.key \
  -X GET "https://api.imgexam.com/v1/exams/<exam_id>?version_id=<string>&include_draft=<boolean>" \
  -H "Content-Type: application/json"

import httpx

response = httpx.get(
    "https://api.imgexam.com/v1/exams/<exam_id>",
    cert=("client.crt", "client.key"),
    params={"version_id": <string>, "include_draft": <boolean>},
)
response.raise_for_status()
print(response.json())

{
  "index": {
    "document_id": "string",
    "workspace_id": "string",
    "resource": "patients",
    "security_group_id": "string",
    "encrypted_keys": {},
    "encrypted_index": {},
    "streams": {},
    "meta": {},
    "created_at": "string",
    "created_by": "string",
    "updated_at": "string",
    "updated_by": {},
    "is_archived": false,
    "is_deleted": false
  },
  "version_id": {},
  "draft_rev": {},
  "record": {
    "title": {},
    "modality": {},
    "exam_date": {},
    "report_lexical": {},
    "report_html": {},
    "custom_attributes": {}
  },
  "summary": {}
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}