Colorado BHA FHIR Implementation Guide
0.1.0-current - ci-build Unknown region code '840'

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.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RatioPBC/bha-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Colorado BHA Encounter Profile

Official URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-encounter | Version: 0.1.0-current
Standards status: Trial-use | Maturity Level: 0 | Computable Name: BHAEncounter

Encounter profile for client visits and encounters related to BHA episodes

Usages:

- Refer to this Profile: Colorado BHA Episode Diagnosis Profile
- Examples for this Profile: Encounter/BHAEncounterExample

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:actionType | S | 1..1 | CodeableConcept | CCAR Action Type (01=admission, 03=update, 05=discharge) URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-action-type Binding: BHA Action Type Value Set (required)
extension:updateType | S | 0..1 | CodeableConcept | Type of update when applicable URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-update-type
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | (USCDI) Identifier(s) by which this encounter is known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI) The value that is unique Example General: 123456
status | ?!S Σ | 1..1 | code | (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
class | S Σ | 1..1 | Coding | (USCDI) Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
type | S Σ | 1..* | CodeableConcept | (USCDI) Specific type of encounter Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
subject | S Σ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) The patient or group present at the encounter
episodeOfCare | S Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
participant | S Σ | 0..* | BackboneElement | (USCDI) List of participants involved in the encounter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | (USCDI) Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) | (USCDI) Persons involved in the encounter other than the patient
period | S | 1..1 | Period | (USCDI) The start and end time of the encounter
start | S Σ C | 1..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
reasonCode | S Σ | 0..* | CodeableConcept | (USCDI) Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference | S Σ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) S | US Core Condition Encounter Diagnosis Profile(6.1.0) S | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) | (USCDI) Reason the encounter takes place (reference)
diagnosis | S Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S Σ | 1..1 | Reference(Colorado BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: BHA Diagnosis Type Value Set (required)
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
hospitalization | S | 0..1 | BackboneElement | (USCDI) Details about the admission to a healthcare service
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
dischargeDisposition | S | 0..1 | CodeableConcept | (USCDI) Category or kind of location after discharge Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
location | S | 0..* | BackboneElement | (USCDI) List of locations where the patient has been
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
location | S | 1..1 | Reference(Location) | (USCDI) Location the encounter takes place
serviceProvider | S | 1..1 | Reference(US Core Organization Profile(6.1.0)) | (USCDI) The organization (facility) responsible for this encounter
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1
Encounter.type | Base | extensible | US Core Encounter Type | 📍6.1.0 | US Core v6.1
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
Encounter.diagnosis.​use | Base | required | BHA Diagnosis Type Value Set | 📦0.1.0-current | This IG
Encounter.hospitalization.​dischargeDisposition | Base | preferred | US Core Discharge Disposition | 📍6.1.0 | US Core v6.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Encounter | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from USCoreEncounterProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:actionType | S | 1..1 | CodeableConcept | CCAR Action Type (01=admission, 03=update, 05=discharge) URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-action-type Binding: BHA Action Type Value Set (required)
extension:updateType | S | 0..1 | CodeableConcept | Type of update when applicable URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-update-type
episodeOfCare | S | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
period |  | 1..1 | Period | (USCDI) The start and end time of the encounter
start | S | 1..1 | dateTime | Starting time with inclusive boundary
end | S | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
diagnosis | S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
condition | S | 1..1 | Reference(Colorado BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: BHA Diagnosis Type Value Set (required)
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
serviceProvider |  | 1..1 | Reference(US Core Organization Profile(6.1.0)) | (USCDI) The organization (facility) responsible for this encounter
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Encounter.diagnosis.​use | Base | required | BHA Diagnosis Type Value Set | 📦0.1.0-current | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:actionType | S | 1..1 | CodeableConcept | CCAR Action Type (01=admission, 03=update, 05=discharge) URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-action-type Binding: BHA Action Type Value Set (required)
extension:updateType | S | 0..1 | CodeableConcept | Type of update when applicable URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-update-type
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | (USCDI) Identifier(s) by which this encounter is known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI) The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
status | ?!S Σ | 1..1 | code | (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory |  | 0..* | BackboneElement | List of past encounter statuses
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 | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified status
class | S Σ | 1..1 | Coding | (USCDI) Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
classHistory |  | 0..* | BackboneElement | List of past encounter classes
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
class |  | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified class
type | S Σ | 1..* | CodeableConcept | (USCDI) Specific type of encounter Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
subject | S Σ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) The patient or group present at the encounter
episodeOfCare | S Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
basedOn |  | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter
participant | S Σ | 0..* | BackboneElement | (USCDI) List of participants involved in the encounter
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
type | S Σ | 0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | (USCDI) Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) | (USCDI) Persons involved in the encounter other than the patient
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period | S | 1..1 | Period | (USCDI) The start and end time of the encounter
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 | S Σ C | 1..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
length |  | 0..1 | Duration | Quantity of time the encounter lasted (less time absent)
reasonCode | S Σ | 0..* | CodeableConcept | (USCDI) Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference | S Σ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) S | US Core Condition Encounter Diagnosis Profile(6.1.0) S | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) | (USCDI) Reason the encounter takes place (reference)
diagnosis | S Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
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 | S Σ | 1..1 | Reference(Colorado BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: BHA Diagnosis Type Value Set (required)
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
account |  | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter
hospitalization | S | 0..1 | BackboneElement | (USCDI) Details about the admission to a healthcare service
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
preAdmissionIdentifier |  | 0..1 | Identifier | Pre-admission identifier
origin |  | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission
admitSource |  | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission |  | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter.
dietPreference |  | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy |  | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement |  | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination |  | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged
dischargeDisposition | S | 0..1 | CodeableConcept | (USCDI) Category or kind of location after discharge Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
location | S | 0..* | BackboneElement | (USCDI) List of locations where the patient has been
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
location | S | 1..1 | Reference(Location) | (USCDI) Location the encounter takes place
status |  | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType |  | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period |  | 0..1 | Period | Time period during which the patient was present at the location
serviceProvider | S | 1..1 | Reference(US Core Organization Profile(6.1.0)) | (USCDI) The organization (facility) responsible for this encounter
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Encounter.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Encounter.identifier.​type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.statusHistory.​status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1
Encounter.type | Base | extensible | US Core Encounter Type | 📍6.1.0 | US Core v6.1
Encounter.serviceType | Base | example | Service type | 📦4.0.1 | FHIR Std.
Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
Encounter.diagnosis.​use | Base | required | BHA Diagnosis Type Value Set | 📦0.1.0-current | This IG
Encounter.hospitalization.​admitSource | Base | preferred | Admit source | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.1
Encounter.hospitalization.​dietPreference | Base | example | Diet | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​specialCourtesy | Base | preferred | Special courtesy | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​specialArrangement | Base | preferred | Special arrangements | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​dischargeDisposition | Base | preferred | US Core Discharge Disposition | 📍6.1.0 | US Core v6.1
Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std.
Encounter.location.physicalType | Base | example | Location type | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Encounter | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from USCoreEncounterProfile

Summary

Mandatory: 6 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

- Colorado BHA Episode Diagnosis Profile (http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-episode-diagnosis)

Extensions

This structure refers to these extensions:

- http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-action-type
- http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-update-type

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:actionType | S | 1..1 | CodeableConcept | CCAR Action Type (01=admission, 03=update, 05=discharge) URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-action-type Binding: BHA Action Type Value Set (required)
extension:updateType | S | 0..1 | CodeableConcept | Type of update when applicable URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-update-type
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | (USCDI) Identifier(s) by which this encounter is known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI) The value that is unique Example General: 123456
status | ?!S Σ | 1..1 | code | (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
class | S Σ | 1..1 | Coding | (USCDI) Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
type | S Σ | 1..* | CodeableConcept | (USCDI) Specific type of encounter Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
subject | S Σ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) The patient or group present at the encounter
episodeOfCare | S Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
participant | S Σ | 0..* | BackboneElement | (USCDI) List of participants involved in the encounter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | (USCDI) Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) | (USCDI) Persons involved in the encounter other than the patient
period | S | 1..1 | Period | (USCDI) The start and end time of the encounter
start | S Σ C | 1..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
reasonCode | S Σ | 0..* | CodeableConcept | (USCDI) Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference | S Σ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) S | US Core Condition Encounter Diagnosis Profile(6.1.0) S | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) | (USCDI) Reason the encounter takes place (reference)
diagnosis | S Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S Σ | 1..1 | Reference(Colorado BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: BHA Diagnosis Type Value Set (required)
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
hospitalization | S | 0..1 | BackboneElement | (USCDI) Details about the admission to a healthcare service
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
dischargeDisposition | S | 0..1 | CodeableConcept | (USCDI) Category or kind of location after discharge Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
location | S | 0..* | BackboneElement | (USCDI) List of locations where the patient has been
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
location | S | 1..1 | Reference(Location) | (USCDI) Location the encounter takes place
serviceProvider | S | 1..1 | Reference(US Core Organization Profile(6.1.0)) | (USCDI) The organization (facility) responsible for this encounter
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1
Encounter.type | Base | extensible | US Core Encounter Type | 📍6.1.0 | US Core v6.1
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
Encounter.diagnosis.​use | Base | required | BHA Diagnosis Type Value Set | 📦0.1.0-current | This IG
Encounter.hospitalization.​dischargeDisposition | Base | preferred | US Core Discharge Disposition | 📍6.1.0 | US Core v6.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Encounter | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from USCoreEncounterProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:actionType | S | 1..1 | CodeableConcept | CCAR Action Type (01=admission, 03=update, 05=discharge) URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-action-type Binding: BHA Action Type Value Set (required)
extension:updateType | S | 0..1 | CodeableConcept | Type of update when applicable URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-update-type
episodeOfCare | S | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
period |  | 1..1 | Period | (USCDI) The start and end time of the encounter
start | S | 1..1 | dateTime | Starting time with inclusive boundary
end | S | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
diagnosis | S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
condition | S | 1..1 | Reference(Colorado BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: BHA Diagnosis Type Value Set (required)
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
serviceProvider |  | 1..1 | Reference(US Core Organization Profile(6.1.0)) | (USCDI) The organization (facility) responsible for this encounter
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Encounter.diagnosis.​use | Base | required | BHA Diagnosis Type Value Set | 📦0.1.0-current | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:actionType | S | 1..1 | CodeableConcept | CCAR Action Type (01=admission, 03=update, 05=discharge) URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-action-type Binding: BHA Action Type Value Set (required)
extension:updateType | S | 0..1 | CodeableConcept | Type of update when applicable URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-update-type
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | (USCDI) Identifier(s) by which this encounter is known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI) The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
status | ?!S Σ | 1..1 | code | (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory |  | 0..* | BackboneElement | List of past encounter statuses
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 | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified status
class | S Σ | 1..1 | Coding | (USCDI) Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
classHistory |  | 0..* | BackboneElement | List of past encounter classes
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
class |  | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified class
type | S Σ | 1..* | CodeableConcept | (USCDI) Specific type of encounter Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
subject | S Σ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) The patient or group present at the encounter
episodeOfCare | S Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
basedOn |  | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter
participant | S Σ | 0..* | BackboneElement | (USCDI) List of participants involved in the encounter
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
type | S Σ | 0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | (USCDI) Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) | (USCDI) Persons involved in the encounter other than the patient
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period | S | 1..1 | Period | (USCDI) The start and end time of the encounter
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 | S Σ C | 1..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
length |  | 0..1 | Duration | Quantity of time the encounter lasted (less time absent)
reasonCode | S Σ | 0..* | CodeableConcept | (USCDI) Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference | S Σ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) S | US Core Condition Encounter Diagnosis Profile(6.1.0) S | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) | (USCDI) Reason the encounter takes place (reference)
diagnosis | S Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
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 | S Σ | 1..1 | Reference(Colorado BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter
use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: BHA Diagnosis Type Value Set (required)
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
account |  | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter
hospitalization | S | 0..1 | BackboneElement | (USCDI) Details about the admission to a healthcare service
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
preAdmissionIdentifier |  | 0..1 | Identifier | Pre-admission identifier
origin |  | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission
admitSource |  | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission |  | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter.
dietPreference |  | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy |  | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement |  | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination |  | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged
dischargeDisposition | S | 0..1 | CodeableConcept | (USCDI) Category or kind of location after discharge Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
location | S | 0..* | BackboneElement | (USCDI) List of locations where the patient has been
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
location | S | 1..1 | Reference(Location) | (USCDI) Location the encounter takes place
status |  | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType |  | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period |  | 0..1 | Period | Time period during which the patient was present at the location
serviceProvider | S | 1..1 | Reference(US Core Organization Profile(6.1.0)) | (USCDI) The organization (facility) responsible for this encounter
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Encounter.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Encounter.identifier.​type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.statusHistory.​status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.1
Encounter.type | Base | extensible | US Core Encounter Type | 📍6.1.0 | US Core v6.1
Encounter.serviceType | Base | example | Service type | 📦4.0.1 | FHIR Std.
Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
Encounter.diagnosis.​use | Base | required | BHA Diagnosis Type Value Set | 📦0.1.0-current | This IG
Encounter.hospitalization.​admitSource | Base | preferred | Admit source | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.1
Encounter.hospitalization.​dietPreference | Base | example | Diet | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​specialCourtesy | Base | preferred | Special courtesy | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​specialArrangement | Base | preferred | Special arrangements | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​dischargeDisposition | Base | preferred | US Core Discharge Disposition | 📍6.1.0 | US Core v6.1
Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std.
Encounter.location.physicalType | Base | example | Location type | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Encounter | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from USCoreEncounterProfile

Summary

Mandatory: 6 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

- Colorado BHA Episode Diagnosis Profile (http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-episode-diagnosis)

Extensions

This structure refers to these extensions:

- http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-action-type
- http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-update-type

Maturity: 0

Other representations of profile: CSV, Excel, Schematron