PostEducationalDocumentsRequest

Data container to represent request for PostEducationalDocuments function.
PostEducationalDocumentsRequest data has following elements:
apptId(string)Related appointment ID.
apptTs(string)Appointment date and time.
providerId(string)Appointment provider ID.
patientInfo(object)Patient information. See PATIENT data.
patientEducationalDocuments(array)Patient Educational Documents. See EducationalDocument data for more details.
Notes:
  • 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.
    See PostEducationalDocumentsResponse for more details.

XML Example:

JSON 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"
        }
    ]
}

See also:

API Data, PostEducationalDocuments function , PostEducationalDocumentsResponse data , EducationalDocument data