Colorado BHA FHIR Implementation Guide
0.2.0 - 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.2.0 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.

Colorado BHA Client Profile

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

Colorado BHA Encounter Profile

Encounter profile for client visits and encounters related to BHA episodes

Colorado BHA Episode Diagnosis Profile

Diagnosis profile for diagnoses related to Colorado BHA episodes

Colorado BHA Episode Profile

BHA episode profile for client admissions/services

Colorado BHA Provider Organization Profile

Provider Organization profile for Colorado 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)

BHA Diagnosis Type

The type of diagnosis for a client encounter. Can be either Mental Health or Substance Use Disorder

BHA Race Extension

Race classification per BHA requirements

BHA Update Type

Type of update for CCAR reporting

Terminology: Value Sets

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

ValueSet for BHA ASAM Levels of Care

ASAM Levels of Care for BHA services/admissions.

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 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 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 episodes

ValueSet for BHA Employment Status

Value set for employment statuses used in BHA episodes

ValueSet for BHA End of Treatment Reasons

End of Treatment Reasons for BHA services/admissions.

ValueSet for BHA Episode ID Types

Allowed values for Episode ID types

ValueSet for BHA Episode Identifier Codes

Episode identifiers for BHA services/admissions

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 episodes

ValueSet for BHA Living Situation

Value set for living situations used in BHA episodes

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 episodes

ValueSet for BHA Secondary and Tertiary Substance Use

Substance use codes for secondary and tertiary substance 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.

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 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 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 episodes

BHA Employment Status

Code system for employment statuses used in BHA episodes

BHA End of Treatment Reasons

End of Treatment Reasons for BHA services/admissions.

BHA Episode ID Types

Types of Episode IDs

BHA Episode Identifier Codes

Episode identifiers for BHA services/admissions.

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 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 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 episodes

BHA Living Situation

Code system for living situations used in BHA episodes

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 episodes

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.

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 Questionnaire Responses

Example Responses to BHA Client Questionnaire Questions

Example Baby Patient Resource

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

Example Colorado BHA Client

Example Client

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 Episode

Example Episode of Care record for a BHA service/admission

Example Organization

Example Organization record for a BHA clinic.

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