May 2020

almost 4 years ago by Brett Cooke
  • Major Added the new 'Protocol' interview mode. See [interview documentation] for more information.
    • To use the new protocol mode:
      • If you're using the complaint_mode field to see which mode your are on you need to change this field to mode that is of string value.
      • To make use of the new protocol mode, your client will begin in “complaint” mode when an interview is initialized. After the end-user is done entering complaints, the client should set the mode value to “protocol”. If there are protocol-based questions, the API will direct the client to the next question link. If there are no protocol based questions for that interview, the API will direct the client to set the mode field to “differential” to continue to the interview in differential mode.
    • Triage has been renamed to Differential for clarity.
    • Protocol is for rule-based questioning.
    • Customers can now choose when to add the protocol functionality (if ever).
  • Major Added 'protocol-based' results. See [interview documentation] for more information.
    • In earlier versions results were condition-based, meaning the triage recommendations were based on the differential, and some dangerous symptoms were presented as conditions for the purpose of triage. With this update we add protocol-based results, meaning that the triage recommendation are now based on a specific set of protocol rules set by Buoy's medical team, and the condition content may not be present.
    • differential can be empty in some instances in protocol-based results.
    • Additionally, this adds a new triage_explanation field that contains an explanation field for triage that has resulted, and a potential_diagnosis field that contains information on the potential diagnosis, such as name, overview, and triage information.
    • An example use of protocol mode is triaging for COVID-19. With protocol mode enabled, and a user presenting with a cough, fever, or other symptoms related to COVID-19, the line of questioning will attempt to rule out COVID-19 before assessing for anything else. You will need to leverage protocol mode if you want your client to screen for COVID-19.

April 2020

about 4 years ago by Brett Cooke
  • Added the 'exclusive' attribute to options. See the questions documentation for more information.

March 2020

about 4 years ago by Brett Cooke
  • Updated 'Pre-selected Answers' to forbid preselected answers. This means if preselected is not null, to not submit the answer. Originally, if preselected is true we must submit the answer, and if preselected is false we must not submit. Be sure to ignore preselected options that are submitted as answers (instead of raising error).

January 2020

over 4 years ago by Brett Cooke
  • Added NPS, Intents, and Feedback APIs.
  • Added the question_peek endpoint.
  • Updated the documentation UI and content.

December 2019

over 4 years ago by Brett Cooke
  • Added an optional 'tag' field to the profiles representation.
  • Simplified the auth documentation.
  • Added self-care advice content to results representation.
  • Added Location Information section.
  • Updated interview expiration time to thirty minutes.

October 2019

over 4 years ago by Brett Cooke
  • Added the Known Issues section.
  • Documented the 'D' choice for questions.

September 2019

over 4 years ago by Brett Cooke
  • Added missing fields to AnonymousProfile schema.
  • Documented interview expiration times.
  • Added note about trailing slashes.

August 2019

over 4 years ago by Brett Cooke
  • Updated queries documentation and schema.
  • Added 204 response code to results.