Skip to main content

Document

A Document is an encryptable root-level entity that represents any kind of medical document, from reports to medical imaging results.

Differently from the other entities, the Document is designed to manage big files, that are stored as attachments of this entity. Each Document can have a main attachment and multiple secondary attachments, that are fully encrypted before being sent on the cloud. You can read more about store big files in Cardinal here.

Fields Encrypted by Default​

In this entity, no field is encrypted by default. You can customize the encrypted fields as explained in this how to.

Properties​

Below you will find an explanation of the most commonly used properties in the entity that are not among the shared fields. For a full list, check the reference documentation (🚧).

attachmentId​

The id of the main attachment of this document. This is an internal field managed by the Cardinal SDK that is part of the mechanism to store big files. Do not modify this field directly. For more information about attachments and how to store big files in Cardinal, check this how to.

decryptedAttachment​

This is an internal field managed by the Cardinal SDK. Do not modify it manually

deletedAttachments​

A summary of all the attachments of this document that were deleted.

encryptedAttachment​

This is an internal field managed by the Cardinal SDK. Do not modify it manually

mainUti​

The UTI of the main attachment of the Document.

name​

The name of the Document as free text.

objectStoreReference​

This is an internal field managed by the Cardinal SDK that is part of the mechanism to store big files. Do not modify this field directly. For more information about attachments and how to store big files in Cardinal, check this how to.

openingContactId​

The id of the Contact that represent the encounter where this document was created.

otherUtis​

Any other UTI that can be associated to the main attachment of this Document.

secondaryAttachments​

This data structure associates the id of any secondary attachment of the Document with the metadata needed to store it. This is a field managed internally by the Cardinal SDK and you should not modify it manually. For more information about storing and retrieving secondary attachments, check this how to.

size​

The size of the Document, in bytes.

version​

The version of the Document.