Colorado BHA FHIR Implementation Guide
0.3.0-current - ci-build
Colorado BHA FHIR Implementation Guide
0.3.0-current - ci-build
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
Language: en
Bundle AllOfExampleEmma of type batch
Entry 1 - fullUrl = http://example.org/fhir/Organization/BHAOrganizationExample
Resource Organization:
Language: en
Profile: BHA Provider Organization Profile
Community Health Clinic (Provider) (http://hl7.org/fhir/sid/us-npi#NPI#1234567893)
Active: true Type: Provider Contact Detail
- ph: (+1) 555-555-5555
- hq@chc.example.org
- 100 Hope Place Denver CO 11111 USA
Request:
PUT Organization/BHAOrganizationExample
Entry 2 - fullUrl = http://example.org/fhir/Patient/BHAClientExample
Resource Patient:
Last updated: 2024-06-01 12:00:00+0000; Language: en
Profile: BHA Client Profile
Emma Nora Jones (official) Female, DoB: 1980-05-15 ( Social Security number: SSN#111-11-1111)
Marital Status: Married Other Id: State Identifier/9876543210 Contact Detail 123 Main St Suite 300 Denver CO 80205 (home) Language: Spanish (preferred) us-veteran-status true US Core Ethnicity Extension:
- text: Not Hispanic or Latino
- ombCategory: Race & Ethnicity - CDC: 2186-5 (Not Hispanic or Latino)
US Core Birth Sex Extension F US Core Race Extension:
- text: Asian
- ombCategory: Race & Ethnicity - CDC: 2028-9 (Asian)
Request:
PUT Patient/BHAClientExample
Entry 3 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHAClientQuestionnaireResponseExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer BHAClientQuestionnaireResponseExample
Questionnaire:BHA Client Questionnaire lastUpdated
2025-10-28T18:30:40-07:00 Child Welfare Involvement true Trails Identifier 1234567890 Disability Code(s) Documentation for this format
Request:
PUT QuestionnaireResponse/BHAClientQuestionnaireResponseExample
Entry 4 - fullUrl = http://example.org/fhir/EpisodeOfCare/BHAEpisodeOfCareExampleBH
Resource EpisodeOfCare:
Last updated: 2024-01-01 12: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: 2024-01-01 --> 2024-01-15
Request:
PUT EpisodeOfCare/BHAEpisodeOfCareExampleBH
Entry 5 - fullUrl = http://example.org/fhir/Condition/BHAEpisodeDiagnosisExample
Resource Condition:
Language: en
Profile: BHA Episode Diagnosis Profile
clinicalStatus: Active
verificationStatus: Confirmed
category: Encounter Diagnosis, Mental Health
code: Mental Health Outpatient
subject: Emma Jones
Request:
PUT Condition/BHAEpisodeDiagnosisExample
Entry 6 - fullUrl = http://example.org/fhir/Condition/BHAEpisodeDiagnosisExample2
Resource Condition:
Language: en
Profile: BHA Episode Diagnosis Profile
clinicalStatus: Active
verificationStatus: Confirmed
category: Encounter Diagnosis, Mental Health
code: Crisis Stabilization
subject: Emma Jones
Request:
PUT Condition/BHAEpisodeDiagnosisExample2
Entry 7 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHAAdmissionQuestionnaireResponseExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer Questionnaire:BHA Admission Questionnaire 2025-10-28T18:30:40-07:00 Service Identifier BHA Service Identifier Codes: 30 (Mental Health Outpatient) Date of First Contact 2025-07-01 Date of First Appointment Offered 2025-07-15 Medication Assisted Therapy true Referral Source BHA Referral Source: 1 (Individual (self, family, friend)) Arrests in Past 30 Days 1 Employment Status BHA Employment Status: 01 (Employed Full Time (35+ hours/week)) Living Situation BHA Living Situation: 1 (Correctional facility / Jail) Monthly Income 999 Primary Source of income/support for client (or for client's parent if client >18 years of age) BHA Income Source: 2 (Public Assistance) Pregnancy Status false Within 1 Year Postpartum Status false Enrollment in Special Connections false Enrollment in ACT? false Enrollment in Ascent (FEP)? false Number of Dependent Children 0 Self Help Attendance (Last 30 days at admission)/ Peer Support Attendance 0 Substance Use Prior Treatment (Total Lifetime admissions) 9 Psychiatric Hospital Admission (Last 30 days) true Legal Status BHA Legal Status: 02 (Court-directed voluntary) Criminal Justice Involvement false Education Level BHA Education Level: 14 (Some College) School Attendance Status (in the previous 3 months) BHA School Attendance Status: 03 (Not Applicable) Visit to Psychiatric ER in last 6 months 0 Communication Accommodations true Episode of Care Information EpisodeOfCare: status = finished; type = Mental Health; period = 2024-01-01 --> 2024-01-15 Diagnosis Information
Request:
PUT QuestionnaireResponse/BHAAdmissionQuestionnaireResponseExample
Entry 8 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHADiagnosisQuestionnaireResponseExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer Questionnaire:BHA Diagnosis Questionnaire 2025-10-28T18:30:40-07:00 SMI/SED Status BHA SMI / SED Status Codes: 1 (SMI) Episode of Care Information EpisodeOfCare: status = finished; type = Mental Health; period = 2024-01-01 --> 2024-01-15 Diagnosis Information
Request:
PUT QuestionnaireResponse/BHADiagnosisQuestionnaireResponseExample
Entry 9 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHADischargeQuestionnaireResponseExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer Questionnaire:BHA Discharge Questionnaire 2025-10-28T18:30:40-07:00 Date of Last Contact 2025-10-27T17:00:00-07:00 Discharge Date 2025-10-28T18:30:40-07:00 Discharge Type BHA Discharge Type: 01 (Treatment Completed At This Facility) End of Treatment Reason BHA End of Treatment Reasons: 2 (Client Decision) Arrests in Past 30 Days 3 Employment Status BHA Employment Status: 01 (Employed Full Time (35+ hours/week)) Living Situation BHA Living Situation: 1 (Correctional facility / Jail) Self Help Attendance / Peer Support Attendance (Last 30 days at discharge) 0 Education Level BHA Education Level: 14 (Some College) School Attendance Status (in the previous 3 months) BHA School Attendance Status: 03 (Not Applicable) Legal Status BHA Legal Status: 02 (Court-directed voluntary) Episode of Care Information EpisodeOfCare: status = finished; type = Mental Health; period = 2024-01-01 --> 2024-01-15 Diagnosis Information
Request:
PUT QuestionnaireResponse/BHADischargeQuestionnaireResponseExample
Entry 10 - fullUrl = http://example.org/fhir/EpisodeOfCare/BHAEpisodeOfCareExampleSUD
Resource EpisodeOfCare:
Last updated: 2024-01-01 12:00:00+0000; Language: en
Profile: BHA EpisodeOfCare Profile
status: Finished
statusHistory
status: Active
period: 2024-01-01 --> (ongoing)
statusHistory
status: Finished
period: 2024-01-01 --> 2024-01-15
type: Substance Use Disorder
Diagnoses
Condition No display for EpisodeOfCare.diagnosis.condition (reference: ->Substance Use Disorder Diagnosis) managingOrganization: Community Health Clinic
period: 2024-01-01 --> 2024-01-15
Request:
PUT EpisodeOfCare/BHAEpisodeOfCareExampleSUD
Entry 11 - fullUrl = http://example.org/fhir/Condition/BHAEpisodeDiagnosisExampleSUD
Resource Condition:
Language: en
Profile: BHA Episode Diagnosis Profile
clinicalStatus: Active
verificationStatus: Confirmed
category: Encounter Diagnosis, Substance Use Disorder
code: SUD Intensive Outpatient (IOP)
subject: Emma Jones
Request:
PUT Condition/BHAEpisodeDiagnosisExampleSUD
Entry 12 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHASubstanceUseDisorderQuestionnaireResponseExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer Questionnaire:BHA Substance Use Disorder Questionnaire 2025-10-28T18:30:40-07:00 ASAM Level of Care: the ASAM Level of Care must match the LADDERS Provider/Clinic's ASAM Level of Care BHA ASAM Levels of Care: 3.1 (ASAM Level 3.1 - Clinically Managed Low-Intensity Residential Services) Primary Substance Use BHA Substance Use Codes: 1 (Alcohol) Times Used Primary Substance in Last 30 Days 3 Route of Use of Primary Substances BHA Substance Use Route of Administration Codes: 1 (Oral) Age of First Use of Primary Substances 28 Secondary Substance Use BHA Substance Use Codes: 6 (Other tranquilizer) Times Used Secondary Substance in Last 30 Days 4 Route of Use of Secondary Substances BHA Substance Use Route of Administration Codes: 3 (Inhalation (nose/mouth)) Age of First Use of Secondary Substances 28 Tertiary Substance Use BHA Substance Use Codes: 10 (Other stimulants) Times Used Tertiary Substance in Last 30 Days 2 Route of Use of Tertiary Substance BHA Substance Use Route of Administration Codes: 1 (Oral) Age of First Use of Tertiary Substance 29 Episode of Care Information EpisodeOfCare: status = finished; type = Substance Use Disorder; period = 2024-01-01 --> 2024-01-15
Request:
PUT QuestionnaireResponse/BHASubstanceUseDisorderQuestionnaireResponseExample
Entry 13 - fullUrl = http://example.org/fhir/EpisodeOfCare/EpisodeOfCareExamplePG
Resource EpisodeOfCare:
Last updated: 2024-01-01 12:00:00+0000; Language: en
status: Finished
statusHistory
status: Active
period: 2024-01-01 --> (ongoing)
statusHistory
status: Finished
period: 2024-01-01 --> 2024-01-15
type: Community-based aged care
Diagnoses
Condition No display for EpisodeOfCare.diagnosis.condition (reference: ->Pregnancy Diagnosis) managingOrganization: Community Health Clinic
period: 2024-01-01 --> 2024-01-15
Request:
PUT EpisodeOfCare/EpisodeOfCareExamplePG
Entry 14 - fullUrl = http://example.org/fhir/Condition/PregnancyConditionExample
Resource Condition:
Language: en
Profile: US Core Condition Encounter Diagnosis Profile version: 6.1.0
clinicalStatus: Active
verificationStatus: Confirmed
category: Encounter Diagnosis
code: Pregnant
subject: Emma Jones
Request:
PUT Condition/PregnancyConditionExample
Entry 15 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHASCPregnancyQuestionnaireResponseExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer Questionnaire:BHA Special Connections Pregnancy/Postpartum Risk Screening Questionnaire 2025-10-28T18:30:40-07:00 Evaluation Date 2025-07-15 Pregnancy/Postpartum Status BHA Pregnancy / Postpartum Status: 03 (Third trimester) Pregnancy/Postpartum Care Status BHA Pregnancy/Postpartum Care Status: 01 (Already receiving prenatal care routinely) Access to other drug/alcohol treatment BHA Access to Other Drug/Alcohol Treatment: 02 (Limited access to other treatment) Family/Social Support BHA Family/Social Support: 01 (Strong) Family substance use disorder history BHA Family Substance Use Disorder: 05 (Spouse/Partner) Family substance use disorder current BHA Family Substance Use Disorder: 04 (Extended Family) Drug using partner BHA Drug Using Partner: 01 (No drug using partner) HIV Risk BHA HIV Risk: 01 (No reported history of high risk behaviors) Home Stability and Safety BHA Home Stability and Safety: 01 (Stable and safe housing) Personal Safety BHA Personal Safety: 02 (One to two incidents of emotional, verbal or physical abuse between the beginning of pregnancy and now.) Prior Criminal Record BHA Prior Criminal Record: 02 (One felony or misdemeanor conviction.) Mental Health History BHA Mental Health History: 01 (No symptoms of mental disorder, no apparent impairment in functioning.) Prior alcohol/drug treatment BHA Prior Alcohol/Drug Treatment: 03 (Two or more treatment experiences.) Children Living in home with you true Children Ages living in home with you BHA Children Ages Living in Home: 01 (0-5) Episode of Care Information EpisodeOfCare: status = finished; type = Community-based aged care; period = 2024-01-01 --> 2024-01-15
Request:
PUT QuestionnaireResponse/BHASCPregnancyQuestionnaireResponseExample
Entry 16 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHASCBabyQuestionnaireResponseExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer Questionnaire:BHA Special Connections Baby Questionnaire 2025-10-28T18:30:40-07:00 Live Birth true Baby Date of Birth 2025-06-20 Baby Weight Pounds 6 Baby Weight Ounces 2 Baby Last Name White Baby First Name Crystal Baby Middle Name or Initial Snow Baby Sex at Birth AdministrativeGender: female (Female) Episode of Care Information EpisodeOfCare: status = finished; type = Community-based aged care; period = 2024-01-01 --> 2024-01-15
Request:
PUT QuestionnaireResponse/BHASCBabyQuestionnaireResponseExample
Entry 17 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHASCBabyQuestionnaireResponseResourceExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer Questionnaire:BHA Special Connections Baby Questionnaire 2025-10-28T18:30:40-07:00 Live Birth true Baby Date of Birth 2025-06-20 Baby Weight Pounds 6 Baby Weight Ounces 2 Baby Last Name White Baby First Name Crystal Baby Middle Name or Initial Snow Baby Sex at Birth AdministrativeGender: female (Female) Reference to the Baby's Patient Resource Crystal Snow White Female, DoB: 2025-06-20 ( Medical record number: 123456 (use: usual)) Episode of Care Information EpisodeOfCare: status = finished; type = Community-based aged care; period = 2024-01-01 --> 2024-01-15
Request:
PUT QuestionnaireResponse/BHASCBabyQuestionnaireResponseResourceExample
Entry 18 - fullUrl = http://example.org/fhir/Patient/BabyPatientExample
Resource Patient:
Last updated: 2025-10-28 18:30:40-0700; Language: en
Profile: US Core Patient Profile version: 6.1.0
Crystal Snow White Female, DoB: 2025-06-20 ( Medical record number: 123456 (use: usual))
Active: true Marital Status: Never Married US Core Birth Sex Extension F
Request:
PUT Patient/BabyPatientExample
Entry 19 - fullUrl = http://example.org/fhir/QuestionnaireResponse/BHASCBabyNoQuestionnaireResponseExample
Resource QuestionnaireResponse:
Language: en
Profile: US Core QuestionnaireResponse Profile version: 6.1.0
LinkID Text Definition Answer Questionnaire:BHA Special Connections Baby Questionnaire 2025-10-28T18:30:40-07:00 Live Birth false Episode of Care Information EpisodeOfCare: status = finished; type = Community-based aged care; period = 2024-01-01 --> 2024-01-15
Request:
PUT QuestionnaireResponse/BHASCBabyNoQuestionnaireResponseExample
Entry 20 - fullUrl = http://example.org/fhir/Observation/BHAObservationPregnancyStatusExample
Resource Observation:
Language: en
status: Final
category: Social History
code: Pregnancy Status
subject: Emma Jones
effective: 2025-08-24 10:39:52+0000
performer: Community Health Clinic
value: Pregnant
Request:
PUT Observation/BHAObservationPregnancyStatusExample
IG © 2025+ Colorado Behavioral Health Administration.
Package us.co.bha-ig#0.3.0-current based on FHIR 4.0.1.
Generated
2026-10-20
Links: Table of Contents |
QA Report
| 
