US Behavioral Health Profiles Implementation Guide
0.1.0 - CI Build United States of America flag

US Behavioral Health Profiles Implementation Guide, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/us-behavioral-health-profiles/ and changes regularly. See the Directory of published versions

Extension: Grant Program ID and Number Extension

Official URL: http://hl7.org/fhir/us/bhp/StructureDefinition/program-info Version: 0.1.0
Draft as of 2024-09-16 Computable Name: GrantProgramIdAndNumber

Context of Use

This extension may be used on the following element(s):

  • Element ID Observation

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension:

  • program_id: string: The program id for a program that that is participating in a designated behavioral health program.
  • grant_number: string: The grant number that the behavioral health service is operating under.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Grant Program ID and Number
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:program_id S 0..1 Extension The program id for a program that that is participating in a designated behavioral health program.
..... extension 0..0
..... url 1..1 uri "program_id"
..... value[x] 1..1 string Value of extension
.... extension:grant_number S 0..1 Extension The grant number that the behavioral health service is operating under.
..... extension 0..0
..... url 1..1 uri "grant_number"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/bhp/StructureDefinition/program-info"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Grant Program ID and Number
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:program_id S 0..1 Extension The program id for a program that that is participating in a designated behavioral health program.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "program_id"
..... value[x] 1..1 string Value of extension
.... extension:grant_number S 0..1 Extension The grant number that the behavioral health service is operating under.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "grant_number"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/bhp/StructureDefinition/program-info"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension:

  • program_id: string: The program id for a program that that is participating in a designated behavioral health program.
  • grant_number: string: The grant number that the behavioral health service is operating under.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Grant Program ID and Number
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:program_id S 0..1 Extension The program id for a program that that is participating in a designated behavioral health program.
..... extension 0..0
..... url 1..1 uri "program_id"
..... value[x] 1..1 string Value of extension
.... extension:grant_number S 0..1 Extension The grant number that the behavioral health service is operating under.
..... extension 0..0
..... url 1..1 uri "grant_number"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/bhp/StructureDefinition/program-info"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Grant Program ID and Number
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:program_id S 0..1 Extension The program id for a program that that is participating in a designated behavioral health program.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "program_id"
..... value[x] 1..1 string Value of extension
.... extension:grant_number S 0..1 Extension The grant number that the behavioral health service is operating under.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "grant_number"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/bhp/StructureDefinition/program-info"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()