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
| Official URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-episodeOfCare | Version: 0.3.0-current | ||||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: BHAEpisodeOfCare | |||
BHA EpisodeOfCare Profile for client admissions/services
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
  meta |
0..1 | Meta | Metadata about the resource | |
   lastUpdated |
1..1 | instant | When the resource version last changed | |
 implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |
| type |
1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: ValueSet for BHA Diagnosis Type (required) | |
| diagnosis |
1..* | BackboneElement | The list of diagnosis relevant to this episode of care | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | Conditions/problems/diagnoses this episode of care is for | |
| role |
0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |
| patient |
1..1 | Reference(BHA Client Profile) | The Client who is the focus of this episode of care | |
| managingOrganization |
1..1 | Reference(BHA Provider Organization Profile) | Organization that assumes care | |
| identifier |
1..1 | Identifier | NPI / BHE License Number for the organization managing the episode of care | |
 period |
1..1 | Period | Interval during responsibility is assumed | |
 start |
C | 1..1 | dateTime | Starting time with inclusive boundary |
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type | Base | required | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
 meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error | |
| type |
1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: ValueSet for BHA Diagnosis Type (required) | |
| diagnosis |
1..* | BackboneElement | The list of diagnosis relevant to this episode of care | |
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | Conditions/problems/diagnoses this episode of care is for | |
| role |
0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) | |
| patient |
1..1 | Reference(BHA Client Profile) | The Client who is the focus of this episode of care | |
| managingOrganization |
1..1 | Reference(BHA Provider Organization Profile) | Organization that assumes care | |
| identifier |
1..1 | Identifier | NPI / BHE License Number for the organization managing the episode of care | |
| period |
1..1 | Period | Interval during responsibility is assumed | |
| start |
1..1 | dateTime | Starting time with inclusive boundary | |
| end |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.type | Base | required | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| statusHistory |
0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type |
1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: ValueSet for BHA Diagnosis Type (required) | |||||
| diagnosis |
1..* | BackboneElement | The list of diagnosis relevant to this episode of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | Conditions/problems/diagnoses this episode of care is for | |||||
| role |
0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| patient |
1..1 | Reference(BHA Client Profile) | The Client who is the focus of this episode of care | |||||
| managingOrganization |
1..1 | Reference(BHA Provider Organization Profile) | Organization that assumes care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | Identifier | NPI / BHE License Number for the organization managing the episode of care | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| period |
1..1 | Period | Interval during responsibility is assumed | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
C | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| referralRequest |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type | Base | required | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.managingOrganization.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from EpisodeOfCare
Summary
Mandatory: 6 elements(1 nested mandatory element)
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
| meta |
0..1 | Meta | Metadata about the resource | |
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |
| type |
1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: ValueSet for BHA Diagnosis Type (required) | |
| diagnosis |
1..* | BackboneElement | The list of diagnosis relevant to this episode of care | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | Conditions/problems/diagnoses this episode of care is for | |
| role |
0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |
| patient |
1..1 | Reference(BHA Client Profile) | The Client who is the focus of this episode of care | |
| managingOrganization |
1..1 | Reference(BHA Provider Organization Profile) | Organization that assumes care | |
| identifier |
1..1 | Identifier | NPI / BHE License Number for the organization managing the episode of care | |
| period |
1..1 | Period | Interval during responsibility is assumed | |
| start |
C | 1..1 | dateTime | Starting time with inclusive boundary |
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type | Base | required | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
| meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error | |
| type |
1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: ValueSet for BHA Diagnosis Type (required) | |
| diagnosis |
1..* | BackboneElement | The list of diagnosis relevant to this episode of care | |
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | Conditions/problems/diagnoses this episode of care is for | |
| role |
0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) | |
| patient |
1..1 | Reference(BHA Client Profile) | The Client who is the focus of this episode of care | |
| managingOrganization |
1..1 | Reference(BHA Provider Organization Profile) | Organization that assumes care | |
| identifier |
1..1 | Identifier | NPI / BHE License Number for the organization managing the episode of care | |
| period |
1..1 | Period | Interval during responsibility is assumed | |
| start |
1..1 | dateTime | Starting time with inclusive boundary | |
| end |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.type | Base | required | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| statusHistory |
0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type |
1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: ValueSet for BHA Diagnosis Type (required) | |||||
| diagnosis |
1..* | BackboneElement | The list of diagnosis relevant to this episode of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | Conditions/problems/diagnoses this episode of care is for | |||||
| role |
0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| patient |
1..1 | Reference(BHA Client Profile) | The Client who is the focus of this episode of care | |||||
| managingOrganization |
1..1 | Reference(BHA Provider Organization Profile) | Organization that assumes care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | Identifier | NPI / BHE License Number for the organization managing the episode of care | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| period |
1..1 | Period | Interval during responsibility is assumed | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
C | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| referralRequest |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type | Base | required | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.managingOrganization.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from EpisodeOfCare
Summary
Mandatory: 6 elements(1 nested mandatory element)
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
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
| 