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-encounter | Version: 0.3.0-current | ||||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: BHAEncounter | |||
Encounter profile for client visits and encounters related to BHA EpisodeOfCare
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:  |
|---|---|---|---|---|
  Encounter |
0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient | |
  meta |
0..1 | Meta | Metadata about the resource | |
   lastUpdated |
0..1 | instant | When the resource version last changed | |
 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  extension:actionType |
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: ValueSet for BHA Action Type (required) | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
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 |
1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | (USCDI) The value that is unique Example General: 123456 | |
| status |
1..1 | code | (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
| class |
1..1 | Coding | (USCDI) Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter. | |
| type |
1..* | CodeableConcept | (USCDI) Specific type of encounter Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type | |
 subject |
1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) The patient or group present at the encounter | |
 Slices for episodeOfCare |
1..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against Slice: Unordered, Open by profile:resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| episodeOfCare:BHAEpisodeOfCareSlice |
1..* | Reference(BHA EpisodeOfCare Profile) | Episode(s) of care that this encounter should be recorded against | |
| participant |
0..* | BackboneElement | (USCDI) List of participants involved in the encounter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |
| period |
0..1 | Period | (USCDI) Period of time during the encounter that the participant participated | |
| individual |
0..1 | Reference(US Core Practitioner Profile(6.1.0) | 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 |
1..1 | Period | (USCDI) The start and end time of the encounter | |
| start |
C | 1..1 | dateTime | Starting time with inclusive boundary |
| end |
C | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
| reasonCode |
0..* | CodeableConcept | (USCDI) Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | |
| reasonReference |
0..* | Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) | US Core Condition Encounter Diagnosis Profile(6.1.0) | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) | (USCDI) Reason the encounter takes place (reference) | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter | |
| use |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ValueSet for BHA Diagnosis Type (required) | |
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |
| hospitalization |
0..1 | BackboneElement | (USCDI) Details about the admission to a healthcare service | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| dischargeDisposition |
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 |
0..* | BackboneElement | (USCDI) List of locations where the patient has been | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| location |
1..1 | Reference(Location) | (USCDI) Location the encounter takes place | |
| serviceProvider |
1..1 | Reference(US Core Organization Profile(6.1.0)) | (USCDI) The organization (facility) responsible for this encounter | |
| Documentation for this format | ||||
| 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.4 |
| 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 | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
| Encounter.hospitalization.dischargeDisposition | Base | preferred | US Core Discharge Disposition | 📍6.1.0 | US Core v6.1 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from USCoreEncounterProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Encounter |
0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient | |
 meta |
||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:actionType |
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: ValueSet for BHA Action Type (required) | |
| Slices for episodeOfCare |
1..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against Slice: Unordered, Open by profile:resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| episodeOfCare:BHAEpisodeOfCareSlice |
1..* | Reference(BHA EpisodeOfCare Profile) | 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 |
1..1 | dateTime | Starting time with inclusive boundary | |
| end |
1..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter | |
| use |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ValueSet for BHA Diagnosis Type (required) | |
| rank |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.diagnosis.use | Base | required | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| 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 |
0..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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:actionType |
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: ValueSet for BHA Action Type (required) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
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 |
1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
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 |
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 |
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 |
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 |
1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) The patient or group present at the encounter | |||||
| Slices for episodeOfCare |
1..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against Slice: Unordered, Open by profile:resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| episodeOfCare:BHAEpisodeOfCareSlice |
1..* | Reference(BHA EpisodeOfCare Profile) | Episode(s) of care that this encounter should be recorded against | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| participant |
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 |
0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
| period |
0..1 | Period | (USCDI) Period of time during the encounter that the participant participated | |||||
| individual |
0..1 | Reference(US Core Practitioner Profile(6.1.0) | 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 |
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 |
C | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
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 |
0..* | CodeableConcept | (USCDI) Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | |||||
| reasonReference |
0..* | Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) | US Core Condition Encounter Diagnosis Profile(6.1.0) | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) | (USCDI) Reason the encounter takes place (reference) | |||||
| diagnosis |
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 |
1..1 | Reference(BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter | |||||
| use |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ValueSet for BHA Diagnosis Type (required) | |||||
| rank |
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 |
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 |
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 |
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 |
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 |
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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| 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.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| 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.4 |
| 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 | ValueSet for BHA Diagnosis Type | 📦0.3.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.4 |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 8 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Encounter |
0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient | |
| meta |
0..1 | Meta | Metadata about the resource | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:actionType |
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: ValueSet for BHA Action Type (required) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
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 |
1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | (USCDI) The value that is unique Example General: 123456 | |
| status |
1..1 | code | (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
| class |
1..1 | Coding | (USCDI) Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter. | |
| type |
1..* | CodeableConcept | (USCDI) Specific type of encounter Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type | |
| subject |
1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) The patient or group present at the encounter | |
| Slices for episodeOfCare |
1..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against Slice: Unordered, Open by profile:resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| episodeOfCare:BHAEpisodeOfCareSlice |
1..* | Reference(BHA EpisodeOfCare Profile) | Episode(s) of care that this encounter should be recorded against | |
| participant |
0..* | BackboneElement | (USCDI) List of participants involved in the encounter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |
| period |
0..1 | Period | (USCDI) Period of time during the encounter that the participant participated | |
| individual |
0..1 | Reference(US Core Practitioner Profile(6.1.0) | 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 |
1..1 | Period | (USCDI) The start and end time of the encounter | |
| start |
C | 1..1 | dateTime | Starting time with inclusive boundary |
| end |
C | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
| reasonCode |
0..* | CodeableConcept | (USCDI) Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | |
| reasonReference |
0..* | Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) | US Core Condition Encounter Diagnosis Profile(6.1.0) | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) | (USCDI) Reason the encounter takes place (reference) | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter | |
| use |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ValueSet for BHA Diagnosis Type (required) | |
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |
| hospitalization |
0..1 | BackboneElement | (USCDI) Details about the admission to a healthcare service | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| dischargeDisposition |
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 |
0..* | BackboneElement | (USCDI) List of locations where the patient has been | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| location |
1..1 | Reference(Location) | (USCDI) Location the encounter takes place | |
| serviceProvider |
1..1 | Reference(US Core Organization Profile(6.1.0)) | (USCDI) The organization (facility) responsible for this encounter | |
| Documentation for this format | ||||
| 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.4 |
| 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 | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
| Encounter.hospitalization.dischargeDisposition | Base | preferred | US Core Discharge Disposition | 📍6.1.0 | US Core v6.1 |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from USCoreEncounterProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Encounter |
0..* | USCoreEncounterProfile(6.1.0) | An interaction during which services are provided to the patient | |
| meta |
||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:actionType |
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: ValueSet for BHA Action Type (required) | |
| Slices for episodeOfCare |
1..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against Slice: Unordered, Open by profile:resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| episodeOfCare:BHAEpisodeOfCareSlice |
1..* | Reference(BHA EpisodeOfCare Profile) | 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 |
1..1 | dateTime | Starting time with inclusive boundary | |
| end |
1..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| condition |
1..1 | Reference(BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter | |
| use |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ValueSet for BHA Diagnosis Type (required) | |
| rank |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.diagnosis.use | Base | required | ValueSet for BHA Diagnosis Type | 📦0.3.0-current | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| 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 |
0..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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:actionType |
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: ValueSet for BHA Action Type (required) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
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 |
1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
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 |
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 |
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 |
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 |
1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) The patient or group present at the encounter | |||||
| Slices for episodeOfCare |
1..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against Slice: Unordered, Open by profile:resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| episodeOfCare:BHAEpisodeOfCareSlice |
1..* | Reference(BHA EpisodeOfCare Profile) | Episode(s) of care that this encounter should be recorded against | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| participant |
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 |
0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
| period |
0..1 | Period | (USCDI) Period of time during the encounter that the participant participated | |||||
| individual |
0..1 | Reference(US Core Practitioner Profile(6.1.0) | 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 |
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 |
C | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
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 |
0..* | CodeableConcept | (USCDI) Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | |||||
| reasonReference |
0..* | Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) | US Core Condition Encounter Diagnosis Profile(6.1.0) | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) | (USCDI) Reason the encounter takes place (reference) | |||||
| diagnosis |
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 |
1..1 | Reference(BHA Episode Diagnosis Profile) | The diagnosis or procedure relevant to the encounter | |||||
| use |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ValueSet for BHA Diagnosis Type (required) | |||||
| rank |
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 |
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 |
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 |
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 |
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 |
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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| 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.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| 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.4 |
| 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 | ValueSet for BHA Diagnosis Type | 📦0.3.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.4 |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 8 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
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
| 