FHIR Extensions Pack
5.3.0 - May 2026 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 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: Suppress Actor

Official URL: http://hl7.org/fhir/StructureDefinition/canonicalresource-suppressActor Version: 5.3.0
Standards status: Draft Maturity Level: 0 Computable Name: SuppressActor
Other Identifiers: OID:2.16.840.1.113883.4.642.40.97.42.150

Identifies an actor that is 'not relevant' for the purposes of the current publication and that will therefore not be prominently exposed in the profile tables, nor used when determining 'key elements' based on obligations.

When inheriting from a parent profile, there may be obligations and additional bindings that are inherited that aren't relevant in the context of the current implementation guide. Obligations cannot be removed when deriving, but it is possible to not render obligations that aren't relevant.

This is an draft extension definition; the committee is seeking implementation feedback, and the definition or contents of the extension may change in future versions

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 Specification

You can also check for usages in the FHIR IG Statistics

Changes since version 5.3.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

    Simple Extension with the type canonical: Identifies an actor that is 'not relevant' for the purposes of the current publication and that will therefore not be prominently exposed in the profile tables, nor used when determining 'key elements' based on obligations.

    Maturity: 0

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension An actor that is not relevant for this publication
    Extension.extension 0..0 Extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-suppressActor"
    Extension.value[x] 1..1 canonical(ActorDefinition) Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension An actor that is not relevant for this publication
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-suppressActor"
    Extension.value[x] 1..1 canonical(ActorDefinition) Value of extension

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type canonical: Identifies an actor that is 'not relevant' for the purposes of the current publication and that will therefore not be prominently exposed in the profile tables, nor used when determining 'key elements' based on obligations.

    Maturity: 0

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension An actor that is not relevant for this publication
    Extension.extension 0..0 Extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-suppressActor"
    Extension.value[x] 1..1 canonical(ActorDefinition) Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension An actor that is not relevant for this publication
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-suppressActor"
    Extension.value[x] 1..1 canonical(ActorDefinition) Value of extension

    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/ActorDefinition from the element Extension.value[x]
    Name Flags Card. Type Description & Constraints      Filter: doco
    Extension 0..* Extension An actor that is not relevant for this publication
    Extension. extension 0 .. 0 Extension
    Extension. url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-suppressActor"
    Extension. value[x] 1.. 1 canonical () 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/ActorDefinition from the element Extension.value[x]
    Name Flags Card. Type Description & Constraints      Filter: doco
    Extension 0..* Extension An actor that is not relevant for this publication
    Extension. extension 0 .. 0 Extension
    Extension. url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-suppressActor"
    Extension. value[x] 1.. 1 canonical () 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/ActorDefinition from the element Extension.value[x]
    • Map the type canonical to uri on the element Extension.value[x]
    Name Flags Card. Type Description & Constraints      Filter: doco
    Extension 0..* Extension An actor that is not relevant for this publication
    Extension. extension 0 .. 0 Extension
    Extension. url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/canonicalresource-suppressActor"
    Extension. value[x] 1.. 1 uri Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)