Colorado BHA FHIR Implementation Guide
0.3.0-current - ci-build United States of America flag

Colorado BHA FHIR Implementation Guide, published by Colorado Behavioral Health Administration. This guide is not an authorized publication; it is the continuous build for version 0.3.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CoBHA/CoBHRM-FHIR-IG/ and changes regularly. See the Directory of published versions

Example Bundle: All of South data

Language: en

Bundle AllOfExampleSouth of type batch

Entry 1 - fullUrl = http://example.org/fhir/Organization/BHAOrganizationExample

Resource Organization:

identifier: United States National Provider Identifier/1234567893

active: true

type: Provider

name: Community Health Clinic

contact

telecom: ph: (+1) 555-555-5555, hq@chc.example.org

address: 100 Hope Place Denver CO 11111 USA

Request:

PUT Organization/BHAOrganizationExample

Entry 2 - fullUrl = http://example.org/fhir/Patient/BHAClientExampleSouth

Resource Patient:

Last updated: 2025-05-10 08:00:00+0000; Language: en

Profile: BHA Client Profile

Gabriela Mar Torres (official) Female, DoB: 1991-12-05 ( Social Security number)

Marital Status:Divorced
Other Id:State Identifier/1234567894
Contact Detail1720 West 7th St Pueblo CO 81003 (home)
Language:Spanish (preferred)
us-veteran-statusfalse
US Core Ethnicity Extension:
US Core Birth Sex ExtensionF
US Core Race Extension:

Request:

PUT Patient/BHAClientExampleSouth

Entry 3 - fullUrl = http://example.org/fhir/EpisodeOfCare/BHAEpisodeOfCareExampleSouthBH

Resource EpisodeOfCare:

Last updated: 2025-01-10 09:00:00+0000; Language: en

Profile: BHA EpisodeOfCare Profile

status: Finished

type: Mental Health

Diagnoses

-Condition
*No display for EpisodeOfCare.diagnosis.condition (reference: ->Mental Health Diagnosis)

patient: Gabriela Torres

managingOrganization: Community Health Clinic

period: 2025-01-10 --> 2025-12-15

Request:

PUT EpisodeOfCare/BHAEpisodeOfCareExampleSouthBH

Entry 4 - fullUrl = http://example.org/fhir/Condition/BHAEpisodeDiagnosisExampleSouthBH

Resource Condition:

Language: en

Profile: BHA Episode Diagnosis Profile

clinicalStatus: Active

verificationStatus: Confirmed

category: Encounter Diagnosis, Mental Health

code: Mental Health Outpatient

subject: Gabriela Torres

Request:

PUT Condition/BHAEpisodeDiagnosisExampleSouthBH

Entry 5 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHAAdmissionQuestionnaireResponseExampleSouth

Resource QuestionnaireResponse:

Language: en

Profile: US Core QuestionnaireResponse Profile version: 6.1.0

LinkIDTextDefinitionAnswerdoco
.. BHAAdmissionQuestionnaireResponseExampleSouthQuestionnaire:BHA Admission Questionnaire
... lastUpdated2025-01-10T09:00:00Z
... SERVICE_IDENTIFIERService IdentifierBHA Service Identifier Codes: 30 (Mental Health Outpatient)
... FIRST_CONTACT_DATEDate of First Contact2025-01-10
... FIRST_APPOINTMENT_OFFERED_DATEDate of First Appointment Offered2025-01-14
... MEDICATION_ASSISTED_THERAPYMedication Assisted Therapyfalse
... REFERRAL_SOURCEReferral SourceBHA Referral Source: 1 (Individual (self, family, friend))
... ARRESTS_PAST_30_DAYSArrests in Past 30 Days0
... EMPLOYMENT_STATUSEmployment StatusBHA Employment Status: 02 (Employed Part Time (<35 hours/week))
... LIVING_SITUATIONLiving SituationBHA Living Situation: 2 (Inpatient)
... MONTHLY_INCOMEMonthly Income1800
... PRIMARY_INCOME_SOURCEPrimary Source of income/support for client (or for client's parent if client >18 years of age)BHA Income Source: 1 (Wages)
... PREGNANCY_STATUSPregnancy Statustrue
... WITHIN_1_YEAR_POSTPARTUM_STATUSWithin 1 Year Postpartum Statusfalse
... SPECIAL_CONNECTIONS_ENROLLMENTEnrollment in Special Connectionstrue
... ACT_ENROLLMENTEnrollment in ACT?false
... ASCENT_ENROLLMENTEnrollment in Ascent (FEP)?false
... NUMBER_DEPENDENT_CHILDRENNumber of Dependent Children0
... SELF_HELP_ATTENDANCESelf Help Attendance (Last 30 days at admission)/ Peer Support Attendance1
... TOTAL_SUBSTANCE_USE_PRIOR_TREATMENTSubstance Use Prior Treatment (Total Lifetime admissions)0
... PSYCHIATRIC_HOSPITAL_ADMISSIONPsychiatric Hospital Admission (Last 30 days)false
... LEGAL_STATUSLegal StatusBHA Legal Status: 02 (Court-directed voluntary)
... CRIMINAL_JUSTICE_INVOLVEMENTCriminal Justice Involvementfalse
... EDUCATION_LEVELEducation LevelBHA Education Level: 14 (Some College)
... SCHOOL_ATTENDANCE_STATUSSchool Attendance Status (in the previous 3 months)BHA School Attendance Status: 03 (Not Applicable)
... PSYCHIATRIC_ER_VISIT_6_MONTHSVisit to Psychiatric ER in last 6 months0
... COMMUNICATION_ACCOMMODATIONSCommunication Accommodationsfalse
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Mental Health; period = 2025-01-10 --> 2025-12-15
... diagnosisDiagnosis InformationMental disorder, not otherwise specified

doco Documentation for this format

Request:

PUT QuestionnaireResponse/BHAAdmissionQuestionnaireResponseExampleSouth

Entry 6 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHADischargeQuestionnaireResponseExampleSouth

Resource QuestionnaireResponse:

Language: en

Profile: US Core QuestionnaireResponse Profile version: 6.1.0

LinkIDTextDefinitionAnswerdoco
.. BHADischargeQuestionnaireResponseExampleSouthQuestionnaire:BHA Discharge Questionnaire
... lastUpdated2025-12-15T16:30:00Z
... DATE_OF_LAST_CONTACTDate of Last Contact2025-12-15T15:30:00Z
... DISCHARGE_DATEDischarge Date2025-12-15T16:30:00Z
... DISCHARGE_TYPEDischarge TypeBHA Discharge Type: 01 (Treatment Completed At This Facility)
... END_OF_TREATMENT_REASONEnd of Treatment ReasonBHA End of Treatment Reasons: 2 (Client Decision)
... ARRESTS_PAST_30_DAYSArrests in Past 30 Days0
... EMPLOYMENT_STATUSEmployment StatusBHA Employment Status: 01 (Employed Full Time (35+ hours/week))
... LIVING_SITUATIONLiving SituationBHA Living Situation: 2 (Inpatient)
... SELF_HELP_ATTENDANCESelf Help Attendance / Peer Support Attendance (Last 30 days at discharge)2
... EDUCATION_LEVELEducation LevelBHA Education Level: 14 (Some College)
... SCHOOL_ATTENDANCE_STATUSSchool Attendance Status (in the previous 3 months)BHA School Attendance Status: 03 (Not Applicable)
... LEGAL_STATUSLegal StatusBHA Legal Status: 02 (Court-directed voluntary)
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Mental Health; period = 2025-01-10 --> 2025-12-15
... diagnosisDiagnosis InformationMental disorder, not otherwise specified

doco Documentation for this format

Request:

PUT QuestionnaireResponse/BHADischargeQuestionnaireResponseExampleSouth

Entry 7 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHASCPregnancyQuestionnaireResponseExampleSouth

Resource QuestionnaireResponse:

Language: en

Profile: US Core QuestionnaireResponse Profile version: 6.1.0

LinkIDTextDefinitionAnswerdoco
.. BHASCPregnancyQuestionnaireResponseExampleSouthQuestionnaire:BHA Special Connections Pregnancy/Postpartum Risk Screening Questionnaire
... lastUpdated2025-06-15T08:00:00Z
... EVALUATION_DATEEvaluation Date2025-06-15
... PREGNANCY_POSTPARTUM_STATUSPregnancy/Postpartum StatusBHA Pregnancy / Postpartum Status: 03 (Third trimester)
... PREGNANCY_POSTPARTUM_CARE_STATUSPregnancy/Postpartum Care StatusBHA Pregnancy/Postpartum Care Status: 01 (Already receiving prenatal care routinely)
... DRUG_ALCOHOL_TREATMENT_ACCESSAccess to other drug/alcohol treatmentBHA Access to Other Drug/Alcohol Treatment: 02 (Limited access to other treatment)
... FAMILY_SOCIAL_SUPPORTFamily/Social SupportBHA Family/Social Support: 01 (Strong)
... FAMILY_SUD_HISTORYFamily substance use disorder historyBHA Family Substance Use Disorder: 05 (Spouse/Partner)
... FAMILY_SUD_CURRENTFamily substance use disorder currentBHA Family Substance Use Disorder: 04 (Extended Family)
... DRUG_USING_PARTNERDrug using partnerBHA Drug Using Partner: 01 (No drug using partner)
... HIV_RISKHIV RiskBHA HIV Risk: 01 (No reported history of high risk behaviors)
... HOME_STABILITY_SAFETYHome Stability and SafetyBHA Home Stability and Safety: 01 (Stable and safe housing)
... PERSONAL_SAFETYPersonal SafetyBHA Personal Safety: 02 (One to two incidents of emotional, verbal or physical abuse between the beginning of pregnancy and now.)
... PRIOR_CRIMINAL_RECORDPrior Criminal RecordBHA Prior Criminal Record: 02 (One felony or misdemeanor conviction.)
... MENTAL_HEALTH_HISTORYMental Health HistoryBHA Mental Health History: 01 (No symptoms of mental disorder, no apparent impairment in functioning.)
... PRIOR_ALCOHOL_DRUG_TREATMENTPrior alcohol/drug treatmentBHA Prior Alcohol/Drug Treatment: 03 (Two or more treatment experiences.)
... CHILDREN_LIVING_WITH_CLIENTChildren Living in home with youtrue
... CHILDREN_AGES_LIVING_WITH_CLIENTChildren Ages living in home with youBHA Children Ages Living in Home: 01 (0-5)
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Mental Health; period = 2025-01-10 --> 2025-12-15

doco Documentation for this format

Request:

PUT QuestionnaireResponse/BHASCPregnancyQuestionnaireResponseExampleSouth

Entry 8 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHASCBabyQuestionnaireResponseExampleSouth

Resource QuestionnaireResponse:

Language: en

Profile: US Core QuestionnaireResponse Profile version: 6.1.0

LinkIDTextDefinitionAnswerdoco
.. BHASCBabyQuestionnaireResponseExampleSouthQuestionnaire:BHA Special Connections Baby Questionnaire
... lastUpdated2025-09-20T18:30:40-07:00
... LIVE_BIRTHLive Birthtrue
... DOBBaby Date of Birth2025-09-20
... WEIGHT_LBSBaby Weight Pounds7
... WEIGHT_OZBaby Weight Ounces3
... LAST_NAMEBaby Last NameTorres
... FIRST_NAMEBaby First NameMateo
... MIDDLE_NAME_INITIALBaby Middle Name or InitialA
... SEX_AT_BIRTHBaby Sex at BirthAdministrativeGender: male (Male)
... Baby_Patient_ReferenceReference to the Baby's Patient ResourceMateo Torres Male, DoB: 2025-09-20 ( Medical record number (use: usual, ))
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Mental Health; period = 2025-01-10 --> 2025-12-15

doco Documentation for this format

Request:

PUT QuestionnaireResponse/BHASCBabyQuestionnaireResponseExampleSouth

Entry 9 - fullUrl = http://example.org/fhir/Patient/BabyPatientExampleSouth

Resource Patient:

Last updated: 2025-09-20 18:30:40-0700; Language: en

Profile: US Core Patient Profile version: 6.1.0

Mateo Torres Male, DoB: 2025-09-20 ( Medical record number (use: usual, ))

Active:true
US Core Birth Sex ExtensionM

Request:

PUT Patient/BabyPatientExampleSouth