Octachat

Octachat

APIDescription
POST OctachatWebhook

Capture posted chat session event from Octachat.

TruFormSubmission

Provides the ability to retrieve patient information (submissions) that were gathered via truForm. The list methods will return submissions that are: incomplete or complete and are not archived. Please use the post/update method below to archive submissions. You will continue to receive records in your requests until you mark them as Archived.

APIDescription
GET truformsubmissions

Gets a list of truform submission (patient registration) objects that have not been marked as integrated.

GET truformsubmission/{id}

Get submission data (form field values) as a json string. If the particular item is not found, a message with a 404 will be returned. LEGACY NOTE: This function is not supported for TruForm legacy data.

GET truformsubmission/{id}/pdf

Get submission data (form field values) as a base64-encoded string that represents a pdf.

GET truformsubmission/{id}/custom

Get submission data (form field values) as a base64-encoded string that represents a custom text file. This file is may be formated XML, HL7 or other and is created during the account setup by pbhs. LEGACY NOTE: A TruForm Legacy submission will be automatically removed from the list of submissions in GET TruFormSubmission if this method is used to extract the custom data format.

GET truformsubmission/{submissionId}/Attachment/{attachmentId}

Gets a particular submission Attachment file.

POST truformsubmission

Updates a submission. Only the "Integrated" property can be updated, all other properties are read-only. Setting the "Integrated" property to True will cause this submission to no longer appear in the list returned from GET truformsubmission. LEGACY NOTE: This function is not supported for TruForm legacy data.

Message

APIDescription
GET messaging/inbox/{type}

No documentation available.

GET messaging/inboxunreadcount

No documentation available.

GET messaging/messagethread/{messageThreadId}

No documentation available.

GET messaging/inbox/paged/{type}?page={page}

No documentation available.

GET messaging/messagethread/{messageThreadId}/paged

No documentation available.

POST messaging/messagethread/{messageThreadId}/archive

No documentation available.

POST messaging/messagethread/archive

No documentation available.

POST messaging/messagethread/{messageThreadId}/reply

No documentation available.

POST messaging/messagethread/compose

No documentation available.

GET messaging/attachment/{attachmentId}

No documentation available.

GET messaging/addressbook?search={search}

No documentation available.

POST messaging/messagethread/delete

No documentation available.

POST messaging/register

No documentation available.

GET messaging/emailexists?email={email}

Checks to see if a user (email) is in the system.

Case

Provides the ability to retrieve Collaborator Case information. The list methods will return Cases that are: incomplete or complete and are not integrated. Please use the post/update method below to integrate Cases. You will continue to receive records in your requests until you mark them as Integrated.

APIDescription
GET Cases

Gets a list of Cases this user is associated with as a Doctor that have not been marked as integrated.

POST Cases/Create

Creates a case.

POST Case

Updates a Case. Only the "Integrated" property can be updated, all other properties are read-only. Setting the "Integrated" property to True will cause this Case to no longer appear in the list returned from GET Case.

GET Case/{id}

Gets the details of a particular Case

GET Case/Doctor?firstName={firstName}&lastName={lastName}

Fetches the first doctor matching the provided first and last name .

PUT CaseHisp/{id}

Pushes the details of a particular Case to a Hisp User including attachments

GET Case/Attachment/{id}

Gets a particular Case Attachment file as a base64-encoded string.

PUT Case/{id}/Attachment

PUT: Adds a new file Attachment to a particular Case. Ensure that the data being sent is as a base64-encoded string.

POST Case/{id}/Attachment

POST: Adds a new file Attachment to a particular Case. Ensure that the data being sent is as a base64-encoded string.

User

Provides the ability to make certain modifications to a User account.

APIDescription
POST user

Update properties of the User. Current use is for updating a user's password, which requires Username, Password and NewPassword to be set by the client. This function can be performed in the MyPbhs portal as well. This method is offered for the convenience of the developer who wishes to integrate password changes into their system for when a User's password has expired. If you receive an error response, check the body for a Message which you can use to determine what the problem was. Password_Invalid_Format: The new password does not meet the criteria of a strong password (Must include lower case letters, upper case letters, numbers, non-alphanumeric characters). PasswordLengthTooShort: The new password is too short (8 characters is the current minimum). ChangePasswordNotContainNameOrEmail: The new password contains substrings of the User’s first name, last name or email. ChangePasswordMustRecyclePassword: The new password has already been used by this User previously.

PUT user

Adds a new User as a Patient. The Patient will have an associated TruForm partially filled out with the given information and will receive an email informing them of their new account at MyPbhs and the outstanding TruForm to finish filling out.

GET user/emailexists?email={email}

Checks to see if a user (email) is in the system.

GET user/settings

Fetches some settings info for users that might be relevant to functionality available to them.

GET user/settingsnotios

Fetches some settings info for users that might be relevant to functionality available to them.

GET user/settingsoutlook

Fetches some settings info for users attempting to log in to the PBHS Outlook plugin.