Passer au contenu
API referenceDocuments

Get a visit document

Fetch a visit document by id (Phase 3). Requires `documents:read` and a token obtained with `private_key_jwt` or mTLS; documents are available for 72 hours.

Cette page n'est pas encore offerte en français; elle est affichée en anglais.
GET
/v1/documents/{documentId}

Fetch a visit document by id (Phase 3). Requires documents:read and a token obtained with private_key_jwt or mTLS; documents are available for 72 hours.

Authorization

oauth2 documents:read
AuthorizationBearer <token>

OAuth 2.0 client credentials. private_key_jwt (SMART Backend Services asymmetric) is recommended; client secrets need an IP allowlist or mTLS outside the sandbox.

In: header

Scope: documents:read

Path Parameters

documentId*string

An opaque doc_ id.

Match^doc_[0-9A-Za-z]{16,64}$

Header Parameters

Api-Version?enum

Overrides the app's pinned dated version for this request.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/documents/doc_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e"
{  "availableUntil": "2026-09-14T15:00:11.402Z",  "contentType": "application/json",  "createdAt": "2026-09-14T15:00:11.402Z",  "encounterId": "enc_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",  "entries": [    {      "at": "2026-09-14T15:00:11.402Z",      "channel": "request",      "kind": "string"    }  ],  "id": "doc_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",  "kind": "communication_log",  "object": "document"}

Cette page vous a-t-elle été utile?

List code alerts GET

Department code alerts (default: active). `area` is omitted when the site turns `integration.api.includeCodeArea` off.

Get an encounter's care team GET

The current care team. Zone-derived nurses are computed at read time (`id: null`, `source: zone`). Staff hidden from patients are listed with `hiddenFromPatients: true`.