SageBridge API - DocumentSummary data structure

Clinical Summary Document

Data to represent Clinical Summary document in PostClinicalSummaryRequest of PostClinicalSummary function. Based on Document data.

Clinical Summary 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.
xsltType	(string)	Style file name associated with document. Applicable for Charts and Clinical Summaries.

Notes:

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.
xsltType is required only for Charts and Clinical Summary. Please contact Sophrona to agree about specific XSLT what will be used to present documents to a patient. If not presented, default value will be used.
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.

Clinical Summary example:

XML (Note: File Content is escaped) JSON

{
    "documentId": "8F497F61-4A5C-4D3A-BEAC-C1F9E9A7F321",
    "documentName": "Your Visit Summary",
    "xsltType": "MySummaryXSLT",
    "mimeType": "text/xml",
    "formatTypeId": 2,
    "fileContent": "\u003cClinicalDocument xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"urn:hl7-org:v3 CDA_SDTC.xsd\" xmlns=\"urn:hl7-org:v3\" xmlns:cda=\"urn:hl7-org:v3\" xmlns:sdtc=\"urn:hl7-org:sdtc\"\u003e\r\n\u003crealmCode code = \"US\" /\u003e\r\n\u003ctypeId root=\"2.16.840.1.113883.1.3\" extension=\"POCD_HD000040\" /\u003e\r\n\u003ctemplateId root = \"2.16.840.1.113883.10.20.22.1.1\" /\u003e\r\n\u003ctemplateId root=\"2.16.840.1.113883.10.20.22.1.2\" /\u003e\r\n\u003cid extension = \"102\" root=\"02639d71-0935-35e8-9d1b-9dd1a2a34627\" /\u003e\r\n\u003ccode codeSystem = \"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\" code=\"34133-9\" displayName=\"Summarization of Episode Note\" /\u003e\r\n\u003ctitle\u003ePrimo Adult Health: Health Summary\u003c/title\u003e\r\n\u003ceffectiveTime value = \"20130806021213\" /\u003e\r\n\u003cconfidentialityCode code= \"N\" codeSystem= \"2.16.840.1.113883.5.25\" /\u003e\r\n\u003clanguageCode code= \"en-US\" /\u003e\r\n\r\n\u003cetc \u003e ---TRUNCATED CLINIC DOCUMENT DATA --\u003c/etc\u003e\r\n\r\n\u003c/ClinicalDocument\u003e",
    "createdTs": "\/Date(1474169257373)\/"
}

Data used in Chart and Clinical Summary examples:

Document Formats:

1 - Binary File (pdf, jpg etc.)
2 - Text File (any text-based files, include CCD and CCDA documents)