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: Shall comply with

Official URL: http://hl7.org/fhir/StructureDefinition/workflow-shallComplyWith Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 2 Computable Name: ShallComplyWith
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1521

In satisfying this request or instantiating this definition, the expectations defined in the Definition resource are expected to be met. (This allows requirements defined elsewhere to be brought into play by reference rather than providing all of the detail in-line necessary to satisfy the referenced Definition.).

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)

    • 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

    Simple Extension with the type canonical, Reference, uri: In satisfying this request or instantiating this definition, the expectations defined in the Definition resource are expected to be met. (This allows requirements defined elsewhere to be brought into play by reference rather than providing all of the detail in-line necessary to satisfy the referenced Definition.).

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Resulting event shall comply with
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-shallComplyWith"
    ... value[x] 1..1 Value of extension
    .... valueCanonical canonical(ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire)
    .... valueReference Reference(ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire)
    .... valueUri uri

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Resulting event shall comply with
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-shallComplyWith"
    .... valueCanonical canonical(ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire)
    .... valueReference Reference(ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire)
    .... valueUri uri

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type canonical, Reference, uri: In satisfying this request or instantiating this definition, the expectations defined in the Definition resource are expected to be met. (This allows requirements defined elsewhere to be brought into play by reference rather than providing all of the detail in-line necessary to satisfy the referenced Definition.).

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Resulting event shall comply with
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-shallComplyWith"
    ... value[x] 1..1 Value of extension
    .... valueCanonical canonical(ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire)
    .... valueReference Reference(ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire)
    .... valueUri uri

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Resulting event shall comply with
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-shallComplyWith"
    .... valueCanonical canonical(ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire)
    .... valueReference Reference(ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire)
    .... valueUri uri

    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:

    • Adjust the extension context RequestOrchestration to Basic
    • 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 Resulting event shall comply with
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/workflow-shallComplyWith"
    . . . value[x] 1.. 1 Value of extension
    . . . . valueCanonical canonical ( ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire )
    . . . . valueReference Reference ( ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire )
    . . . . valueUri uri

    doco Documentation for this format

    R4

    The extension is represented a little differently in R4:

    • Adjust the extension context RequestOrchestration to Basic
    • 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 Resulting event shall comply with
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/workflow-shallComplyWith"
    . . . value[x] 1.. 1 Value of extension
    . . . . valueCanonical canonical ( ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire )
    . . . . valueReference Reference ( ActivityDefinition | Measure | ObservationDefinition | PlanDefinition | Questionnaire )
    . . . . valueUri uri

    doco Documentation for this format

    R3

    The extension is represented a little differently in R3:

    • Adjust the extension context RequestOrchestration to Basic
    • Adjust the extension context ServiceRequest to Basic
    • Adjust the extension context ObservationDefinition to Basic
    • Adjust the extension context DeviceDefinition to Basic
    • Adjust the extension context SpecimenDefinition to Basic
    • Remove the target profile http://hl7.org/fhir/StructureDefinition/ObservationDefinition from the element Extension.value[x]
    • Remove the target profile http://hl7.org/fhir/StructureDefinition/ObservationDefinition from the element Extension.value[x]
    • Map the type canonical to uri on the element Extension.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 Resulting event shall comply with
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/workflow-shallComplyWith"
    . . . value[x] 1.. 1 Value of extension
    . . . . valueUri uri
    . . . . valueReference Reference ( ActivityDefinition | Measure | PlanDefinition | Questionnaire )
    . . . . valueUri uri

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)