Summary

Use the links on this page to quickly navigate to specific sections on this page.

Tag: unauthenticated

Operation Description
GET /_ping Ping API
POST /auth/forgotpassword Password notification API
POST /auth/login Login API
POST /auth/logout Logout API
GET /auth/status Login Status
POST /calendar/events API to get calendar events.

Tag: application

Operation Description
GET /application/settings Application Settings
GET /languages/{appName}/{type} Get available languages for given application and type
POST /languages/sessionLanguage Update session language
GET /languages Application Languages
GET /registration/requiredFields Required fields for registration

Tag: message

Operation Description
GET /messages/{messageID}
POST /messages/{messageID}/archive
POST /messages/{messageID}/unarchive
GET /messages/{messageID}/attachments
POST /messages/archive
GET /messages/attachments/{attachmentID}
GET /messages/attachments/{attachmentID}/{filename}
GET /messages/folders/counts/unread
GET /messages/folders/{folderName}
POST /messages/forms/{formRequestID} Submit form
GET /messages/pharmacies/{pharmacyID}
POST /messages/search/locations
POST /messages/search/pharmacies
POST /messages/search/providers
POST /messages/search/recipients
POST /messages/send/appointmentConfirm
POST /messages/send/appointmentReject
POST /messages/send/appointmentRequest Send Appointment Request
POST /messages/send/generalQuestion Ask General Question
POST /messages/send/medicalQuestion Ask Medical Question
POST /messages/send/refillRequest Medication Refill Request
POST /messages/send/testResultRequest Request test results
POST /messages/send/referralConfirm
POST /messages/send/referralReject
POST /messages/send/referralRequest Send Referral Request
POST /messages/send/reply Send reply to a message
POST /messages/unarchive
GET /users/{userID}/appointmentPreference
GET /users/{userID}/apptPreference

Tag: user

Operation Description
GET /users/{userID}/accountSummary
GET /users/{userID}/accountHistory
GET /users/{userID}/appointmentPreference
GET /users/{userID}/apptPreference
GET /users/{userID}/contactInfo
GET /users/{userID}/devices
POST /users/0/favoriteProviders
DELETE /users/0/favoriteProviders
GET /users/{userID}/proxyData
POST /users/0/changeEmail
POST /users/0/changePassword
GET /users/0/home
POST /users/0/logEvent
GET /users/0/securityQuestions
POST /users/0/securityQuestions
DELETE /users/0/securityQuestions
POST /users/0/switchEffectiveUser
GET /users/0/termsOfUse
POST /users/0/termsOfUse
POST /users/activateUser
POST /users/enroll
POST /users/forgotPassword
POST /users/forgotUsername
GET /users/loginPage
GET /users/passwordRequirements
POST /users/resetPassword
POST /users/validateActivationCode
POST /users/validateResetToken
POST /users/validateStagedUser
POST /users/validateSecurityAnswer
POST /users/validateUsername

Tag: authenticated

Operation Description
POST /auth/delayedLogout Delayed Logout API
POST /auth/logout Logout API
POST /calendar/events API to get calendar events.

Tag: calendar

Operation Description
POST /calendar/events API to get calendar events.

Tag: content

Operation Description
GET /content/layout/{appName}/{documentID}
GET /content/popup/help/{appName}
POST /content/static/{appName}
GET /content/static/{appName}/{documentID}

Tag: document

Operation Description
GET /documents/session
GET /documents/status/{documentID}
POST /documents/upload
GET /ehr/document/download/{documentID} Download a document representing the patient’s medical records.
By default, this only includes HTML and XML document formats, but the currently available formats can be listed by calling the /ehr/document/types API
GET /ehr/document/download/{documentID}/{filename} Download a document representing the patient’s medical records.
By default, this only includes HTML and XML document formats, but the currently available formats can be listed by calling the /ehr/document/types API.
This API is in place to support browsers that behave better for URLs that mimic static files.
GET /ehr/document/ehr/{ehrDocumentID} Download a document that is part of the patient’s medical records.
GET /ehr/document/ehr/{ehrDocumentID}/{filename} Download a document that is part of the patient’s medical records.
This API is in place to support browsers that behave better for URLs that mimic static files.
GET /ehr/document/startDownload Request the patient’s medical records be made available for download in the format specified by the type parameter. Optionally, medical record can be filtered based on startDate and endDate paramters.
GET /ehr/document/ready Poll to see if a requested download is available
POST /ehr/document/transmit Request that the patient’s medical records be sent to a clinician
GET /ehr/document/types

Tag: ehr

Operation Description
GET /ehr/category/advanceDirectives
GET /ehr/category/alerts
GET /ehr/category/allergies
GET /ehr/category/appointments
GET /ehr/category/carePlans
GET /ehr/category/contacts
GET /ehr/category/counts
GET /ehr/category/customObjects
GET /ehr/category/demographics
GET /ehr/category/deviceObservations
GET /ehr/category/diagnosis
GET /ehr/category/documents
GET /ehr/category/encounters
GET /ehr/category/familyHx
GET /ehr/category/goals
GET /ehr/category/healthConcerns
GET /ehr/category/immunizations
GET /ehr/category/insurance
GET /ehr/category/instructions
GET /ehr/category/labOrders
GET /ehr/category/medicalHx
GET /ehr/category/medications
GET /ehr/category/otherOrders
GET /ehr/category/physicalExams
GET /ehr/category/problems
GET /ehr/category/procedures
GET /ehr/category/programMemberships
GET /ehr/category/providers
GET /ehr/category/radOrders
GET /ehr/category/referrals
GET /ehr/category/socialHx
GET /ehr/category/vitals
GET /ehr/chartNames
GET /ehr/dates/{date}
GET /ehr/events
POST /ehr/labChart
GET /ehr/medications
GET /ehr/reference/{context} Search a third party content provider
GET /ehr/summary
POST /ehr/updateCounts
POST /ehr/vitalsChart

Tag: login

Operation Description
POST /ehr/updateCounts
GET /users/loginPage
GET /users/passwordRequirements
POST /users/validateSecurityAnswer

Tag: forms

Operation Description
GET /forms/definitions Retrieve All Form Definitions
GET /forms/definitions/{application} Retrieve All Form Definitions by Application
GET /forms/definitions/{application}/{formKey} Retrieve Specific Form Definition
GET /forms/definitions/{application}/{formKey}/{formVersion} Retrieve Specific Form Definition Version
GET /forms/library Retrieve Public Form Library
POST /forms/data/{application}/unauthenticated/_submit Submit Form Response (Unauthenticated)
GET /forms/data/{application}/{userType}/{userId} Retrieve intermediate form data
POST /forms/data/{application}/{userType}/{userId} Submit intermediate form data
POST /forms/data/{application}/{userType}/{userId}/_submit Submit form directly
GET /forms/data/{application}/{formDataId} Retrieve intermediate form data
POST /forms/data/{application}/{formDataId} Submit intermediate form data
PUT /forms/data/{application}/{formDataId} Update intermediate form data
DELETE /forms/data/{application}/{formDataId} Delete intermediate form data
POST /messages/forms/{formRequestID} Submit form

Tag: library

Operation Description
GET /library/{appName}/feeds
GET /library/{appName}/forms
GET /library/{appName}/news
GET /library/feeds
POST /library/feeds
DELETE /library/feeds