PostEducationalDocuments

Call example:

string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"PostEducationalDocuments",                    
"bos5",                                 // practice Path or Tax ID
"JSON",                                 // output format (XML or JSON)
"--request parameters XML or JSON---"   // request parameters
);

• For more details about patientInfo see PATIENT data.
• For more details about educationalDocuments see EducationalDocument data.
• Documents with formatTypeId values "1" (Binary File) or "2" (Text File) will be saved into practice articles library.
  Response will provide assigned articleId value for each saved document. Assigned articleId value then can be used later to post documents with formatTypeId value 4 (Article Document).
• Documents with formatTypeId values "1" (Binary File) or "2" (Text File) will be checked for duplicates.
  If document already exists in practice library, it will return the same articleId value as assigned before.

Request example:

{
    "apptId": "09238409",
    "apptTs": "09/18/2016 11:30",
    "providerId": "2",

    "patientInfo": {
        "patientID": "TS01831451",
        "patientNbr": "TS01831451",
        "last": "Galt",
        "first": "John",
        "middle": "",
        "birthdate": "01/01/1965",
        "sex": "M",
        "maritalStatus": "S",
        "preferredLanguage": "en",
        "address": { "addr1": "1 Park Ave", "addr2": "Unit 203", "city": "Sunny Town", "state": "IL", "zip": "09111", "zip4": "", "country": "us" },
        "contactInfo": { "phone": "8005551212", "cell": "8005551313", "work": "8005551414", "workExt": "9003", "email": "some@dadada.net" }
    },

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

        },
        {
            "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"

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

Response example:

{
    "code": 0,
    "message": "All Done",
    "level": 0,

    "articles": [
        { "documentId": "66744316-FD01-4637-918C-0B0033A81A4C", "articleId": "e82d2144-cc33-4a2b-99f8-316406937cdd" }
    ],

    "logs": [
        { "itemTypeId": 5, "itemId": "TS01831451", "code": 0, "message": "Patient located", "level": 0 },
        { "itemTypeId": 3, "itemId": "66744316-FD01-4637-918C-0B0033A81A4C", "code": 0, "message": "Document saved", "level": 0 },
        { "itemTypeId": 3, "itemId": "B7F7BF7B-C09E-4911-BBB1-0589DF32A955", "code": 0, "message": "Articles not supported for this type", "level": 0 },
        { "itemTypeId": 3, "itemId": "0639009A-BBF6-4193-B51E-B6AC27173A9D", "code": 0, "message": "Articles not supported for this type", "level": 0 },
        { "itemTypeId": 3, "itemId": "B7F7BF7B-C09E-4911-BBB1-0589DF32A955", "code": 0, "message": "Document saved", "level": 0 },
        { "itemTypeId": 3, "itemId": "0639009A-BBF6-4193-B51E-B6AC27173A9D", "code": 0, "message": "Document saved", "level": 0 }
    ]
}
    

Possible return values (see APIResponse )

• 0 - Success. Description can be vary per function
• -1 - General error. Description attribute will show more details about an error
• -2 - Function is not supported
• 500 - Invalid credentials provided
• 501 - License is expired
• 502 - License is not active
• 503 - Token is not active or expired
• 550 - Unknow functionName or not subscribed
• 551 - Unknown practice
• 552 - No Subscription found
• 553 - Subscription is inactive or expired
• 600 - Invalid or empty request parameters
• 601 - No valid route found for this subscription
• 602 - Unable to parse request parameters

Notes:

Known Issues:

See Also: