SageBridge API - EducationalDocument data structure

Educational Document

Data to represent different documents such as Charts, Clinical Summaries, Educational Documents, Message Attachments etc.

Document data has following elements:

documentId	(string)	Unique document id. This value will be used in a response if ArticleID is available
documentName	(string)	User-friendly document description to show on the screen.
formatTypeId	(int)	See Document Formats below.
originalFileName	(string)	Original file name with extension, if applicable. Will be used to select correct handler when showing to a patient.
mimeType	(string)	Defines mime type associated with document. Helpful when extension of original file name is not available.
fileContent	(string)	Body of document. If document is binary, use Base64 representation.
createdTs	(datetime)	Original file/document creation timestamp. This field is nullable.
documentTypeId	(int)	See Document Types below.

Notes:

Set documentTypeId correctly b/c it may affect MU2 counters.
If document is a text-based HTML document, use "text/html" as mimeType value.
For any other types of documents set mimeType as defined in this document.
fileContent string can be encoded as Base64 even for text files such as Chart or Clinical Summaries. SageBridgeAPI will automatically detect it and convert it back to a string. It can be useful when content has some XML or JSON tags what can break serialization.
formatTypeId value "4" (ArticleID) - fileContent and mimeType parameters are not required. documentId represents previously saved document.
formatTypeId value "5" (AAO ArticleID) - fileContent and mimeType parameters are ignored. documentId represents AAO ArticleId. See list of available AAO articles

Educational Document Types:

3 - EducationalDocument
9 - SmokingCessation
10 - PreventativeCare

Document Formats:

1 - Binary File (pdf, jpg etc.)
2 - Text File (any text-based files, include CCD and CCDA documents, plain text, XML, HTML etc.)
3 - Url/hyperlink (specifies that document body is a hyperlink to any http accessible resourse)
4 - AtricleId (to specify practice pre-defined educational articles from a library. Set documentId as value of ArticleId)
5 - AAO Article ID. (for educational documents only). See list of available AAO articles

Educational Document (PDF) example:

XML JSON

{
    "documentId": "66744316-FD01-4637-918C-0B0033A81A4C",
    "documentTypeId": 3,
    "formatTypeId": 1,
    "documentName": "Some PDF file for patient",
    "originalFileName": "SBInterface.pdf",
    "mimeType": "application/pdf",
    "fileContent": "TwBuAGwAaQBuAGUAIABQAGEAdABpAGUAbgB0ACAAQwBvAG0AbQB1AG4AaQBjAGEAdABpAG8AbgAgAFUAbgBpAHEAdQBlAGwAeQAgAEQAZQBzAGkAZwBuAGUAZAAgAGYAbwByACAATwBwAGgAdABoAGEAbABtAG8AbABvAGcAeQANAAoAVABlAG4AIAB5AGUAYQByAHMAIABhAG4AZAAgAGcAcgBvAHcAaQBuAGcAIABzAHQAcgBvAG4AZwAsACAAUwBvAHAAaAByAG8AbgBhACAAcwBlAHQAcwAgAHQAaABlACAAcwB0AGEAbgBkAGEAcgBkACAAaQBuACAAbwBuAGwAaQBuAGUAIABwAGEAdABpAGUAbgB0AC0AcABoAHkAcwBpAGMAaQBhAG4AIABjAG8AbQBtAHUAbgBpAGMAYQB0AGkAbwBuACAAcwBlAHIAdgBpAGMAZQBzACAAYQBuAGQAIAB0AGUAYwBoAG4AbwBsAG8AZwB5ACAAZgBvAHIAIABvAHAAaAB0AGgAYQBsAG0AbwBsAG8AZwB5AC4ADQAKAFMAbwBwAGgAcgBvAG4AYQAgAGkAcwAgAHQAaABlACAAcABvAHcAZQByACAAYgBlAGgAaQBuAGQAIAB0AGgAZQAgACMAMQAgAGMAaABvAGkAYwBlACAAbwBmACAAbgBlAGEAcgBsAHkAIAAyACwAMAAwADAAIABlAHkAZQAgAGQAbwBjAHQAbwByAHMAIABhAG4AZAAgAGMAbABpAG4AaQBjAGEAbAAgAHMAdABhAGYAZgAgAG4AYQB0AGkAbwBuAHcAaQBkAGUALgANAAoAUABhAHIAdABuAGUAcgBpAG4AZwAgAHcAaQB0AGgAIABsAGUAYQBkAGkAbgBnACAAcAByAGEAYwB0AGkAYwBlACAAbQBhAG4AYQBnAGUAbQBlAG4AdAAgAGEAbgBkACAAZQBsAGUAYwB0AHIAbwBuAGkAYwAgAG0AZQBkAGkAYwBhAGwAIAByAGUAYwBvAHIAZABzACAAcAByAG8AdgBpAGQAZQByAHMALAAgAFMAbwBwAGgAcgBvAG4AYQAgAGQAZQBsAGkAdgBlAHIAcwAgAGkAbgBuAG8AdgBhAHQAaQB2AGUAIABzAG8AbAB1AHQAaQBvAG4AcwAgAHAAdQByAHAAbwBzAGUAIABiAHUAaQBsAHQAIAB0AG8AIABpAG4AYwByAGUAYQBzAGUAIABwAHIAbwBmAGkAdABzACAAYQBuAGQAIABwAGEAdABpAGUAbgB0ACAAZQBuAGcAYQBnAGUAbQBlAG4AdAAuAA==",
    "createdTs": "\/Date(1442633257503)\/"
}

Educational Document (Hyperlink) example:

XML JSON

{
    "documentTypeId": 3,
    "formatTypeId": 3,
    "documentId": "B7F7BF7B-C09E-4911-BBB1-0589DF32A955",
    "documentName": "What is migraine?",
    "fileContent": "http://dev.quickappointments.com/AAOPatientEducation/Migraine_09-13_FINAL.pdf" 
}

Educational Document (Article ID) example:

documentId represent pre-defined Article Id.
XML JSON

{
    "documentTypeId": 3,
    "formatTypeId": 4, 
    "documentId": "0639009A-BBF6-4193-B51E-B6AC27173A9D",
    "documentName": "Article about vision quality",
}

Educational Document (AAO Article ID) example:

documentId represent pre-defined AAO Article Id - see List of available AAO Articles.
XML JSON

{
  "documentTypeId": 3,
  "formatTypeId": 5,
  "documentId": "261",
  "documentName": "Ischemic Optic Neuropathy"
}