Atrius India Core FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Extension: Related Requirement
| Official URL: http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement | Version: 0.1.0 | ||||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: RelatedRequirement | |||
| Other Identifiers: OID:1.3.6.1.4.1.66219.1.42.209 | |||||
Allows relationships to be established between data requirements. For example, a Medication data requirement that depends on a MedicationRequest data requirement. Atrius overlay of Extensions Pack 5.3.0: adds targetProperty (publisher 2.3.3 still emits that slice; official name is targetPath). Canonical stays http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement.
Context of Use
-
Element ID:
DataRequirement
This extension may be used on the following element(s)
Usage info
Usages:
- Examples for this Extension: AtriusCMS165ControllingHighBP
You can also check for usages in the FHIR IG Statistics
Formal Views of Extension Content
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension(4.0.1) | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:targetId |
1..1 | Extension | What data requirement | |
  url |
1..1 | uri | "targetId" | |
  value[x] |
0..1 | string | Value of extension | |
| extension:targetPath |
0..1 | Extension | What element establishes the relationship | |
| url |
1..1 | uri | "targetPath" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetProperty |
0..1 | Extension | What element establishes the relationship | |
| url |
1..1 | uri | "targetProperty" | |
| value[x] |
0..1 | string | Value of extension | |
 extension:targetSearchParam |
0..1 | Extension | What search parameter establishes the relationship | |
 url |
1..1 | uri | "targetSearchParam" | |
| value[x] |
0..1 | string | Value of extension | |
 url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement" | |
 value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
 Extension |
0..* | Extension(4.0.1) | Extension Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
 Slices for extension |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:targetId |
1..1 | Extension | What data requirement Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| url |
1..1 | uri | "targetId" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetPath |
0..1 | Extension | What element establishes the relationship Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| url |
1..1 | uri | "targetPath" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetProperty |
0..1 | Extension | What element establishes the relationship Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| url |
1..1 | uri | "targetProperty" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetSearchParam |
0..1 | Extension | What search parameter establishes the relationship Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| url |
1..1 | uri | "targetSearchParam" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement" | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Extension, Extension.extension, Extension.extension:targetId, Extension.extension:targetId.extension, Extension.extension:targetId.value[x], Extension.extension:targetPath, Extension.extension:targetPath.extension, Extension.extension:targetPath.value[x], Extension.extension:targetProperty, Extension.extension:targetProperty.extension, Extension.extension:targetProperty.value[x], Extension.extension:targetSearchParam, Extension.extension:targetSearchParam.extension, Extension.extension:targetSearchParam.value[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Extension, Extension.extension, Extension.extension:targetId, Extension.extension:targetId.extension, Extension.extension:targetPath, Extension.extension:targetPath.extension, Extension.extension:targetProperty, Extension.extension:targetProperty.extension, Extension.extension:targetSearchParam, Extension.extension:targetSearchParam.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Complex Extension: Allows relationships to be established between data requirements. For example, a Medication data requirement that depends on a MedicationRequest data requirement. Atrius overlay of Extensions Pack 5.3.0: adds targetProperty (publisher 2.3.3 still emits that slice; official name is targetPath). Canonical stays http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement.
- targetId: string: The id of a related data requirement (i.e. a data requirement that establishes context for this data requirement)
- targetPath: string: The path to an element in the related data requirement that establishes the relationship. The element is typically of type Reference (or in some cases canonical).
- targetProperty: string: The path to an element in the related data requirement that establishes the relationship. The element is typically of type Reference (or in some cases canonical).
- targetSearchParam: string: The name of a search parameter that establishes the relationship to the related data element.
Maturity: 1
Differential ViewDifferential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension(4.0.1) | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:targetId |
1..1 | Extension | What data requirement | |
| url |
1..1 | uri | "targetId" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetPath |
0..1 | Extension | What element establishes the relationship | |
| url |
1..1 | uri | "targetPath" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetProperty |
0..1 | Extension | What element establishes the relationship | |
| url |
1..1 | uri | "targetProperty" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetSearchParam |
0..1 | Extension | What search parameter establishes the relationship | |
| url |
1..1 | uri | "targetSearchParam" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension(4.0.1) | Extension Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:targetId |
1..1 | Extension | What data requirement Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| url |
1..1 | uri | "targetId" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetPath |
0..1 | Extension | What element establishes the relationship Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| url |
1..1 | uri | "targetPath" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetProperty |
0..1 | Extension | What element establishes the relationship Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| url |
1..1 | uri | "targetProperty" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:targetSearchParam |
0..1 | Extension | What search parameter establishes the relationship Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| url |
1..1 | uri | "targetSearchParam" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement" | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Extension, Extension.extension, Extension.extension:targetId, Extension.extension:targetId.extension, Extension.extension:targetId.value[x], Extension.extension:targetPath, Extension.extension:targetPath.extension, Extension.extension:targetPath.value[x], Extension.extension:targetProperty, Extension.extension:targetProperty.extension, Extension.extension:targetProperty.value[x], Extension.extension:targetSearchParam, Extension.extension:targetSearchParam.extension, Extension.extension:targetSearchParam.value[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Extension, Extension.extension, Extension.extension:targetId, Extension.extension:targetId.extension, Extension.extension:targetPath, Extension.extension:targetPath.extension, Extension.extension:targetProperty, Extension.extension:targetProperty.extension, Extension.extension:targetSearchParam, Extension.extension:targetSearchParam.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Complex Extension: Allows relationships to be established between data requirements. For example, a Medication data requirement that depends on a MedicationRequest data requirement. Atrius overlay of Extensions Pack 5.3.0: adds targetProperty (publisher 2.3.3 still emits that slice; official name is targetPath). Canonical stays http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement.
- targetId: string: The id of a related data requirement (i.e. a data requirement that establishes context for this data requirement)
- targetPath: string: The path to an element in the related data requirement that establishes the relationship. The element is typically of type Reference (or in some cases canonical).
- targetProperty: string: The path to an element in the related data requirement that establishes the relationship. The element is typically of type Reference (or in some cases canonical).
- targetSearchParam: string: The name of a search parameter that establishes the relationship to the related data element.
Maturity: 1
Other representations of profile: CSV, Excel, Schematron