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

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.3.0-ballot-tc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Resource Satisfies Requirement

Official URL: http://hl7.org/fhir/StructureDefinition/satisfies-requirement Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 2 Computable Name: ResourceSatisfiesRequirement
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1168

References a requirement that this element satisfies. This might be referenced at the resource level by a profile, operation definition, etc. However, it could also point from a specific code in a value set, an interaction or search parameter in a CapabilityStatement, an action in a PlanDefinition, etc. to the requirement satisfied by that specific portion of the resource. Note that this extension is only used as part of the IG publication tooling process. Use the Requirements extension extension for use outside the IG publishing framework.

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:

  • The resource metadata has changed (status, description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • 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: References a requirement that this element satisfies. This might be referenced at the resource level by a profile, operation definition, etc. However, it could also point from a specific code in a value set, an interaction or search parameter in a CapabilityStatement, an action in a PlanDefinition, etc. to the requirement satisfied by that specific portion of the resource. Note that this extension is only used as part of the IG publication tooling process. Use the Requirements extension extension for use outside the IG publishing framework.

    • reference: canonical: The requirements resource that contains the requirement.
    • key: id: A key that identifies a requirement that this element satisfies.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A requirement that this element satisfies
    ... Slices for extension Content/Rules for all slices
    .... extension:reference 1..1 Extension Source reference.
    ..... extension 0..0 Extension
    ..... url 1..1 uri "reference"
    ..... value[x] 1..1 canonical(Requirements) Value of extension
    .... extension:key 1..* Extension Key that identifies requirement.
    ..... extension 0..0 Extension
    ..... url 1..1 uri "key"
    ..... value[x] 1..1 id Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/satisfies-requirement"
    ... value[x] 0..0 Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A requirement that this element satisfies
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:reference 1..1 Extension Source reference.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "reference"
    ..... value[x] 1..1 canonical(Requirements) Value of extension
    .... extension:key 1..* Extension Key that identifies requirement.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "key"
    ..... value[x] 1..1 id Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/satisfies-requirement"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: References a requirement that this element satisfies. This might be referenced at the resource level by a profile, operation definition, etc. However, it could also point from a specific code in a value set, an interaction or search parameter in a CapabilityStatement, an action in a PlanDefinition, etc. to the requirement satisfied by that specific portion of the resource. Note that this extension is only used as part of the IG publication tooling process. Use the Requirements extension extension for use outside the IG publishing framework.

    • reference: canonical: The requirements resource that contains the requirement.
    • key: id: A key that identifies a requirement that this element satisfies.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A requirement that this element satisfies
    ... Slices for extension Content/Rules for all slices
    .... extension:reference 1..1 Extension Source reference.
    ..... extension 0..0 Extension
    ..... url 1..1 uri "reference"
    ..... value[x] 1..1 canonical(Requirements) Value of extension
    .... extension:key 1..* Extension Key that identifies requirement.
    ..... extension 0..0 Extension
    ..... url 1..1 uri "key"
    ..... value[x] 1..1 id Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/satisfies-requirement"
    ... value[x] 0..0 Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A requirement that this element satisfies
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:reference 1..1 Extension Source reference.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "reference"
    ..... value[x] 1..1 canonical(Requirements) Value of extension
    .... extension:key 1..* Extension Key that identifies requirement.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "key"
    ..... value[x] 1..1 id Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/satisfies-requirement"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    Id Grade Path(s) Description Expression
    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()

    R4B

    The extension is represented a little differently in R4B:

    • Remove the target profile http://hl7.org/fhir/StructureDefinition/Requirements from the element Extension.extension:reference.value[x]
    • Note: Extensions that have been modified for R4B are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0 .. * Extension A requirement that this element satisfies
    . . . Slices for extension Content/Rules for all slices
    . . . . extension:reference 1..1 Extension Source reference.
    . . . . . extension 0 .. 0 Extension
    . . . . . url 1 .. 1 uri "reference"
    . . . . . value[x] 1.. 1 canonical () Value of extension
    . . . . extension:key 1..* Extension Key that identifies requirement.
    . . . . . extension 0 .. 0 Extension
    . . . . . url 1 .. 1 uri "key"
    . . . . . value[x] 1.. 1 id Value of extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/satisfies-requirement"
    . . . value[x] 0 .. 0 Value of extension

    doco Documentation for this format

    R4

    The extension is represented a little differently in R4:

    • Remove the target profile http://hl7.org/fhir/StructureDefinition/Requirements from the element Extension.extension:reference.value[x]
    • Note: Extensions that have been modified for R4 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0 .. * Extension A requirement that this element satisfies
    . . . Slices for extension Content/Rules for all slices
    . . . . extension:reference 1..1 Extension Source reference.
    . . . . . extension 0 .. 0 Extension
    . . . . . url 1 .. 1 uri "reference"
    . . . . . value[x] 1.. 1 canonical () Value of extension
    . . . . extension:key 1..* Extension Key that identifies requirement.
    . . . . . extension 0 .. 0 Extension
    . . . . . url 1 .. 1 uri "key"
    . . . . . value[x] 1.. 1 id Value of extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/satisfies-requirement"
    . . . value[x] 0 .. 0 Value of extension

    doco Documentation for this format

    R3

    The extension is represented a little differently in R3:

    • Remove the target profile http://hl7.org/fhir/StructureDefinition/Requirements from the element Extension.extension:reference.value[x]
    • Map the type canonical to uri on the element Extension.extension:reference.value[x]
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0 .. * Extension A requirement that this element satisfies
    . . . Slices for extension Content/Rules for all slices
    . . . . extension:reference 1..1 Extension Source reference.
    . . . . . extension 0 .. 0 Extension
    . . . . . url 1 .. 1 uri "reference"
    . . . . . value[x] 1.. 1 uri Value of extension
    . . . . extension:key 1..* Extension Key that identifies requirement.
    . . . . . extension 0 .. 0 Extension
    . . . . . url 1 .. 1 uri "key"
    . . . . . value[x] 1.. 1 id Value of extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/satisfies-requirement"
    . . . value[x] 0 .. 0 Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)