US Behavioral Health Profiles Implementation Guide
0.1.0 - CI Build

US Behavioral Health Profiles Implementation Guide - Downloaded Version 0.1.0 See the Directory of published versions

## Resource Profile: Grant Information Observation Profile ( Experimental )

Official URL: http://fhir.org/guides/astp/bhp/StructureDefinition/bh-grant-info | Version: 0.1.0
Active as of 2025-08-18 | Computable Name: BehavioralHealthGrantInfo

Usages:

- Examples for this Profile: Observation/bh-grant-info-observation-example-1

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
--- | --- | --- | --- | ---
Observation | C | 0..* | USCoreSimpleObservationProfile(6.1.0) | assessment observation Constraints: obs-6, obs-7
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:program-info |  | 0..* | (Complex) | Program information including program ID and grant number URL: http://fhir.org/guides/astp/bhp/StructureDefinition/program-info
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
Slices for category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: USCoreSimpleObservationCategory (7.0.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
category:bh_funding | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Behavioral Health Program Funding Types (required)
code | S Σ | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred)
subject | S Σ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | (USCDI) Who and/or what the observation is about
effective[x] | S Σ | 0..1 |  | (USCDI) Clinically relevant time/time-period for observation
effectiveDateTime |  |  | dateTime S |
effectivePeriod |  |  | Period |
effectiveTiming |  |  | Timing |
effectiveInstant |  |  | instant |
performer | S Σ | 0..* | Reference(US Core Organization Profile(7.0.0)) | (USCDI) Who is responsible for the observation
value[x] | S Σ C | 0..1 | CodeableConcept S | (USCDI) Actual result Binding: Behavioral Health Program Funding Types (required)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Observation.status | required | ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status|4.0.1` From the FHIR Standard
Observation.category | preferred | ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:us-core | required | USCoreSimpleObservationCategory `http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category|7.0.0`
Observation.category:bh_funding | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG
Observation.code | preferred | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.value[x] | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Observation | 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 | Observation | 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 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Observation | 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() |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |

This structure is derived from USCoreSimpleObservationProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation |  | 0..* | USCoreSimpleObservationProfile(6.1.0) | assessment observation
extension |  | 0..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:program-info |  | 0..* | (Complex) | Program information including program ID and grant number URL: http://fhir.org/guides/astp/bhp/StructureDefinition/program-info
Slices for category |  | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this
category:bh_funding |  | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Behavioral Health Program Funding Types (required)
performer |  | 0..* | Reference(US Core Organization Profile(7.0.0)) | (USCDI) Who is responsible for the observation
value[x] |  | 0..1 | CodeableConcept | (USCDI) Actual result Binding: Behavioral Health Program Funding Types (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Observation.category:bh_funding | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG
Observation.value[x] | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation | C | 0..* | USCoreSimpleObservationProfile(6.1.0) | assessment observation Constraints: obs-6, obs-7
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 |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:program-info |  | 0..* | (Complex) | Program information including program ID and grant number URL: http://fhir.org/guides/astp/bhp/StructureDefinition/program-info
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business Identifier for observation
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event
status | ?!S Σ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
Slices for category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: USCoreSimpleObservationCategory (7.0.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
category:bh_funding | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Behavioral Health Program Funding Types (required)
code | S Σ | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred)
subject | S Σ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | (USCDI) Who and/or what the observation is about
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made
effective[x] | S Σ | 0..1 |  | (USCDI) Clinically relevant time/time-period for observation
effectiveDateTime |  |  | dateTime S |
effectivePeriod |  |  | Period |
effectiveTiming |  |  | Timing |
effectiveInstant |  |  | instant |
issued | Σ | 0..1 | instant | Date/Time this version was made available
performer | S Σ | 0..* | Reference(US Core Organization Profile(7.0.0)) | (USCDI) Who is responsible for the observation
value[x] | S Σ C | 0..1 | CodeableConcept S | (USCDI) Actual result Binding: Behavioral Health Program Funding Types (required)
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note |  | 0..* | Annotation | Comments about the observation
bodySite |  | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method |  | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations.
specimen |  | 0..1 | Reference(Specimen) | Specimen used for this observation
device |  | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
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
low | C | 0..1 | SimpleQuantity | Low Range, if relevant
high | C | 0..1 | SimpleQuantity | High Range, if relevant
type |  | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
appliesTo |  | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
age |  | 0..1 | Range | Applicable age range, if relevant
text |  | 0..1 | string | Text based reference range in an observation
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group
derivedFrom | Σ | 0..* | Reference(Observation | US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | ImagingStudy | Media | MolecularSequence) | (USCDI) US Core Profiles or other resource the observation is made from
component | Σ | 0..* | BackboneElement | Component results
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
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
value[x] | Σ | 0..1 |  | Actual component result
valueQuantity |  |  | Quantity |
valueCodeableConcept |  |  | CodeableConcept |
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueSampledData |  |  | SampledData |
valueTime |  |  | time |
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Observation.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Observation.status | required | ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status|4.0.1` From the FHIR Standard
Observation.category | preferred | ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:us-core | required | USCoreSimpleObservationCategory `http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category|7.0.0`
Observation.category:bh_funding | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG
Observation.code | preferred | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.value[x] | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG
Observation.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.bodySite | example | SNOMEDCTBodyStructures `http://hl7.org/fhir/ValueSet/body-site` From the FHIR Standard
Observation.method | example | ObservationMethods `http://hl7.org/fhir/ValueSet/observation-methods` From the FHIR Standard
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes `http://hl7.org/fhir/ValueSet/referencerange-meaning` From the FHIR Standard
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes `http://hl7.org/fhir/ValueSet/referencerange-appliesto` From the FHIR Standard
Observation.component.code | example | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Observation | 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 | Observation | 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 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Observation | 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() |
obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |

This structure is derived from USCoreSimpleObservationProfile

Summary

Structures

This structure refers to these other structures:

- US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|7.0.0)

Extensions

This structure refers to these extensions:

- http://fhir.org/guides/astp/bhp/StructureDefinition/program-info

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Observation.category

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation | C | 0..* | USCoreSimpleObservationProfile(6.1.0) | assessment observation Constraints: obs-6, obs-7
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:program-info |  | 0..* | (Complex) | Program information including program ID and grant number URL: http://fhir.org/guides/astp/bhp/StructureDefinition/program-info
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
Slices for category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: USCoreSimpleObservationCategory (7.0.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
category:bh_funding | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Behavioral Health Program Funding Types (required)
code | S Σ | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred)
subject | S Σ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | (USCDI) Who and/or what the observation is about
effective[x] | S Σ | 0..1 |  | (USCDI) Clinically relevant time/time-period for observation
effectiveDateTime |  |  | dateTime S |
effectivePeriod |  |  | Period |
effectiveTiming |  |  | Timing |
effectiveInstant |  |  | instant |
performer | S Σ | 0..* | Reference(US Core Organization Profile(7.0.0)) | (USCDI) Who is responsible for the observation
value[x] | S Σ C | 0..1 | CodeableConcept S | (USCDI) Actual result Binding: Behavioral Health Program Funding Types (required)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Observation.status | required | ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status|4.0.1` From the FHIR Standard
Observation.category | preferred | ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:us-core | required | USCoreSimpleObservationCategory `http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category|7.0.0`
Observation.category:bh_funding | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG
Observation.code | preferred | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.value[x] | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Observation | 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 | Observation | 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 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Observation | 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() |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |

Differential View

This structure is derived from USCoreSimpleObservationProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation |  | 0..* | USCoreSimpleObservationProfile(6.1.0) | assessment observation
extension |  | 0..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:program-info |  | 0..* | (Complex) | Program information including program ID and grant number URL: http://fhir.org/guides/astp/bhp/StructureDefinition/program-info
Slices for category |  | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this
category:bh_funding |  | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Behavioral Health Program Funding Types (required)
performer |  | 0..* | Reference(US Core Organization Profile(7.0.0)) | (USCDI) Who is responsible for the observation
value[x] |  | 0..1 | CodeableConcept | (USCDI) Actual result Binding: Behavioral Health Program Funding Types (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Observation.category:bh_funding | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG
Observation.value[x] | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation | C | 0..* | USCoreSimpleObservationProfile(6.1.0) | assessment observation Constraints: obs-6, obs-7
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 |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:program-info |  | 0..* | (Complex) | Program information including program ID and grant number URL: http://fhir.org/guides/astp/bhp/StructureDefinition/program-info
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business Identifier for observation
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event
status | ?!S Σ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
Slices for category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: USCoreSimpleObservationCategory (7.0.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
category:bh_funding | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Behavioral Health Program Funding Types (required)
code | S Σ | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred)
subject | S Σ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | (USCDI) Who and/or what the observation is about
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made
effective[x] | S Σ | 0..1 |  | (USCDI) Clinically relevant time/time-period for observation
effectiveDateTime |  |  | dateTime S |
effectivePeriod |  |  | Period |
effectiveTiming |  |  | Timing |
effectiveInstant |  |  | instant |
issued | Σ | 0..1 | instant | Date/Time this version was made available
performer | S Σ | 0..* | Reference(US Core Organization Profile(7.0.0)) | (USCDI) Who is responsible for the observation
value[x] | S Σ C | 0..1 | CodeableConcept S | (USCDI) Actual result Binding: Behavioral Health Program Funding Types (required)
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note |  | 0..* | Annotation | Comments about the observation
bodySite |  | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method |  | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations.
specimen |  | 0..1 | Reference(Specimen) | Specimen used for this observation
device |  | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
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
low | C | 0..1 | SimpleQuantity | Low Range, if relevant
high | C | 0..1 | SimpleQuantity | High Range, if relevant
type |  | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
appliesTo |  | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
age |  | 0..1 | Range | Applicable age range, if relevant
text |  | 0..1 | string | Text based reference range in an observation
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group
derivedFrom | Σ | 0..* | Reference(Observation | US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | ImagingStudy | Media | MolecularSequence) | (USCDI) US Core Profiles or other resource the observation is made from
component | Σ | 0..* | BackboneElement | Component results
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
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
value[x] | Σ | 0..1 |  | Actual component result
valueQuantity |  |  | Quantity |
valueCodeableConcept |  |  | CodeableConcept |
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueSampledData |  |  | SampledData |
valueTime |  |  | time |
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Observation.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Observation.status | required | ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status|4.0.1` From the FHIR Standard
Observation.category | preferred | ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:us-core | required | USCoreSimpleObservationCategory `http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category|7.0.0`
Observation.category:bh_funding | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG
Observation.code | preferred | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.value[x] | required | BehavioralHealthProgramFundingTypes `http://fhir.org/guides/astp/bhp/ValueSet/bh-funding-types` From this IG
Observation.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.bodySite | example | SNOMEDCTBodyStructures `http://hl7.org/fhir/ValueSet/body-site` From the FHIR Standard
Observation.method | example | ObservationMethods `http://hl7.org/fhir/ValueSet/observation-methods` From the FHIR Standard
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes `http://hl7.org/fhir/ValueSet/referencerange-meaning` From the FHIR Standard
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes `http://hl7.org/fhir/ValueSet/referencerange-appliesto` From the FHIR Standard
Observation.component.code | example | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Observation | 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 | Observation | 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 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Observation | 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() |
obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |

This structure is derived from USCoreSimpleObservationProfile

Summary

Structures

This structure refers to these other structures:

- US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|7.0.0)

Extensions

This structure refers to these extensions:

- http://fhir.org/guides/astp/bhp/StructureDefinition/program-info

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Observation.category

Other representations of profile: CSV, Excel, Schematron