Retrieve Document resources meeting the specified search criteria

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use Authentication Endpoint page to get token

Query Params
string

Number of records to use as the page size for paginated search. The maximum page size for this Resource is 10

date

The original upload date in format of yyyy-MM-dd'T'HH:mm:ss.SSSSSSSZ

string

File extension type, this is an optional field, e.g. ccda, note

string

File title, this is an optional field

string

Context of the document content

string

Document reference identifier, can be search by filename passing the identifier filename and the value in format filename|value. This is an optional field

string

Page to be used for paginated search

string
required

Patient reference url in format : /resoucrename/id or id, this is a mandatory field.

string

Composite Request ID

string

File extension type, this is an optional field e.g. type=pdf

Responses

400

BAD REQUEST - The request was bad, often due to a missing required parameter

401

NOT AUTHORIZED - Authentication error; this token is not allowed access to the API

403

FORBIDDEN

404

NOT FOUND

422

UNPROCESSABLE ENTITY - Request could not be processed; typically a validation error

429

TOO MANY REQUESTS - Request was rate limited (1000 calls/min default); please retry

500

SERVER ERROR - Internal Server Error

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json