GetDocuments

Returns the list of document for a specific patient.

JavaScript library method

patientportal.documents.getDocuments({
    patient: <patient>,
    name: <name>,
    createdFrom: <created-from>,
    createdTo: <created-to>,
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb	URL
GET	/patientportalapi/documents/documents

URL Parameters

Parameter	Type	Description
patient	string	The key of the patient provided by the API upon GetPatients.
name	string (optional)	Filters the documents by the name.
created-from	DateTime (optional)	Filters the documents by the created data.
created-to	DateTime (optional)	Filters the documents by the created data.
page-sort-column	int (optional)	The column index to sort the result: 0 – Name 1 – Created date Default: 0
page-sort-descending	int (optional)	True to sort result descending.
page-number	int (optional)	Required page number. Default 1.
page-size	int (optional)	Required page size. Default 10. Minimum 5. Maximum 50.

Returned JSON

{
    "Items": [
        {
            "Name": "Referral letter.html",
            "Author": "Mr. Will Smith",
            "Comments": "I would like to refer Mr. John Smith",
            "DateCreated": "2015-03-13T14:22:12.483",
            "Url": "https://api.meddbase.com/referrals/download?d=123",
            "MIMEType": "text/html",
            "Size": 20824,
            "PatientKey": "iydksy58dujyhiee78",
            "DocumentTypeName": "Portal Documents"
        }
    ],
    "TotalCount":1,
    "CurrentPage":1,
    "PageSize":10,
    "SortColumn": 0,
    "SortDescending": false
}