Documents

Get a Document

Read a document's metadata. Fetch the document's contents via /documents/{documentId}/content.

get/documents/{documentId}

Request

  • Base URL: https://api.xcures.com/v3
  • URL: https://api.xcures.com/v3/documents/{documentId}
  • Auth: HTTP bearer

Path parameters

documentIdstring uuid required

The document's id.

Headers

ProjectIdstring required

The project the document belongs to.

Response

The document's metadata.

idstring uuid required

The document's id.

patientIdstring uuid required

The id of the patient the document is about.

namestring nullable

The document's display name; null when none was recorded.

fileNamestring required

The file's name.

contentTypestring nullable

The file's media type; null when none was recorded.

sourcestring nullable

How the document arrived; today one of fhir, ccda, box, userUpload or patientFhir, or null when none was recorded.

sourceIdstring nullable

The source system's own id for the document; null when the source gave none.

documentDatestring date-time nullable

The clinical date of the document; null when none was recorded.

createdAtstring date-time required

When the record was created.

updatedAtstring date-time required

When the record was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.