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 Emma data

Language: en

Bundle AllOfExampleEmma 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/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)

Marital Status:Married
Other Id:State Identifier/9876543210
Contact Detail123 Main St Suite 300 Denver CO 80205 (home)
Language:Spanish (preferred)
us-veteran-statustrue
US Core Ethnicity Extension:
US Core Birth Sex ExtensionF
US Core Race Extension:

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

LinkIDTextDefinitionAnswerdoco
.. BHAClientQuestionnaireResponseExampleQuestionnaire:BHA Client Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... CHILD_WELFARE_INVOLVEMENTChild Welfare Involvementtrue
... TRAILS_IDENTIFIERTrails Identifier1234567890
... DISABILITY_CODESDisability Code(s)

doco 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)

patient: Emma Jones

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

LinkIDTextDefinitionAnswerdoco
.. BHAAdmissionQuestionnaireResponseExampleQuestionnaire:BHA Admission Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... SERVICE_IDENTIFIERService IdentifierBHA Service Identifier Codes: 30 (Mental Health Outpatient)
... FIRST_CONTACT_DATEDate of First Contact2025-07-01
... FIRST_APPOINTMENT_OFFERED_DATEDate of First Appointment Offered2025-07-15
... MEDICATION_ASSISTED_THERAPYMedication Assisted Therapytrue
... REFERRAL_SOURCEReferral SourceBHA Referral Source: 1 (Individual (self, family, friend))
... ARRESTS_PAST_30_DAYSArrests in Past 30 Days1
... EMPLOYMENT_STATUSEmployment StatusBHA Employment Status: 01 (Employed Full Time (35+ hours/week))
... LIVING_SITUATIONLiving SituationBHA Living Situation: 1 (Correctional facility / Jail)
... MONTHLY_INCOMEMonthly Income999
... PRIMARY_INCOME_SOURCEPrimary Source of income/support for client (or for client's parent if client >18 years of age)BHA Income Source: 2 (Public Assistance)
... PREGNANCY_STATUSPregnancy Statusfalse
... WITHIN_1_YEAR_POSTPARTUM_STATUSWithin 1 Year Postpartum Statusfalse
... SPECIAL_CONNECTIONS_ENROLLMENTEnrollment in Special Connectionsfalse
... 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 Attendance0
... TOTAL_SUBSTANCE_USE_PRIOR_TREATMENTSubstance Use Prior Treatment (Total Lifetime admissions)9
... PSYCHIATRIC_HOSPITAL_ADMISSIONPsychiatric Hospital Admission (Last 30 days)true
... 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 Accommodationstrue
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Mental Health; period = 2024-01-01 --> 2024-01-15
... diagnosisDiagnosis Information

doco Documentation for this format

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

LinkIDTextDefinitionAnswerdoco
.. BHADiagnosisQuestionnaireResponseExampleQuestionnaire:BHA Diagnosis Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... SMI_SED_STATUSSMI/SED StatusBHA SMI / SED Status Codes: 1 (SMI)
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Mental Health; period = 2024-01-01 --> 2024-01-15
... diagnosisDiagnosis Information

doco Documentation for this format

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

LinkIDTextDefinitionAnswerdoco
.. BHADischargeQuestionnaireResponseExampleQuestionnaire:BHA Discharge Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... DATE_OF_LAST_CONTACTDate of Last Contact2025-10-27T17:00:00-07:00
... DISCHARGE_DATEDischarge Date2025-10-28T18:30:40-07:00
... 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 Days3
... EMPLOYMENT_STATUSEmployment StatusBHA Employment Status: 01 (Employed Full Time (35+ hours/week))
... LIVING_SITUATIONLiving SituationBHA Living Situation: 1 (Correctional facility / Jail)
... SELF_HELP_ATTENDANCESelf Help Attendance / Peer Support Attendance (Last 30 days at discharge)0
... 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 = 2024-01-01 --> 2024-01-15
... diagnosisDiagnosis Information

doco Documentation for this format

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)

patient: Emma Jones

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

LinkIDTextDefinitionAnswerdoco
.. BHASubstanceUseDisorderQuestionnaireResponseExampleQuestionnaire:BHA Substance Use Disorder Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... ASAM_LEVEL_OF_CAREASAM Level of Care: the ASAM Level of Care must match the LADDERS Provider/Clinic's ASAM Level of CareBHA ASAM Levels of Care: 3.1 (ASAM Level 3.1 - Clinically Managed Low-Intensity Residential Services)
... PRIMARY_SUBSTANCE_USEPrimary Substance UseBHA Substance Use Codes: 1 (Alcohol)
... PRIMARY_LAST_USED_30_DAYSTimes Used Primary Substance in Last 30 Days3
... PRIMARY_ROUTE_OF_USERoute of Use of Primary SubstancesBHA Substance Use Route of Administration Codes: 1 (Oral)
... PRIMARY_START_AGEAge of First Use of Primary Substances28
... SECONDARY_SUBSTANCE_USESecondary Substance UseBHA Substance Use Codes: 6 (Other tranquilizer)
... SECONDARY_LAST_USED_30_DAYSTimes Used Secondary Substance in Last 30 Days4
... SECONDARY_ROUTE_OF_USERoute of Use of Secondary SubstancesBHA Substance Use Route of Administration Codes: 3 (Inhalation (nose/mouth))
... SECONDARY_START_AGEAge of First Use of Secondary Substances28
... TERTIARY_SUBSTANCE_USETertiary Substance UseBHA Substance Use Codes: 10 (Other stimulants)
... TERTIARY_LAST_USED_30_DAYSTimes Used Tertiary Substance in Last 30 Days2
... TERTIARY_ROUTE_OF_USERoute of Use of Tertiary SubstanceBHA Substance Use Route of Administration Codes: 1 (Oral)
... TERTIARY_START_AGEAge of First Use of Tertiary Substance29
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Substance Use Disorder; period = 2024-01-01 --> 2024-01-15

doco Documentation for this format

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)

patient: Emma Jones

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

LinkIDTextDefinitionAnswerdoco
.. BHASCPregnancyQuestionnaireResponseExampleQuestionnaire:BHA Special Connections Pregnancy/Postpartum Risk Screening Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... EVALUATION_DATEEvaluation Date2025-07-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 = Community-based aged care; period = 2024-01-01 --> 2024-01-15

doco Documentation for this format

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

LinkIDTextDefinitionAnswerdoco
.. BHASCBabyQuestionnaireResponseExampleQuestionnaire:BHA Special Connections Baby Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... LIVE_BIRTHLive Birthtrue
... DOBBaby Date of Birth2025-06-20
... WEIGHT_LBSBaby Weight Pounds6
... WEIGHT_OZBaby Weight Ounces2
... LAST_NAMEBaby Last NameWhite
... FIRST_NAMEBaby First NameCrystal
... MIDDLE_NAME_INITIALBaby Middle Name or InitialSnow
... SEX_AT_BIRTHBaby Sex at BirthAdministrativeGender: female (Female)
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Community-based aged care; period = 2024-01-01 --> 2024-01-15

doco Documentation for this format

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

LinkIDTextDefinitionAnswerdoco
.. BHASCBabyQuestionnaireResponseResourceExampleQuestionnaire:BHA Special Connections Baby Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... LIVE_BIRTHLive Birthtrue
... DOBBaby Date of Birth2025-06-20
... WEIGHT_LBSBaby Weight Pounds6
... WEIGHT_OZBaby Weight Ounces2
... LAST_NAMEBaby Last NameWhite
... FIRST_NAMEBaby First NameCrystal
... MIDDLE_NAME_INITIALBaby Middle Name or InitialSnow
... SEX_AT_BIRTHBaby Sex at BirthAdministrativeGender: female (Female)
... Baby_Patient_ReferenceReference to the Baby's Patient ResourceCrystal Snow White Female, DoB: 2025-06-20 ( Medical record number (use: usual, ))
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Community-based aged care; period = 2024-01-01 --> 2024-01-15

doco Documentation for this format

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 (use: usual, ))

Active:trueMarital Status:Never Married
US Core Birth Sex ExtensionF

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

LinkIDTextDefinitionAnswerdoco
.. BHASCBabyNoQuestionnaireResponseExampleQuestionnaire:BHA Special Connections Baby Questionnaire
... lastUpdated2025-10-28T18:30:40-07:00
... LIVE_BIRTHLive Birthfalse
... episodeOfCareEpisode of Care InformationEpisodeOfCare: status = finished; type = Community-based aged care; period = 2024-01-01 --> 2024-01-15

doco Documentation for this format

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