Document Reference

A document reference is a type which is used to reference a Document item or up to two Document items for an attachment from within another structured message. For documents, the draft fields are used to store the information and the final fields are not used. The document content is stored separately.

Name	Type	Description
attachmentId	string	A unique ID for the attachment assigned by the IRB Exchange
category	string	The attachment category name also used as its ID
draftDateModified	date	The date the draft document was modified
draftFileName	string	The original name of the draft file.
draftId	string	The path to the draft Document that is relative to the items endpoint. Assigned by the IRB Exchange.
draftInitialSiteId	string	The path to the draft Document on a site modification's parent site that is relative to the items endpoint. Assigned by the IRB Exchange. Used for tying site modification documents to their originals on the initial site.
draftName	string	The friendly name of the draft file.
draftVersion	string	The version of the draft file.
finalFileName	string	The original name of the final file.
finalId	string	The path to the final Document that is relative to the items endpoint. Assigned by the IRB Exchange.
finalInitialSiteId	string	The path to the final Document on a site modification's parent site that is relative to the items endpoint. Assigned by the IRB Exchange. Used for tying site modification documents to their originals on the initial site.
finalName	string	The friendly name of the final file.
finalVersion	string	The version of the final file.
originalAttachmentId	string	The original unique ID for the attachment from the participating site assigned by the IRB Exchange. This is used for documents finalized by the single IRB of record on their site and site modification records that they upload to IRB Exchange so they participating site can tie them back to their original documents.

Full Attachment Example

{
    "attachmentId": "documents/47086805f7dc4966b4a0c8736b7e32c4",
    "category": "Device Attachment",
    "draftDateModified": "8/23/2017 7:04:02 PM +00:00",
    "draftFileName": "Test.txt",
    "draftId": "documents/47086805f7dc4966b4a0c8736b7e32c4/draft",
    "draftInitialSiteId": "documents/65486805f7dc4966b4a0c8736b7e34t5/draft",
    "draftName": "Test.txt",
    "draftVersion": "0.01",
    "finalFileName": "Test.pdf",
    "finalId": "documents/47086805f7dc4966b4a0c8736b7e32c4/final",
    "finalInitialSiteId": "documents/65486805f7dc4966b4a0c8736b7e34t5/final",
    "finalName": "Test.pdf",
    "finalVersion": "0.01"
}

sIRB Finalized Document Example

{
    "attachmentId": "documents/47086805f7dc4966b4a0c8736b7e32c4",
    "category": "Consent Form",
    "finalFileName": "Test.pdf",
    "finalId": "documents/47086805f7dc4966b4a0c8736b7e32c4/final",
    "finalInitialSiteId": "documents/65486805f7dc4966b4a0c8736b7e34t5/final",
    "finalName": "Test.pdf",
    "finalVersion": "0.01",
    "originalAttachmentId": "documents/92462005f7dc4966b4a0c8736b7eh4rg"
}