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

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot: 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: Additional Resource Compartment

Official URL: http://hl7.org/fhir/StructureDefinition/additional-resource-compartment Version: 5.3.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: AdditionalResourceCompartment

Allows the definition of an additional resource to indicate the resource is a candidate for inclusion in a compartment by the implementing server.

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 the definition of an additional resource to indicate the resource is a candidate for inclusion in a compartment by the implementing server.

    • compartment: canonical: Reference to the compartment this resource would like to be included in.
    • param: string: Search Parameter Name, or chained parameters.
    • documentation: string: Additional documentation about the resource and compartment.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Compartment for an additional resource
    ... Slices for extension Content/Rules for all slices
    .... extension:compartment 1..1 Extension Reference to the compartment this resource would like to be included in
    ..... extension 0..0
    ..... url 1..1 uri "compartment"
    ..... value[x] 1..1 canonical(CompartmentDefinition) Value of extension
    .... extension:param 1..* Extension Search Parameter Name, or chained parameters
    ..... extension 0..0
    ..... url 1..1 uri "param"
    ..... value[x] 1..1 string Value of extension
    .... extension:documentation 0..1 Extension Additional documentation about the resource and compartment
    ..... extension 0..0
    ..... url 1..1 uri "documentation"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/additional-resource-compartment"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Compartment for an additional resource
    ... 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:compartment 1..1 Extension Reference to the compartment this resource would like to be included in
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "compartment"
    ..... value[x] 1..1 canonical(CompartmentDefinition) Value of extension
    .... extension:param 1..* Extension Search Parameter Name, or chained parameters
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "param"
    ..... value[x] 1..1 string Value of extension
    .... extension:documentation 0..1 Extension Additional documentation about the resource and compartment
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "documentation"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/additional-resource-compartment"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Allows the definition of an additional resource to indicate the resource is a candidate for inclusion in a compartment by the implementing server.

    • compartment: canonical: Reference to the compartment this resource would like to be included in.
    • param: string: Search Parameter Name, or chained parameters.
    • documentation: string: Additional documentation about the resource and compartment.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Compartment for an additional resource
    ... Slices for extension Content/Rules for all slices
    .... extension:compartment 1..1 Extension Reference to the compartment this resource would like to be included in
    ..... extension 0..0
    ..... url 1..1 uri "compartment"
    ..... value[x] 1..1 canonical(CompartmentDefinition) Value of extension
    .... extension:param 1..* Extension Search Parameter Name, or chained parameters
    ..... extension 0..0
    ..... url 1..1 uri "param"
    ..... value[x] 1..1 string Value of extension
    .... extension:documentation 0..1 Extension Additional documentation about the resource and compartment
    ..... extension 0..0
    ..... url 1..1 uri "documentation"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/additional-resource-compartment"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Compartment for an additional resource
    ... 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:compartment 1..1 Extension Reference to the compartment this resource would like to be included in
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "compartment"
    ..... value[x] 1..1 canonical(CompartmentDefinition) Value of extension
    .... extension:param 1..* Extension Search Parameter Name, or chained parameters
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "param"
    ..... value[x] 1..1 string Value of extension
    .... extension:documentation 0..1 Extension Additional documentation about the resource and compartment
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "documentation"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/additional-resource-compartment"

    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 represented a little differently in R3:

    • Map the type canonical to uri on the element Extension.extension:compartment.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 Compartment for an additional resource
    . . . Slices for extension Content/Rules for all slices
    . . . . extension:compartment 1..1 Extension Reference to the compartment this resource would like to be included in
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "compartment"
    . . . . . value[x] 1.. 1 uri Value of extension
    . . . . extension:param 1..* Extension Search Parameter Name, or chained parameters
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "param"
    . . . . . value[x] 1.. 1 string Value of extension
    . . . . extension:documentation 0..1 Extension Additional documentation about the resource and compartment
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "documentation"
    . . . . . value[x] 1.. 1 string Value of extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/additional-resource-compartment"
    . . . value[x] 0 .. 0

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)