Colorado BHA FHIR Implementation Guide
0.3.0-current - ci-build USA

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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Questionnaires

These define forms used by systems conforming to this implementation guide to capture or expose data to end users.

BHA Admission Questionnaire

Behavioral Health Administration admission questionnaire for collecting patient demographic, clinical, and administrative information

BHA Client Questionnaire

Behavioral Health Administration client questionnaire for collecting patient demographic, clinical, and administrative information

BHA Diagnosis Questionnaire

Behavioral Health Administration diagnosis questionnaire for collecting patient clinical information during a behavioral health episode of care

BHA Discharge Questionnaire

Behavioral Health Administration discharge questionnaire for collecting patient demographic, clinical, and administrative information during discharge process

BHA Special Connections Baby Questionnaire

Behavioral Health Administration Special Connections baby questionnaire for collecting information about a baby born to a person enrolled in the Special Connections program

BHA Special Connections Pregnancy/Postpartum Risk Screening Questionnaire

Behavioral Health Administration Special Connections Pregnancy/Postpartum Risk Screening questionnaire for collecting information about a pregnant or postpartum person's risk factors

BHA Substance Use Disorder Questionnaire

Behavioral Health Administration substance use disorder questionnaire for collecting substance use information from a person receiving behavioral health services

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

BHA Client Profile

This profile specifies the mandatory and must support data elements for capturing demographic information for BHA clients in order to support the BHA's annual reporting requirements.

BHA Encounter Profile

Encounter profile for client visits and encounters related to BHA EpisodeOfCare

BHA Episode Diagnosis Profile

Diagnosis profile for diagnoses related to BHA episodeOfCare

BHA EpisodeOfCare Profile

BHA EpisodeOfCare Profile for client admissions/services

BHA Provider Organization Profile

Provider Organization profile for BHASO clinics

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

BHA Action Type

CCAR action type (admission, update, discharge, evaluation)

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

BHA Ethnicity Value Set

Allowed ethnicity values for BHA reporting

BHA Gender Identity ValueSet

ValueSet for BHA gender identity codes

BHA Household Language ValueSet

ValueSet for BHA household language codes

BHA Sexual Orientation ValueSet

ValueSet for BHA sexual orientation codes

CO BHA Service Identifier Billing and Diagnosis ValueSet

CPT, HCPCS, and ICD-10-CM codes referenced by CO BHA service identifier ConceptMaps.

CO BHA Service Identifiers from ICD-10-CM

All ICD-10-CM that are valid for Service Identifiers in CoBHRM

ValueSet for BHA ASAM Levels of Care

ASAM Levels of Care for BHA services/admissions (UDM format X(12)).

ValueSet for BHA Access to Other Drug/Alcohol Treatment

Value set for access to other drug/alcohol treatment used in BHA Special Connections

ValueSet for BHA Action Type

Allowed action type values for BHA CCAR reporting

ValueSet for BHA Children Ages Living in Home

Value set for children ages living in home used in BHA Special Connections

ValueSet for BHA Client Identifier Types

Allowed values for BHA client identifier types

ValueSet for BHA Counties

Allowed client county values for BHA reporting

ValueSet for BHA Diagnosis Type

Types of diagnoses for BHA admissions

ValueSet for BHA Disability Codes

Disability codes for BHA admissions

ValueSet for BHA Discharge Type

Discharge type values for BHA reporting.

ValueSet for BHA Drug Using Partner

Value set for drug using partner used in BHA Special Connections

ValueSet for BHA Education Level

Value set for education levels used in BHA EpisodeOfCare. Valid values align with ACT sheet Appendix ACT-Ascent.

ValueSet for BHA Employment Status

Value set for employment statuses used in BHA EpisodeOfCare

ValueSet for BHA End of Treatment Reasons

End of Treatment Reasons for BHA services/admissions. Valid values align with ACT sheet Appendix ACT-Ascent.

ValueSet for BHA Family Substance Use Disorder

Value set for family substance use disorder used in BHA Special Connections

ValueSet for BHA Family/Social Support

Value set for family/social support used in BHA Special Connections

ValueSet for BHA HIV Risk

Value set for HIV risk used in BHA Special Connections

ValueSet for BHA Home Stability and Safety

Value set for home stability and safety used in BHA Special Connections

ValueSet for BHA Income Source

Value set for income sources used in BHA admission process

ValueSet for BHA Involuntary Commitment Reason

Value set for reasons for involuntary commitments used in BHA admission process

ValueSet for BHA Legal Status

Value set for legal statuses used in BHA EpisodeOfCare

ValueSet for BHA Living Situation

Value set for living situations used in BHA EpisodeOfCare

ValueSet for BHA Marital Status

Value set for marital statuses used in BHA admission process

ValueSet for BHA Mental Health History

Value set for mental health history used in BHA Special Connections

ValueSet for BHA Personal Safety

Value set for personal safety used in BHA Special Connections

ValueSet for BHA Pregnancy / Postpartum Status

Value set for pregnancy / postpartum status used in BHA Special Connections Pregnancy/Postpartum Risk Screening Questionnaire

ValueSet for BHA Pregnancy/Postpartum Care Status

Value set for pregnancy/postpartum care status used in BHA Special Connections

ValueSet for BHA Primary Substance Use Codes

Substance use codes for primary substance for BHA services/admissions

ValueSet for BHA Prior Alcohol/Drug Treatment

Value set for prior alcohol/drug treatment used in BHA Special Connections

ValueSet for BHA Prior Criminal Record

Value set for prior criminal record used in BHA Special Connections

ValueSet for BHA Race

Allowed race values for BHA reporting

ValueSet for BHA Referral Source

Value set for referral sources used in BHA admission process

ValueSet for BHA SMI / SED Statuses

SMI / SED Statuses for BHA services/admissions.

ValueSet for BHA School Attendance Status

Value set for school attendance statuses used in BHA EpisodeOfCare

ValueSet for BHA Secondary and Tertiary Substance Use

Substance use codes for secondary and tertiary substance for BHA services/admissions

ValueSet for BHA Service Identifier Codes

Service identifiers for BHA services/admissions

ValueSet for BHA Substance Use Routes of Administration

Substance use routes of administration for BHA services/admissions.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

BHA ASAM Levels of Care

ASAM Levels of Care for BHA services/admissions (UDM format X(12)).

BHA Access to Other Drug/Alcohol Treatment

Code system for access to other drug/alcohol treatment used in BHA Special Connections

BHA Action Type Codes

CCAR action types

BHA Children Ages Living in Home

Code system for children ages living in home used in BHA Special Connections

BHA Client Identifier Types

Identifier types used for BHA client identifiers

BHA County Codes

County codes used by BHA

BHA Diagnosis Type Codes

Types of diagnoses for BHA admissions.

BHA Disability Codes

Types of disabilities for BHA admissions.

BHA Discharge Type

Discharge type values for BHA reporting.

BHA Drug Using Partner

Code system for drug using partner used in BHA Special Connections

BHA Education Level

Code system for education levels used in BHA EpisodeOfCare. Valid values align with ACT sheet Appendix ACT-Ascent.

BHA Employment Status

Code system for employment statuses used in BHA EpisodeOfCare

BHA End of Treatment Reasons

End of Treatment Reasons for BHA services/admissions. Valid values align with ACT sheet Appendix ACT-Ascent.

BHA Ethnicity Codes

Ethnicity codes used by BHA

BHA Family Substance Use Disorder

Code system for family substance use disorder used in BHA Special Connections

BHA Family/Social Support

Code system for family/social support used in BHA Special Connections

BHA Gender Identity Codes

Gender identity values used by BHA

BHA HIV Risk

Code system for HIV risk used in BHA Special Connections

BHA Home Stability and Safety

Code system for home stability and safety used in BHA Special Connections

BHA Household Language Codes

Household language codes used by BHA

BHA Income Source

Code system for income sources used in BHA admission process

BHA Involuntary Commitment Reason

Code system for involuntary commitment reasons used in BHA admission process

BHA Legal Status

Code system for legal statuses used in BHA EpisodeOfCare

BHA Living Situation

Code system for living situations used in BHA EpisodeOfCare

BHA Marital Status

Code system for marital statuses used in BHA admission process

BHA Mental Health History

Code system for mental health history used in BHA Special Connections

BHA Personal Safety

Code system for personal safety used in BHA Special Connections

BHA Pregnancy / Postpartum Status

Code system for pregnancy / postpartum status used in BHA Special Connections Pregnancy/Postpartum Risk Screening Questionnaire

BHA Pregnancy/Postpartum Care Status

Code system for pregnancy/postpartum care status used in BHA Special Connections

BHA Prior Alcohol/Drug Treatment

Code system for prior alcohol/drug treatment used in BHA Special Connections

BHA Prior Criminal Record

Code system for prior criminal record used in BHA Special Connections

BHA Race Codes

Race codes used by BHA

BHA Referral Source

Code system for referral sources used in BHA admission process

BHA SMI / SED Status Codes

SMI / SED Statuses for BHA services/admissions.

BHA School Attendance Status

Code system for school attendance statuses used in BHA EpisodeOfCare

BHA Service Identifier Codes

Service identifiers for BHA services/admissions.

BHA Sexual Orientation Codes

Sexual orientation values used by BHA

BHA Substance Use Codes

Substance use codes for BHA services/admissions.

BHA Substance Use Route of Administration Codes

Substance use routes of administration for BHA services/admissions.

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide.

BHA Client Race ConceptMap

Required: Maps BHA race codes to the US Core OMB race category value set.

BHA Education Level ConceptMap

Informative: Maps BHA education levels to HL7 v3 EducationLevel.

BHA Ethnicity ConceptMap

Required: Maps BHA ethnicity codes to the US Core OMB ethnicity category value set.

BHA Ethnicity Detailed ConceptMap

Required: Maps BHA ethnicity codes to the US Core detailed ethnicity value set.

BHA Gender Identity ConceptMap

Required: Maps BHA gender identity codes to the FHIR Gender Identity value set.

BHA Household Language ConceptMap

Required: Maps BHA household language codes to the US Core Primary Language value set which is BCP-47.

BHA Marital Status ConceptMap

Required: Maps BHA marital status codes to the FHIR marital status value set.

BHA Service Identifier to US Core Condition Code ConceptMap

Informative: Maps BHA service identifier codes to condition concepts from the US Core (SNOMED CT) condition code value set.

BHA Sexual Orientation ConceptMap

Required: Maps BHA sexual orientation codes to the US Core Sexual Orientation value set.

BHA Substance Use Route of Administration ConceptMap

Informative: Maps BHA substance use routes of administration to HL7 v3 RouteOfAdministration.

CO BHA Service Identifier to CPT/HCPCS ConceptMap

Informative (Colorado): Maps CO BHA service identifier codes to related CPT and HCPCS procedure/service concepts used in Colorado implementation workflows.

CO BHA Service Identifier to ICD-10-CM ConceptMap

Informative (Colorado): Maps CO BHA service identifier codes to related ICD-10-CM diagnosis concepts used in Colorado implementation workflows.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example BHA Admission Questionnaire Responses

Example Responses to BHA Admission Questionnaire Questions

Example BHA Client

Example Client

Example BHA Client Questionnaire Responses

Example Responses to BHA Client Questionnaire Questions

Example BHA Episode Diagnosis 2 — Mental Health

Second example Condition (encounter-diagnosis) for a BHA Episode with a Mental Health diagnosis type, illustrating multiple MH diagnoses for one episode.

Example BHA Episode Diagnosis — Mental Health

Example Condition (encounter-diagnosis) for a BHA Episode with a Mental Health diagnosis type, illustrating use of the bha-diagnosis-type extension.

Example BHA Episode Diagnosis — Substance Use Disorder

Example Condition (encounter-diagnosis) for a BHA Episode with a Substance Use Disorder diagnosis type, illustrating use of the bha-diagnosis-type extension.

Example Baby Patient Resource

Example Patient Resource for a Baby born to a BHA Client. This resource is referenced in the BHASCBabyQuestionnaireResponseResourceExample.

Example Diagnosis Questionnaire Responses

Example Responses to Diagnosis Questionnaire Questions

Example Discharge Questionnaire Responses

Example Responses to Discharge Questionnaire Questions

Example Encounter for a BHA Episode

Example Encounter for a BHA Episode.

Example Encounter for a BHA Episode of both Behavioral Health and Pregnancy for a Pregnant Client

Example Encounter for a BHA Episode of both Behavioral Health and Pregnancy for a Pregnant Client. This encounter references both a BH episode of care and a pregnancy episode of care.

Example Episode

Example Episode of Care record for a BHA service/admission

Example Episode of Care for Pregnant Client

Example Episode of Care resource for a pregnant client receiving BH services. This resource is referenced in the BHASCBabyQuestionnaireResponseExample and BHASCPregnancyQuestionnaireResponseExample.

Example Episode of Care for SUD Program

Example Episode of Care resource for a substance use disorder treatment episode for a BHA client. This resource is referenced in the BHASubstanceUseDisorderQuestionnaireResponseExample.

Example Organization

Example Organization record for a BHA clinic.

Example Pregnancy Condition

Example Condition resource representing a pregnancy diagnosis, used in the EpisodeOfCareExamplePG to illustrate a non-BHA episode of care for a pregnant client receiving BH services.

Example Pregnancy Status Observation

Example Observation Record for pregnancy status

Example SC Baby Questionnaire Resource Responses

Example Responses to Special Connections Baby Questionnaire Questions that include a Reference to the Baby's Patient Resource.

Example SC Baby Questionnaire Responses

Example Responses to Special Connections Baby Questionnaire Questions

Example SC Pregnancy and Postpartum Risk Screening Questionnaire Responses

Example Responses to Special Connections Pregnancy and Postpartum Risk Screening Questionnaire Questions

Example SC no Baby Questionnaire Responses

Example Responses to Special Connections Baby Questionnaire Questions, where there was a stillbirth.

Example Substance Use Disorder Questionnaire Responses

Example Responses to Substance Use Disorder Questionnaire Questions

Second Example Encounter for a BHA Episode

Second Example Encounter for a BHA Episode, illustrating multiple encounters for one episode.