FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: Related Requirement

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Clinical Decision Support Computable Name: RelatedRequirement

Allows relationships to be established between data requirements. For example, a Medication data requirement that depends on a MedicationRequest data requirement.

Context of Use

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

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • New Content

    • 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: Allows relationships to be established between data requirements. For example, a Medication data requirement that depends on a MedicationRequest data requirement.

    • 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).
    • targetSearchParam: string: The name of a search parameter that establishes the relationship to the related data element.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension 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: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

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Extension
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:targetId 1..1 Extension What data requirement
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "targetId"
    ..... value[x] 0..1 string Value of extension
    .... extension:targetPath 0..1 Extension What element establishes the relationship
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "targetPath"
    ..... value[x] 0..1 string Value of extension
    .... extension:targetSearchParam 0..1 Extension What search parameter establishes the relationship
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "targetSearchParam"
    ..... value[x] 0..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Allows relationships to be established between data requirements. For example, a Medication data requirement that depends on a MedicationRequest data requirement.

    • 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).
    • targetSearchParam: string: The name of a search parameter that establishes the relationship to the related data element.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension 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: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

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Extension
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:targetId 1..1 Extension What data requirement
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "targetId"
    ..... value[x] 0..1 string Value of extension
    .... extension:targetPath 0..1 Extension What element establishes the relationship
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "targetPath"
    ..... value[x] 0..1 string Value of extension
    .... extension:targetSearchParam 0..1 Extension What search parameter establishes the relationship
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "targetSearchParam"
    ..... value[x] 0..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement"

    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()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)