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 IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges in the Comprehensive Assessment AlcoholUse, BarbiturateUse, CannabisUse, CocaineUse, HallucinogenUse, HeroinUse, MethadoneUse, NicotineUse, OtherOpiateUse, OtherSedativeUse, OtherSubstanceUse, SolventAndInhalantUse, and StimulantUse sections.

~ Updated JSON in Appendix B to reflect the new property data types in the Comprehensive Assessment AlcoholUse, BarbiturateUse, CannabisUse, CocaineUse, HallucinogenUse, HeroinUse, MethadoneUse, NicotineUse, OtherOpiateUse, OtherSedativeUse, OtherSubstanceUse, SolventAndInhalantUse, and StimulantUse sections. 

In the AlcoholUse Section, the properties data types updated were IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges. 

In the BarbiturateUse Section, the properties data types updated were IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges. 

In the CannabisUse Section, the properties data types updated were IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges. 

In the CocaineUse Section, the properties data types updated were IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges. 

In the HallucinogenUse Section, the properties data types updated were IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges. 

In the HeroinUse Section, the properties data types updated were IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges. 

In the MethadoneUse Section, the properties data types updated were IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges. 

In the NicotineUse Section, the properties data types updated were IncreasedDoseRequiredToGetSameEffect, ExperiencesWithdrawalSickness, UnableToStopUsingSubstance, SubstanceUseReductionAttempted, UseOfSubstanceTakesUpALotOfTime, FrequentlyHighInDangerousSituations, SubstanceUseReductionInSocialActivities, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges. 

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, SubstanceUseRecurrentProblemsWithFamilyFriends, HasUsedSubstanceKnowingProblemsWorsened, and HasStrongUrges.

~ Updated JSON in Appendix B to reflect the new property added in the Comprehensive Assessment AddictionTreatmentHistory section.

In the AddictionTreatmentHistory section, the new property added was TakingOngoingMedicationForAddictionTreatment.

~ Updated JSON in Appendix B to reflect the updated property names in the Comprehensive Assessment AdditionalAddictionAndTreatment Items Section and CompletionSection. 

In the AdditionalAddictionAndTreatmentItems Section, the updated property name changed from NumberOfMonthsSinceLastVoluntaryAbstinenceFromSubstance to NumberOfMonthsOfLastVoluntaryAbstinenceFromSubstance. 

In the CompletionSection, the updated property names changed from SymptomsStabalizedDuringTreatmentDay to SymptomsStabilizedDuringTreatmentDay, AcceptablelevelsOfCare to AcceptableLevelsOfCarePerInterviewer, and UnacceptableCareLevels to UnacceptableCareLevelsToPatient.

~ Updated JSON in Appendix F to reflect the new properties added to the CommonScores, DiagnosticStatisticalManualOfMentalDisorders_5_Scores, Dimension1WithdrawalScores, Dimension5RelapsePotentialScores,  DimensionalAdmissionCriteriaResults, and Dimensions2Through6Results sections. 

In the CommonScores section, the following properties were added, OpioidsClassIsDependent, SedativesClassIsDependent, and StimulantsClassIsDependent.

In the DiagnosticStatisticalManualOfMentalDisorders_5_Scores section, the following properties were added, AlcoholAnyUseScore SubstanceUseDisorderEarlyRemission, AlcoholAnyUseScore SubstanceUseDisorderSustainedRemission, BarbituratesScore SubstanceUseDisorderEarlyRemission, BarbituratesScore SubstanceUseDisorderSustainedRemission, CannabisScore SubstanceUseDisorderEarlyRemission, CannabisScore SubstanceUseDisorderSustainedRemission, CocaineScore SubstanceUseDisorderEarlyRemission, CocaineScore SubstanceUseDisorderSustainedRemission, HallucinogensScore SubstanceUseDisorderEarlyRemission, HallucinogensScore SubstanceUseDisorderSustainedRemission, HeroinScore SubstanceUseDisorderEarlyRemission, HeroinScore SubstanceUseDisorderSustainedRemission, MethadoneScore SubstanceUseDisorderEarlyRemission, MethadoneScore SubstanceUseDisorderSustainedRemission, NicotineTobaccoScore SubstanceUseDisorderEarlyRemission, NicotineTobaccoScore SubstanceUseDisorderSustainedRemission, OtherOpiatesAnalgesicsScore SubstanceUseDisorderEarlyRemission, OtherOpiatesAnalgesicsScore SubstanceUseDisorderSustainedRemission, OtherScore SubstanceUseDisorderEarlyRemission, OtherScore SubstanceUseDisorderSustainedRemission, OtherSedativesHypnoticsScore SubstanceUseDisorderEarlyRemission, OtherSedativesHypnoticsScore SubstanceUseDisorderSustainedRemission, SolventInhalantsScore SubstanceUseDisorderEarlyRemission, SolventInhalantsScore SubstanceUseDisorderSustainedRemission, StimulantsScore SubstanceUseDisorderEarlyRemission, and StimulantsScore SubstanceUseDisorderSustainedRemission

In the Dimension1WithdrawalScores section, the following property was added, OpioidTreatmentServicesOpioidAgonistWithdrawalGradualTaperIsMet.

In the Dimension5RelapsePotentialScores section, the following property was added, CareLevel_II_1_IntensiveOutpatientScore IsMetDimFiveClinicallyManagedLowIntensityResidentialTreatment.

In the DimensionalAdmissionCriteriaResults section, the following properties were added, CareLevel_I_SustainedRemission_IsBiomedicalAndRecoveryResidence, CareLevel_I_SustainedRemission_IsDualDiagnosisEnhanced, CareLevel_I_SustainedRemission_IsDualDiagnosisEnhancedAndRecoveryResidence, CareLevel_I_SustainedRemission_IsDualDiagnosisEnhancedBiomedicalAndRecoveryResidence, CareLevel_I_SustainedRemission_IsMet, CareLevel_I_SustainedRemission_IsRecoveryResidence, CareLevel_II_1_IntensiveOutpatientScore IntensiveOutpatientAndLevel_III_1, CareLevel_II_1_IntensiveOutpatientScore IsDualDiagnosisCapableAndLevel_III_1, CareLevel_II_1_IntensiveOutpatientScore IsDualDiagnosisEnhancedAndLevel_III_1, and OpioidTreatmentServicesOpioidAgonistWithdrawalGradualTaperIsMet.

In the Dimensions2Through6Results section, the following properties were added, CareLevel_I_SustainedRemission_IsBiomedicalAndRecoveryResidence, CareLevel_I_SustainedRemission_IsDualDiagnosisEnhanced, CareLevel_I_SustainedRemission_IsDualDiagnosisEnhancedAndRecoveryResidence, CareLevel_I_SustainedRemission_IsDualDiagnosisEnhancedBiomedicalAndRecoveryResidence, CareLevel_I_SustainedRemission_IsMet, CareLevel_I_SustainedRemission_IsRecoveryResidence, CareLevel_II_1_IntensiveOutpatientScore IntensiveOutpatientAndLevel_III_1, CareLevel_II_1_IntensiveOutpatientScore IsDualDiagnosisCapableAndLevel_III_1, CareLevel_II_1_IntensiveOutpatientScore IsDualDiagnosisEnhancedAndLevel_III_1, and OpioidTreatmentServicesOpioidAgonistWithdrawalGradualTaperIsMet.

~ Updated JSON in Appendix E to reflect the new properties added to the Triage Assessment Score Summary Data TriageCareLevelQualifierScores Section. The new properties added are, CareLevel2_WithdrawalManagementScore IsMet and CareLevel2WMExceptSTA IsMet.

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 OtherActivePsychiatricDiagnosesOtherThanSubstanceAbuseNote. 

06/2022

> New version (v6) of API was added to return the new data type for question OpioidMaintenanceTherapyReadmissionMedicallyIndicated in the Comprehensive Assessment Opioid Treatment Services (OpioidMaintenanceTherapy) 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 NumberOfCloseFriends 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 HasHealthCareProviderWhoPrescribedHelpWithDoseFrequency. The new properties added in the Heroin Use are HasHealthCareProviderPrescribedUse, HeroinWhichSubstanceUse, and WasSubstanceTakenAsPrescribed. The new property added in the Nicotine Use is NicotineWhichSubstanceUse. 

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 InterviewMethod. 

~ 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 SubstanceUseBrandTypeNameTypicalUsagePerDay. 

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 FurtherExplanationForFinalDispositionDescription. 

07/31/2020

> New version (v4) of API was added to the Comprehensive Assessment Data. The version returns the new data types for questions HasAutomobileAvailableForUse in the Comprehensive Assessment Employment and Support Section, PatientAbleToSafelyAccessNeededResources in the Comprehensive Assessment Psychological Section Interviewer Rating Subsection, UsualLivingArrangements and IsAbleToLocateAndGetToCommunityResourcesSafely in the Comprehensive Assessment Family and Social History Section. 

~ Updated JSON in Appendix B to reflect the new data types for questions, HasAutomobileAvailableForUse, PatientAbleToSafelyAccessNeededResources, UsualLivingArrangements, and IsAbleToLocateAndGetToCommunityResourcesSafely. 

~ 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 LengthInControlledEnvironment. 

06/30/2020

> Added note for new Gender, Preferred Pronoun, and Sex at Birth option codes. The Gender and PreferredPronoun 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 OtherGenderIdentity, PreferredPronoun, and SexAtBirth. 

~ 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 RequiresMedicalMonitoringForReemergenceOfSymptoms in the Comprehensive Assessment Medical Section. 

~ Updated JSON in Appendix B to reflect the new data type for the question RequiresMedicalMonitoringForReemergenceOfSymptoms. 

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 CompletedSystemAccountKey and TimeZone. The new property in the Legal Section is HaveBeenArrestedOrChargedForAnyReason. 

~ Updated JSON in Appendix B to update property labels 

• In the Comprehensive Assessment Review Section, the property was renamed from SatisfactionWithTimeToCompleteInterview to SatisfactionWithTimeToCompleteInterview. 

• In the Comprehensive Assessment Alcohol Use Section, the properties were renamed from LastUsedToIntoxification to LastUsedToIntoxication and NumberOfMonthsAsAlcoholConsumerToIntoxication to NumberOfMonthsUsedToIntoxicationInLifetime. 

• In the Comprehensive Assessment Other Opiate Use Section, the property was renamed from ReceivingOngoingMaintenanceTherapy to TakingOpioidAnalgesics. 

• In the Comprehensive Assessment Family and Social History Section, the property was renamed from MonthsLivedInTheseArrangement to MonthsInThisLivingArrangement. 

~ Updated JSON in Appendix D to reflect new properties added to the Triage Assessment. The new properties in the assessment are CompletedSystemAccountKey and TimeZone. 

11/2019

~ Updated JSON in Appendix B to reflect new properties added to the Comprehensive Assessment Medical Section. The two new properties are HasBloodPressureBeenAssessedObtained HasHeartRateBeenAssessedObtained. 

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 AdditionalCategoriesOfFinalDisposition. 

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. 

~ UserEmail 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’”