REST API Release Notes
Overview
This page contains information about changes to the Comprehensive Assessment GET REST API over time. The differences are noted with the following information:
Legend
“> note” = added
“> note” = removed
“~ note” = changed
3/2024
> New version (v7) of api was added to the get comprehensive assessment data. The version returns the new data types for questions increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges in the comprehensive assessment alcohol use, barbiturate use, cannabis use, cocaine use, hallucinogen use, heroin use, methadone use, nicotine use, other opiate use, other sedative use, other substance use, solvent and inhalant use, and stimulant use sections.
~ updated js on in appendix b to reflect the new property data types in the comprehensive assessment alcohol use, barbiturate use, cannabis use, cocaine use, hallucinogen use, heroin use, methadone use, nicotine use, other opiate use, other sedative use, other substance use, solvent and inhalant use, and stimulant use sections.
In the alcohol use section, the properties data types updated were increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
In the barbiturate use section, the properties data types updated were increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
In the cannabis use section, the properties data types updated were increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
In the cocaine use section, the properties data types updated were increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
In the hallucinogen use section, the properties data types updated were increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
In the heroin use section, the properties data types updated were increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
In the methadone use section, the properties data types updated were increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
In the nicotine use section, the properties data types updated were increased dose required to get same effect, experiences withdrawal sickness, unable to stop using substance, substance use reduction attempted, use of substance takes up a lot of time, frequently high in dangerous situations, substance use reduction in social activities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
In the otheropiateuse section, the properties data types updated were increaseddoserequiredtogetsameeffect, experienceswithdrawalsickness, unabletostopusingsubstance, substanceusereductionattempted, useofsubstancetakesupalotoftime, frequentlyhighindangeroussituations, substanceusereductioninsocialactivities, substanceuserecurrentproblemswithfamilyfriends, hasusedsubstanceknowingproblemsworsened, and hasstrongurges.
In the othersedativeuse section, the properties data types updated were increaseddoserequiredtogetsameeffect, experienceswithdrawalsickness, unabletostopusingsubstance, substanceusereductionattempted, useofsubstancetakesupalotoftime, frequentlyhighindangeroussituations, substanceusereductioninsocialactivities, substanceuserecurrentproblemswithfamilyfriends, hasusedsubstanceknowingproblemsworsened, and
In the othersubstanceuse section, the properties data types updated were increaseddoserequiredtogetsameeffect, experienceswithdrawalsickness, unabletostopusingsubstance, substanceusereductionattempted, useofsubstancetakesupalotoftime, frequentlyhighindangeroussituations, substanceusereductioninsocialactivities, substanceuserecurrentproblemswithfamilyfriends, hasusedsubstanceknowingproblemsworsened, and hasstrongurges.
In the solventandinhalantuse section, the properties data types updated were increaseddoserequiredtogetsameeffect, experienceswithdrawalsickness, unabletostopusingsubstance, substanceusereductionattempted, useofsubstancetakesupalotoftime, frequentlyhighindangeroussituations, substanceusereductioninsocialactivities, substanceuserecurrentproblemswithfamilyfriends, hasusedsubstanceknowingproblemsworsened, and hasstrongurges.
In the stimulantuse section, the properties data types updated were increaseddoserequiredtogetsameeffect, experienceswithdrawalsickness, unabletostopusingsubstance, substanceusereductionattempted, useofsubstancetakesupalotoftime, frequentlyhighindangeroussituations, substanceusereductioninsocialactivities, substance use recurrent problems with family friends, has used substance knowing problems worsened, and has strong urges.
~ updated json in appendix b to reflect the new property added in the comprehensive assessment addiction treatment history section.
In the addiction treatment history section, the new property added was taking ongoing medication for addiction treatment.
~ updated json in appendix b to reflect the updated property names in the comprehensive assessment additional addiction and treatment items section and completion section.
In the additional addiction and treatment items section, the updated property name changed from number of months since last voluntary abstinence from substance to number of months of last voluntary abstinence from substance.
In the completion section, the updated property names changed from symptoms stabilized during treatment day to symptoms stabilized during treatment day, acceptable levels of care to acceptable levels of care per interviewer, and unacceptable care levels to unacceptable care levels to patient.
~ updated json in appendix f to reflect the new properties added to the common scores, diagnosticstatisticalmanualofmentaldisorders_5_scores, dimension1withdrawalscores, dimension5relapsepotentialscores, dimensional admission criteria results, and dimensions2through6results sections.
In the common scores section, the following properties were added, opioids class is dependent, sedatives class is dependent, and stimulants class is dependent.
In the diagnosticstatisticalmanualofmentaldisorders_5_scores section, the following properties were added, alcohol any use score substance use disorder early remission, alcohol any use score substance use disorder sustained remission, barbiturates score substance use disorder early remission, barbiturates score substance use disorder sustained remission, cannabis score substance use disorder early remission, cannabis score substance use disorder sustained remission, cocaine score substance use disorder early remission, cocaine score substance use disorder sustained remission, hallucinogens score substance use disorder early remission, hallucinogens score substance use disorder sustained remission, heroin score substance use disorder early remission, heroin score substance use disorder sustained remission, methadone score substance use disorder early remission, methadone score substance use disorder sustained remission, nicotine tobacco score substance use disorder early remission, nicotine tobacco score substance use disorder sustained remission, other opiates analgesics score substance use disorder early remission, other opiates analgesics score substance use disorder sustained remission, other score substance use disorder early remission, other score substance use disorder sustained remission, other sedatives hypnotics score substance use disorder early remission, other sedatives hypnotics score substance use disorder sustained remission, solvent inhalants score substance use disorder early remission, solvent inhalants score substance use disorder sustained remission, stimulants score substance use disorder early remission, and stimulants score substance use disorder sustained remission
In the dimension 1withdrawal scores section, the following property was added, opioid treatment services opioid agonist withdrawal gradual taper is met.
In the dimension5relapsepotentialscores section, the following property was added, carelevel_ii_1_intensive outpatient score is met dim five clinically managed ow intensity residential treatment.
In the dimensional admission criteria results section, the following properties were added, care level_i_sustained remission_is biomedical and recovery residence, care level_i_sustained remission_is dual diagnosis enhanced, care level_i_sustained remission_is dual diagnosis enhanced and recovery residence, care level_i_sustained remission_is dual diagnosis enhanced biomedical and recovery residence, care level_i_sustained remission_is met, care level_i_sustained remission_is recovery residence, care level_ii_1_intensiveoutpatientscore intensiveoutpatientandlevel_iii_1, care level_ii_1_intensiveoutpatientscore isdualdiagnosiscapableandlevel_iii_1, care level_ii_1_intensive outpatient score is dual diagnosis enhanced and level_iii_1, and opioid treatment services opioid agonist withdrawal gradual taper is met.
In the dimensions 2 through 6 results section, the following properties were added, care level_i_sustained remission_is bio medical and recovery residence, care level_i_sustained remission_is dual diagnosis enhanced, care level_i_sustained remission_is dual diagnosis enhanced and recovery residence, care level_i_sustained remission_isdualdiagnosisenhancedbiomedicalandrecoveryresidence, carelevel_i_sustained remission_is met, care level_i_sustained remission_is recovery residence, carelevel_ii_1_intensive outpatient score intensive outpatient and level_iii_1, carelevel_ii_1_intensive outpatient score is dual diagnosis capable and level_iii_1, carelevel_ii_1_intensive outpatient score is dual diagnosis enhanced and level_iii_1, and opioid treatment services opioid agonist withdrawal gradual taper is met.
~ updated json in appendix e to reflect the new properties added to the triage assessment score summary data triage care level qualifier scores section. The new properties added are, carelevel2_withdrawalmanagementscore is met and carelevel2wmexceptsta is met.
12/6/22
~ updated json in appendix b to reflect the new property added to the comprehensive assessment psychological interviewer rating section. The new property added in this section is other active psychiatric diagnoses other than substance abuse note.
06/2022
> new version (v6) of api was added to return the new data type for question opioid maintenance therapy read mission medically indicated in the comprehensive assessment opioid treatment services (opioid maintenance therapy) section.
04/25/2021
> new version (v5) of api was added to the comprehensive assessment data. The version returns the new data type for question number of close friends in the comprehensive assessment family and social history section.
~ updated sample json in appendices b,c,d,e, and f to show the properties needed for the minimum datasets. The font colors (red, orange, green, and purple) indicate the dataset requirement.
~ updated json in appendix b to reflect the new properties added to the comprehensive assessment alcohol use, barbiturate use, cannabis use, heroin use, methadone use, nicotine use, other opiate use, other sedative use, other substance use, and stimulant use sections. The new property added in each of these substance used section is has healthcare provider who prescribed help with dose frequency. The new properties added in the heroin use are has healthcare provider prescribed use, heroin which substance use, and was substance taken as prescribed. The new property added in the nicotine use is nicotine which substance use.
11/20/2021
~ updated json in appendix d to reflect the new property added to the triage assessment triage section. The new property in the triage section is interview method.
~ updated json in appendix b to reflect the new property added to the comprehensive assessment alcohol use, barbiturate use, cannabis use, cocaine use, hallucinogen use, heroin use, methadone use, nicotine use, other opiate use, other sedative use, other substance use, solvent and inhalant use, and stimulant use sections. The new property added in each of these substance used sections is substance use brand type name typical usage per day.
08/27/2020
~ updated json in appendix b to reflect the new property added to the comprehensive assessment review section. The new property in the review section is further explanation for final disposition description.
07/31/2020
> new version (v4) of api was added to the comprehensive assessment data. The version returns the new data types for questions has automobile available for use in the comprehensive assessment employment and support section, patient able to safely access needed resources in the comprehensive assessment psychological section interviewer rating subsection, usual living arrangements and is able to locate and get to community resources safely in the comprehensive assessment family and social history section.
~ updated json in appendix b to reflect the new data types for questions, has automobile available for use, patient able to safely access needed resources, usual living arrangements, and is able to locate and get to community resources safely.
~ updated json in appendix b to reflect the new property added to the comprehensive assessment general information section. The new property in the general information section is length in controlled environment.
06/30/2020
> added note for new gender, preferred pronoun, and sex at birth option codes. The gender and preferred pronoun properties are required to create or update a patient. Updated create patient and update patient sample json content to reflect new properties added.
~ updated create patient example workflow to reflect new properties added to create a patient. The new properties are other gender identity, preferred pronoun, and sex at birth.
~ updated json in appendix b to reflect new property added to the comprehensive assessment family and social history section. The new property is abuseneglectriskanyresultingactionstakenbyinterviewersupervisorstaffdescription.
04/07/2020
> added “get ehr organization assessment” service.
03/25/2020
> new version (v3) of api was added to the comprehensive assessment data. The version returns the new data type for the question requires medical monitoring for reemergence of symptoms in the comprehensive assessment medical section.
~ updated json in appendix b to reflect the new data type for the question requires medical monitoring for reemergence of symptoms.
02/19/2020
> added “get patient” service.
12/31/2019
~ updated json in appendix b to reflect new properties added to the comprehensive assessment and comprehensive assessment legal section. The new properties in the assessment are completed system account key and time zone. The new property in the legal section is have been arrested or charged for any reason.
~ updated json in appendix b to update property labels
- In the comprehensive assessment review section, the property was renamed from satisfaction with time to complete interview to satisfaction with time to complete interview.
- In the comprehensive assessment alcohol use section, the properties were renamed from last used to intoxification to last used to intoxication and number of months as alcohol consumer to intoxication to number of months used to intoxication in lifetime.
- In the comprehensive assessment other opiate use section, the property was renamed from receiving ongoing maintenance therapy to taking opioid analgesics.
- In the comprehensive assessment family and social history section, the property was renamed from months lived in the searrangement to months in this living arrangement.
~ updated json in appendix d to reflect new properties added to the triage assessment. The new properties in the assessment are completed system account key and time zone.
11/2019
~ updated json in appendix b to reflect new properties added to the comprehensive assessment medical section. The two new properties are has blood pressure been assessed obtained has heart rate been assessed obtained.
09/17/2019
~ new version (v2) of api was added to the comprehensive assessment data. The new version leaves optional questions blank and will not default values to questions.
~ updated json in appendix b and d to reflect new property added to the review section. The new property is additional categories of final disposition.
08/06/2019
~ updated for asam intellectual property information.
2017
> new items added to the comprehensive assessment score detail (sample in appendix f) as new levels of care have been created.
> added notes for access to the narrative report for the comprehensive assessment. The notes were added under the get assessment report section.
2016
> added appendices d and e showing sample json data for triage assessment data and triage assessment scores summary data, respectively.
> added “get assessment types” service.
~ updated all assessment related services to now require the assessment type as part of the url.
> added “get assessment summary” service. The purpose of this service is to allow for getting status information about the assessment without having to load the entire assessment.
~ added “get assessment score summary” service. This service gives a summary of the results that are shown on the report.
> added workflow section.
~ user email is now required for all requests.
~ Timestamp is now required for all requests, format uses standard RFC 1123 “ddd, dd MMM yyyy HH’:’mm’:’ss ‘GMT’”
