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:

Community Health Clinic (Provider) (http://hl7.org/fhir/sid/us-npi#NPI#1234567893)


Active:true
Type:Provider
Contact Detail

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: SSN#444-44-4444)


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)

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
BHAAdmissionQuestionnaireResponseExampleSouth / lastUpdated2025-01-10T09:00:00Z
BHAAdmissionQuestionnaireResponseExampleSouth / SERVICE_IDENTIFIERService IdentifierBHA Service Identifier Codes: 30 (Mental Health Outpatient)
BHAAdmissionQuestionnaireResponseExampleSouth / FIRST_CONTACT_DATEDate of First Contact2025-01-10
BHAAdmissionQuestionnaireResponseExampleSouth / FIRST_APPOINTMENT_OFFERED_DATEDate of First Appointment Offered2025-01-14
BHAAdmissionQuestionnaireResponseExampleSouth / MEDICATION_ASSISTED_THERAPYMedication Assisted Therapyfalse
BHAAdmissionQuestionnaireResponseExampleSouth / REFERRAL_SOURCEReferral SourceBHA Referral Source: 1 (Individual (self, family, friend))
BHAAdmissionQuestionnaireResponseExampleSouth / ARRESTS_PAST_30_DAYSArrests in Past 30 Days0
BHAAdmissionQuestionnaireResponseExampleSouth / EMPLOYMENT_STATUSEmployment StatusBHA Employment Status: 02 (Employed Part Time (<35 hours/week))
BHAAdmissionQuestionnaireResponseExampleSouth / LIVING_SITUATIONLiving SituationBHA Living Situation: 2 (Inpatient)
BHAAdmissionQuestionnaireResponseExampleSouth / MONTHLY_INCOMEMonthly Income1800
BHAAdmissionQuestionnaireResponseExampleSouth / 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)
BHAAdmissionQuestionnaireResponseExampleSouth / PREGNANCY_STATUSPregnancy Statustrue
BHAAdmissionQuestionnaireResponseExampleSouth / WITHIN_1_YEAR_POSTPARTUM_STATUSWithin 1 Year Postpartum Statusfalse
BHAAdmissionQuestionnaireResponseExampleSouth / SPECIAL_CONNECTIONS_ENROLLMENTEnrollment in Special Connectionstrue
BHAAdmissionQuestionnaireResponseExampleSouth / ACT_ENROLLMENTEnrollment in ACT?false
BHAAdmissionQuestionnaireResponseExampleSouth / ASCENT_ENROLLMENTEnrollment in Ascent (FEP)?false
BHAAdmissionQuestionnaireResponseExampleSouth / NUMBER_DEPENDENT_CHILDRENNumber of Dependent Children0
BHAAdmissionQuestionnaireResponseExampleSouth / SELF_HELP_ATTENDANCESelf Help Attendance (Last 30 days at admission)/ Peer Support Attendance1
BHAAdmissionQuestionnaireResponseExampleSouth / TOTAL_SUBSTANCE_USE_PRIOR_TREATMENTSubstance Use Prior Treatment (Total Lifetime admissions)0
BHAAdmissionQuestionnaireResponseExampleSouth / PSYCHIATRIC_HOSPITAL_ADMISSIONPsychiatric Hospital Admission (Last 30 days)false
BHAAdmissionQuestionnaireResponseExampleSouth / LEGAL_STATUSLegal StatusBHA Legal Status: 02 (Court-directed voluntary)
BHAAdmissionQuestionnaireResponseExampleSouth / CRIMINAL_JUSTICE_INVOLVEMENTCriminal Justice Involvementfalse
BHAAdmissionQuestionnaireResponseExampleSouth / EDUCATION_LEVELEducation LevelBHA Education Level: 14 (Some College)
BHAAdmissionQuestionnaireResponseExampleSouth / SCHOOL_ATTENDANCE_STATUSSchool Attendance Status (in the previous 3 months)BHA School Attendance Status: 03 (Not Applicable)
BHAAdmissionQuestionnaireResponseExampleSouth / PSYCHIATRIC_ER_VISIT_6_MONTHSVisit to Psychiatric ER in last 6 months0
BHAAdmissionQuestionnaireResponseExampleSouth / COMMUNICATION_ACCOMMODATIONSCommunication Accommodationsfalse
BHAAdmissionQuestionnaireResponseExampleSouth / episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Mental Health; period = 2025-01-10 --> 2025-12-15
BHAAdmissionQuestionnaireResponseExampleSouth / 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
BHADischargeQuestionnaireResponseExampleSouth / lastUpdated2025-12-15T16:30:00Z
BHADischargeQuestionnaireResponseExampleSouth / DATE_OF_LAST_CONTACTDate of Last Contact2025-12-15T15:30:00Z
BHADischargeQuestionnaireResponseExampleSouth / DISCHARGE_DATEDischarge Date2025-12-15T16:30:00Z
BHADischargeQuestionnaireResponseExampleSouth / DISCHARGE_TYPEDischarge TypeBHA Discharge Type: 01 (Treatment Completed At This Facility)
BHADischargeQuestionnaireResponseExampleSouth / END_OF_TREATMENT_REASONEnd of Treatment ReasonBHA End of Treatment Reasons: 2 (Client Decision)
BHADischargeQuestionnaireResponseExampleSouth / ARRESTS_PAST_30_DAYSArrests in Past 30 Days0
BHADischargeQuestionnaireResponseExampleSouth / EMPLOYMENT_STATUSEmployment StatusBHA Employment Status: 01 (Employed Full Time (35+ hours/week))
BHADischargeQuestionnaireResponseExampleSouth / LIVING_SITUATIONLiving SituationBHA Living Situation: 2 (Inpatient)
BHADischargeQuestionnaireResponseExampleSouth / SELF_HELP_ATTENDANCESelf Help Attendance / Peer Support Attendance (Last 30 days at discharge)2
BHADischargeQuestionnaireResponseExampleSouth / EDUCATION_LEVELEducation LevelBHA Education Level: 14 (Some College)
BHADischargeQuestionnaireResponseExampleSouth / SCHOOL_ATTENDANCE_STATUSSchool Attendance Status (in the previous 3 months)BHA School Attendance Status: 03 (Not Applicable)
BHADischargeQuestionnaireResponseExampleSouth / LEGAL_STATUSLegal StatusBHA Legal Status: 02 (Court-directed voluntary)
BHADischargeQuestionnaireResponseExampleSouth / episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Mental Health; period = 2025-01-10 --> 2025-12-15
BHADischargeQuestionnaireResponseExampleSouth / 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
BHASCPregnancyQuestionnaireResponseExampleSouth / lastUpdated2025-06-15T08:00:00Z
BHASCPregnancyQuestionnaireResponseExampleSouth / EVALUATION_DATEEvaluation Date2025-06-15
BHASCPregnancyQuestionnaireResponseExampleSouth / PREGNANCY_POSTPARTUM_STATUSPregnancy/Postpartum StatusBHA Pregnancy / Postpartum Status: 03 (Third trimester)
BHASCPregnancyQuestionnaireResponseExampleSouth / PREGNANCY_POSTPARTUM_CARE_STATUSPregnancy/Postpartum Care StatusBHA Pregnancy/Postpartum Care Status: 01 (Already receiving prenatal care routinely)
BHASCPregnancyQuestionnaireResponseExampleSouth / DRUG_ALCOHOL_TREATMENT_ACCESSAccess to other drug/alcohol treatmentBHA Access to Other Drug/Alcohol Treatment: 02 (Limited access to other treatment)
BHASCPregnancyQuestionnaireResponseExampleSouth / FAMILY_SOCIAL_SUPPORTFamily/Social SupportBHA Family/Social Support: 01 (Strong)
BHASCPregnancyQuestionnaireResponseExampleSouth / FAMILY_SUD_HISTORYFamily substance use disorder historyBHA Family Substance Use Disorder: 05 (Spouse/Partner)
BHASCPregnancyQuestionnaireResponseExampleSouth / FAMILY_SUD_CURRENTFamily substance use disorder currentBHA Family Substance Use Disorder: 04 (Extended Family)
BHASCPregnancyQuestionnaireResponseExampleSouth / DRUG_USING_PARTNERDrug using partnerBHA Drug Using Partner: 01 (No drug using partner)
BHASCPregnancyQuestionnaireResponseExampleSouth / HIV_RISKHIV RiskBHA HIV Risk: 01 (No reported history of high risk behaviors)
BHASCPregnancyQuestionnaireResponseExampleSouth / HOME_STABILITY_SAFETYHome Stability and SafetyBHA Home Stability and Safety: 01 (Stable and safe housing)
BHASCPregnancyQuestionnaireResponseExampleSouth / PERSONAL_SAFETYPersonal SafetyBHA Personal Safety: 02 (One to two incidents of emotional, verbal or physical abuse between the beginning of pregnancy and now.)
BHASCPregnancyQuestionnaireResponseExampleSouth / PRIOR_CRIMINAL_RECORDPrior Criminal RecordBHA Prior Criminal Record: 02 (One felony or misdemeanor conviction.)
BHASCPregnancyQuestionnaireResponseExampleSouth / MENTAL_HEALTH_HISTORYMental Health HistoryBHA Mental Health History: 01 (No symptoms of mental disorder, no apparent impairment in functioning.)
BHASCPregnancyQuestionnaireResponseExampleSouth / PRIOR_ALCOHOL_DRUG_TREATMENTPrior alcohol/drug treatmentBHA Prior Alcohol/Drug Treatment: 03 (Two or more treatment experiences.)
BHASCPregnancyQuestionnaireResponseExampleSouth / CHILDREN_LIVING_WITH_CLIENTChildren Living in home with youtrue
BHASCPregnancyQuestionnaireResponseExampleSouth / CHILDREN_AGES_LIVING_WITH_CLIENTChildren Ages living in home with youBHA Children Ages Living in Home: 01 (0-5)
BHASCPregnancyQuestionnaireResponseExampleSouth / 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
BHASCBabyQuestionnaireResponseExampleSouth / lastUpdated2025-09-20T18:30:40-07:00
BHASCBabyQuestionnaireResponseExampleSouth / LIVE_BIRTHLive Birthtrue
BHASCBabyQuestionnaireResponseExampleSouth / DOBBaby Date of Birth2025-09-20
BHASCBabyQuestionnaireResponseExampleSouth / WEIGHT_LBSBaby Weight Pounds7
BHASCBabyQuestionnaireResponseExampleSouth / WEIGHT_OZBaby Weight Ounces3
BHASCBabyQuestionnaireResponseExampleSouth / LAST_NAMEBaby Last NameTorres
BHASCBabyQuestionnaireResponseExampleSouth / FIRST_NAMEBaby First NameMateo
BHASCBabyQuestionnaireResponseExampleSouth / MIDDLE_NAME_INITIALBaby Middle Name or InitialA
BHASCBabyQuestionnaireResponseExampleSouth / SEX_AT_BIRTHBaby Sex at BirthAdministrativeGender: male (Male)
BHASCBabyQuestionnaireResponseExampleSouth / Baby_Patient_ReferenceReference to the Baby's Patient ResourceMateo Torres Male, DoB: 2025-09-20 ( Medical record number: 789012 (use: usual))
BHASCBabyQuestionnaireResponseExampleSouth / 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: 789012 (use: usual))


Active:true
US Core Birth Sex ExtensionM

Request:

PUT Patient/BabyPatientExampleSouth