Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot International flag

Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMIManifestParameters - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the crmi-manifestparameters resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Parameters
Definition

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

ShortOperation Request or Response
Comments

The parameters that may be used are defined by the OperationDefinition resource.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
2. Parameters.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Parameters.parameter
Definition

A parameter passed to or received from the operation.

ShortOperation Parameter
Control0..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
SlicingThis element introduces a set of slices on Parameters.parameter. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ name
  • 6. Parameters.parameter.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Parameters.parameter.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Parameters.parameter:includeDefinition
    Slice NameincludeDefinition
    Definition

    Controls whether the value set definition is included or excluded in value set expansions. This includes all elements of the ValueSet, including extensions, with the exception that the id and meta elements would be specific to the expansion, not to the definition of the value set, and the expansion itself is filled out.


    A parameter passed to or received from the operation.

    ShortInclude definition?Operation Parameter
    Control0..1*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    12. Parameters.parameter:includeDefinition.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Parameters.parameter:includeDefinition.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed ValueincludeDefinition
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Parameters.parameter:includeDefinition.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Parameters.parameter:activeOnly
    Slice NameactiveOnly
    Definition

    Controls whether inactive concepts are included or excluded in value set expansions. Note that if the value set explicitly specifies that inactive codes are included, this parameter can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them


    A parameter passed to or received from the operation.

    ShortOnly include active codes?Operation Parameter
    Control0..1*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    20. Parameters.parameter:activeOnly.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. Parameters.parameter:activeOnly.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed ValueactiveOnly
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Parameters.parameter:activeOnly.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Parameters.parameter:includeDraft
    Slice NameincludeDraft
    Definition

    Indicates that draft versions of the value set should be considered when determining the version of the value set to be used to perform the expand. If one (or more) draft versions exist, the $expand operation should use the latest draft to create the expansion. This parameter cannot be used at the same time as the valueSetVersion parameter. If a draft version does not exist, then the service should use the latest published (status=Active) version.


    A parameter passed to or received from the operation.

    ShortInclude unreleased content?Operation Parameter
    Control0..1*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    28. Parameters.parameter:includeDraft.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    30. Parameters.parameter:includeDraft.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed ValueincludeDraft
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Parameters.parameter:includeDraft.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Parameters.parameter:lastActiveVersion
    Slice NamelastActiveVersion
    Definition

    Indicates that if a code explicitly named in the definition is not active in the current (or requested) version of the code system for the expansion, that it should be included in the expansion with the version of the code system in which it was last active.


    A parameter passed to or received from the operation.

    ShortIndicate last active version?Operation Parameter
    Control0..1*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    36. Parameters.parameter:lastActiveVersion.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    38. Parameters.parameter:lastActiveVersion.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed ValuelastActiveVersion
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Parameters.parameter:lastActiveVersion.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Parameters.parameter:system-version
    Slice Namesystem-version
    Definition

    Specifies a version to use for a code system, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [system]|[version] - e.g. http://loinc.org|2.56


    A parameter passed to or received from the operation.

    ShortCode system version (deprecated, use default-system-version)Operation Parameter
    Comments

    Note that system-version is the name of the parameter in the R4 version of the $expand operation. It is being deprecated and replaced with default-system-version, but this profile supports both until the ecosystem fully supports the default-system-versionparameter.

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    44. Parameters.parameter:system-version.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    46. Parameters.parameter:system-version.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed Valuesystem-version
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. Parameters.parameter:system-version.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typecanonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. Parameters.parameter:system-version.value[x].extension:display
    Slice Namedisplay
    Definition

    The title or other name to display when referencing a resource by canonical URL.

    ShortDisplay name for canonical reference
    Control0..1
    TypeExtension(Display Name) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    52. Parameters.parameter:default-system-version
    Slice Namedefault-system-version
    Definition

    Specifies a version to use for a code system, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [system]|[version] - e.g. http://loinc.org|2.56


    A parameter passed to or received from the operation.

    ShortCode system versionOperation Parameter
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    54. Parameters.parameter:default-system-version.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    56. Parameters.parameter:default-system-version.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed Valuedefault-system-version
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. Parameters.parameter:default-system-version.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typecanonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. Parameters.parameter:default-system-version.value[x].extension:display
    Slice Namedisplay
    Definition

    The title or other name to display when referencing a resource by canonical URL.

    ShortDisplay name for canonical reference
    Control0..1
    TypeExtension(Display Name) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    62. Parameters.parameter:default-valueset-version
    Slice Namedefault-valueset-version
    Definition

    Specifies a version to use for a value set, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [valueset]|[version] - e.g. http://example.org/ValueSet/example|1.0.0


    A parameter passed to or received from the operation.

    ShortValue set versionOperation Parameter
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    64. Parameters.parameter:default-valueset-version.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    66. Parameters.parameter:default-valueset-version.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed Valuedefault-valueset-version
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. Parameters.parameter:default-valueset-version.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typecanonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    70. Parameters.parameter:default-valueset-version.value[x].extension:display
    Slice Namedisplay
    Definition

    The title or other name to display when referencing a resource by canonical URL.

    ShortDisplay name for canonical reference
    Control0..1
    TypeExtension(Display Name) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    72. Parameters.parameter:canonicalVersion
    Slice NamecanonicalVersion
    Definition

    Specifies a version to use for an artifact, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [artifact-url]|[version] - e.g. http://example.org/StructureDefinition/example|1.0.0


    A parameter passed to or received from the operation.

    ShortCanonical version (deprecated, use default-canonical-version)Operation Parameter
    Comments

    In CRMI 1.0, this parameter was proposed as a generalization that could be used to specify canonical version for any artifact. In CRMI 2.0, the parameter is default-canonical-version, and is only used for artifacts other than code systems and value sets.

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    74. Parameters.parameter:canonicalVersion.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    76. Parameters.parameter:canonicalVersion.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed ValuecanonicalVersion
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    78. Parameters.parameter:canonicalVersion.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typecanonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    80. Parameters.parameter:canonicalVersion.value[x].extension:display
    Slice Namedisplay
    Definition

    The title or other name to display when referencing a resource by canonical URL.

    ShortDisplay name for canonical reference
    Control0..1
    TypeExtension(Display Name) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    82. Parameters.parameter:canonicalVersion.value[x].extension:resourceType
    Slice NameresourceType
    Definition

    Specifies the type of resource the canonical references. If present, this extension SHALL be consistent with the actual type of the resource specified by the canonical on which it appears.

    ShortWhat type of resource
    Comments

    Knowing the actual type of the target of a canonical resource allows for improved processing of knowledge artifacts, but this information cannot be reliably inferred from the canonical URL, the URL must be resolved. This extension can be used to provide this information to facilitate dependency processing.

    Control0..1
    TypeExtension(Resource Type) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    84. Parameters.parameter:default-canonical-version
    Slice Namedefault-canonical-version
    Definition

    Specifies a version to use for an artifact, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [artifact-url]|[version] - e.g. http://example.org/StructureDefinition/example|1.0.0


    A parameter passed to or received from the operation.

    ShortCanonical versionOperation Parameter
    Comments

    This parameter specifies the version to use for any canonical type of canonical artifact. For legacy reasons, the system-version (deprecated) and default-system-version parameters are used for CodeSystem references, and the default-valueset-version parameter is used for ValueSet references.

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
    86. Parameters.parameter:default-canonical-version.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    88. Parameters.parameter:default-canonical-version.name
    Definition

    The name of the parameter (reference to the operation definition).

    ShortName from the definition
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed Valuedefault-canonical-version
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    90. Parameters.parameter:default-canonical-version.value[x]
    Definition

    If the parameter is a data type.

    ShortIf parameter is a data type
    Control10..1
    This element is affected by the following invariants: inv-1
    Typecanonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    92. Parameters.parameter:default-canonical-version.value[x].extension:display
    Slice Namedisplay
    Definition

    The title or other name to display when referencing a resource by canonical URL.

    ShortDisplay name for canonical reference
    Control0..1
    TypeExtension(Display Name) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    94. Parameters.parameter:default-canonical-version.value[x].extension:uriReference
    Slice NameuriReference
    Definition

    If the reference is to a non-canonical-artifact, this extension is used to provide a canonical-like reference as a uri (e.g. http://example.org/fhir/Group/example|1.0.0).

    ShortUri for non-canonical artifact
    Control0..1
    TypeExtension(Artifact URI Reference) (Extension Type: uri)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    96. Parameters.parameter:default-canonical-version.value[x].extension:resourceType
    Slice NameresourceType
    Definition

    Specifies the type of resource the canonical references. If present, this extension SHALL be consistent with the actual type of the resource specified by the canonical on which it appears.

    ShortWhat type of resource
    Comments

    Knowing the actual type of the target of a canonical resource allows for improved processing of knowledge artifacts, but this information cannot be reliably inferred from the canonical URL, the URL must be resolved. This extension can be used to provide this information to facilitate dependency processing.

    Control0..1
    TypeExtension(Resource Type) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

    Guidance on how to interpret the contents of this table can be foundhere

    0. Parameters
    Must Supportfalse
    2. Parameters.parameter
    SlicingThis element introduces a set of slices on Parameters.parameter. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ name
    • 4. Parameters.parameter:includeDefinition
      Slice NameincludeDefinition
      Definition

      Controls whether the value set definition is included or excluded in value set expansions. This includes all elements of the ValueSet, including extensions, with the exception that the id and meta elements would be specific to the expansion, not to the definition of the value set, and the expansion itself is filled out.

      ShortInclude definition?
      Control0..1
      6. Parameters.parameter:includeDefinition.name
      Fixed ValueincludeDefinition
      8. Parameters.parameter:includeDefinition.value[x]
      Control1..?
      Typeboolean
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. Parameters.parameter:activeOnly
      Slice NameactiveOnly
      Definition

      Controls whether inactive concepts are included or excluded in value set expansions. Note that if the value set explicitly specifies that inactive codes are included, this parameter can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them

      ShortOnly include active codes?
      Control0..1
      12. Parameters.parameter:activeOnly.name
      Fixed ValueactiveOnly
      14. Parameters.parameter:activeOnly.value[x]
      Control1..?
      Typeboolean
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. Parameters.parameter:includeDraft
      Slice NameincludeDraft
      Definition

      Indicates that draft versions of the value set should be considered when determining the version of the value set to be used to perform the expand. If one (or more) draft versions exist, the $expand operation should use the latest draft to create the expansion. This parameter cannot be used at the same time as the valueSetVersion parameter. If a draft version does not exist, then the service should use the latest published (status=Active) version.

      ShortInclude unreleased content?
      Control0..1
      18. Parameters.parameter:includeDraft.name
      Fixed ValueincludeDraft
      20. Parameters.parameter:includeDraft.value[x]
      Control1..?
      Typeboolean
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. Parameters.parameter:lastActiveVersion
      Slice NamelastActiveVersion
      Definition

      Indicates that if a code explicitly named in the definition is not active in the current (or requested) version of the code system for the expansion, that it should be included in the expansion with the version of the code system in which it was last active.

      ShortIndicate last active version?
      Control0..1
      24. Parameters.parameter:lastActiveVersion.name
      Fixed ValuelastActiveVersion
      26. Parameters.parameter:lastActiveVersion.value[x]
      Control1..?
      Typeboolean
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. Parameters.parameter:system-version
      Slice Namesystem-version
      Definition

      Specifies a version to use for a code system, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [system]|[version] - e.g. http://loinc.org|2.56

      ShortCode system version (deprecated, use default-system-version)
      Comments

      Note that system-version is the name of the parameter in the R4 version of the $expand operation. It is being deprecated and replaced with default-system-version, but this profile supports both until the ecosystem fully supports the default-system-versionparameter.

      Control0..*
      30. Parameters.parameter:system-version.name
      Fixed Valuesystem-version
      32. Parameters.parameter:system-version.value[x]
      Control1..?
      Typecanonical
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      34. Parameters.parameter:system-version.value[x].extension:display
      Slice Namedisplay
      Control0..1
      TypeExtension(Display Name) (Extension Type: string)
      36. Parameters.parameter:default-system-version
      Slice Namedefault-system-version
      Definition

      Specifies a version to use for a code system, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [system]|[version] - e.g. http://loinc.org|2.56

      ShortCode system version
      Control0..*
      38. Parameters.parameter:default-system-version.name
      Fixed Valuedefault-system-version
      40. Parameters.parameter:default-system-version.value[x]
      Control1..?
      Typecanonical
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      42. Parameters.parameter:default-system-version.value[x].extension:display
      Slice Namedisplay
      Control0..1
      TypeExtension(Display Name) (Extension Type: string)
      44. Parameters.parameter:default-valueset-version
      Slice Namedefault-valueset-version
      Definition

      Specifies a version to use for a value set, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [valueset]|[version] - e.g. http://example.org/ValueSet/example|1.0.0

      ShortValue set version
      Control0..*
      46. Parameters.parameter:default-valueset-version.name
      Fixed Valuedefault-valueset-version
      48. Parameters.parameter:default-valueset-version.value[x]
      Control1..?
      Typecanonical
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      50. Parameters.parameter:default-valueset-version.value[x].extension:display
      Slice Namedisplay
      Control0..1
      TypeExtension(Display Name) (Extension Type: string)
      52. Parameters.parameter:canonicalVersion
      Slice NamecanonicalVersion
      Definition

      Specifies a version to use for an artifact, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [artifact-url]|[version] - e.g. http://example.org/StructureDefinition/example|1.0.0

      ShortCanonical version (deprecated, use default-canonical-version)
      Comments

      In CRMI 1.0, this parameter was proposed as a generalization that could be used to specify canonical version for any artifact. In CRMI 2.0, the parameter is default-canonical-version, and is only used for artifacts other than code systems and value sets.

      Control0..*
      54. Parameters.parameter:canonicalVersion.name
      Fixed ValuecanonicalVersion
      56. Parameters.parameter:canonicalVersion.value[x]
      Control1..?
      Typecanonical
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      58. Parameters.parameter:canonicalVersion.value[x].extension:display
      Slice Namedisplay
      Control0..1
      TypeExtension(Display Name) (Extension Type: string)
      60. Parameters.parameter:canonicalVersion.value[x].extension:resourceType
      Slice NameresourceType
      Control0..1
      TypeExtension(Resource Type) (Extension Type: code)
      62. Parameters.parameter:default-canonical-version
      Slice Namedefault-canonical-version
      Definition

      Specifies a version to use for an artifact, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [artifact-url]|[version] - e.g. http://example.org/StructureDefinition/example|1.0.0

      ShortCanonical version
      Comments

      This parameter specifies the version to use for any canonical type of canonical artifact. For legacy reasons, the system-version (deprecated) and default-system-version parameters are used for CodeSystem references, and the default-valueset-version parameter is used for ValueSet references.

      Control0..*
      64. Parameters.parameter:default-canonical-version.name
      Fixed Valuedefault-canonical-version
      66. Parameters.parameter:default-canonical-version.value[x]
      Control1..?
      Typecanonical
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      68. Parameters.parameter:default-canonical-version.value[x].extension:display
      Slice Namedisplay
      Control0..1
      TypeExtension(Display Name) (Extension Type: string)
      70. Parameters.parameter:default-canonical-version.value[x].extension:uriReference
      Slice NameuriReference
      Definition

      If the reference is to a non-canonical-artifact, this extension is used to provide a canonical-like reference as a uri (e.g. http://example.org/fhir/Group/example|1.0.0).

      ShortUri for non-canonical artifact
      Control0..1
      TypeExtension(Artifact URI Reference) (Extension Type: uri)
      72. Parameters.parameter:default-canonical-version.value[x].extension:resourceType
      Slice NameresourceType
      Control0..1
      TypeExtension(Resource Type) (Extension Type: code)

      Guidance on how to interpret the contents of this table can be foundhere

      0. Parameters
      Definition

      This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

      ShortOperation Request or Response
      Comments

      The parameters that may be used are defined by the OperationDefinition resource.

      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      2. Parameters.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. Parameters.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Parameters.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. Parameters.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Parameters.parameter
      Definition

      A parameter passed to or received from the operation.

      ShortOperation Parameter
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
      SlicingThis element introduces a set of slices on Parameters.parameter. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ name
      • 12. Parameters.parameter.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        14. Parameters.parameter.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        16. Parameters.parameter.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Parameters.parameter.name
        Definition

        The name of the parameter (reference to the operation definition).

        ShortName from the definition
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. Parameters.parameter.value[x]
        Definition

        If the parameter is a data type.

        ShortIf parameter is a data type
        Control0..1
        This element is affected by the following invariants: inv-1
        TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Parameters.parameter.resource
        Definition

        If the parameter is a whole resource.

        ShortIf parameter is a whole resource
        Comments

        When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

        Control0..1
        This element is affected by the following invariants: inv-1
        TypeResource
        Is Modifierfalse
        Summarytrue
        24. Parameters.parameter.part
        Definition

        A named part of a multi-part parameter.

        ShortNamed part of a multi-part parameter
        Comments

        Only one level of nested parameters is allowed.

        Control0..*
        TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. Parameters.parameter:includeDefinition
        Slice NameincludeDefinition
        Definition

        Controls whether the value set definition is included or excluded in value set expansions. This includes all elements of the ValueSet, including extensions, with the exception that the id and meta elements would be specific to the expansion, not to the definition of the value set, and the expansion itself is filled out.

        ShortInclude definition?
        Control0..1
        TypeBackboneElement
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
        28. Parameters.parameter:includeDefinition.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        30. Parameters.parameter:includeDefinition.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        32. Parameters.parameter:includeDefinition.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        34. Parameters.parameter:includeDefinition.name
        Definition

        The name of the parameter (reference to the operation definition).

        ShortName from the definition
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed ValueincludeDefinition
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Parameters.parameter:includeDefinition.value[x]
        Definition

        If the parameter is a data type.

        ShortIf parameter is a data type
        Control1..1
        This element is affected by the following invariants: inv-1
        Typeboolean
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Parameters.parameter:includeDefinition.resource
        Definition

        If the parameter is a whole resource.

        ShortIf parameter is a whole resource
        Comments

        When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

        Control0..1
        This element is affected by the following invariants: inv-1
        TypeResource
        Is Modifierfalse
        Summarytrue
        40. Parameters.parameter:includeDefinition.part
        Definition

        A named part of a multi-part parameter.

        ShortNamed part of a multi-part parameter
        Comments

        Only one level of nested parameters is allowed.

        Control0..*
        TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. Parameters.parameter:activeOnly
        Slice NameactiveOnly
        Definition

        Controls whether inactive concepts are included or excluded in value set expansions. Note that if the value set explicitly specifies that inactive codes are included, this parameter can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them

        ShortOnly include active codes?
        Control0..1
        TypeBackboneElement
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
        44. Parameters.parameter:activeOnly.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        46. Parameters.parameter:activeOnly.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        48. Parameters.parameter:activeOnly.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        50. Parameters.parameter:activeOnly.name
        Definition

        The name of the parameter (reference to the operation definition).

        ShortName from the definition
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed ValueactiveOnly
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Parameters.parameter:activeOnly.value[x]
        Definition

        If the parameter is a data type.

        ShortIf parameter is a data type
        Control1..1
        This element is affected by the following invariants: inv-1
        Typeboolean
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Parameters.parameter:activeOnly.resource
        Definition

        If the parameter is a whole resource.

        ShortIf parameter is a whole resource
        Comments

        When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

        Control0..1
        This element is affected by the following invariants: inv-1
        TypeResource
        Is Modifierfalse
        Summarytrue
        56. Parameters.parameter:activeOnly.part
        Definition

        A named part of a multi-part parameter.

        ShortNamed part of a multi-part parameter
        Comments

        Only one level of nested parameters is allowed.

        Control0..*
        TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Parameters.parameter:includeDraft
        Slice NameincludeDraft
        Definition

        Indicates that draft versions of the value set should be considered when determining the version of the value set to be used to perform the expand. If one (or more) draft versions exist, the $expand operation should use the latest draft to create the expansion. This parameter cannot be used at the same time as the valueSetVersion parameter. If a draft version does not exist, then the service should use the latest published (status=Active) version.

        ShortInclude unreleased content?
        Control0..1
        TypeBackboneElement
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
        60. Parameters.parameter:includeDraft.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        62. Parameters.parameter:includeDraft.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        64. Parameters.parameter:includeDraft.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        66. Parameters.parameter:includeDraft.name
        Definition

        The name of the parameter (reference to the operation definition).

        ShortName from the definition
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed ValueincludeDraft
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        68. Parameters.parameter:includeDraft.value[x]
        Definition

        If the parameter is a data type.

        ShortIf parameter is a data type
        Control1..1
        This element is affected by the following invariants: inv-1
        Typeboolean
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Parameters.parameter:includeDraft.resource
        Definition

        If the parameter is a whole resource.

        ShortIf parameter is a whole resource
        Comments

        When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

        Control0..1
        This element is affected by the following invariants: inv-1
        TypeResource
        Is Modifierfalse
        Summarytrue
        72. Parameters.parameter:includeDraft.part
        Definition

        A named part of a multi-part parameter.

        ShortNamed part of a multi-part parameter
        Comments

        Only one level of nested parameters is allowed.

        Control0..*
        TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. Parameters.parameter:lastActiveVersion
        Slice NamelastActiveVersion
        Definition

        Indicates that if a code explicitly named in the definition is not active in the current (or requested) version of the code system for the expansion, that it should be included in the expansion with the version of the code system in which it was last active.

        ShortIndicate last active version?
        Control0..1
        TypeBackboneElement
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
        76. Parameters.parameter:lastActiveVersion.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        78. Parameters.parameter:lastActiveVersion.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        80. Parameters.parameter:lastActiveVersion.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        82. Parameters.parameter:lastActiveVersion.name
        Definition

        The name of the parameter (reference to the operation definition).

        ShortName from the definition
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed ValuelastActiveVersion
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. Parameters.parameter:lastActiveVersion.value[x]
        Definition

        If the parameter is a data type.

        ShortIf parameter is a data type
        Control1..1
        This element is affected by the following invariants: inv-1
        Typeboolean
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        86. Parameters.parameter:lastActiveVersion.resource
        Definition

        If the parameter is a whole resource.

        ShortIf parameter is a whole resource
        Comments

        When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

        Control0..1
        This element is affected by the following invariants: inv-1
        TypeResource
        Is Modifierfalse
        Summarytrue
        88. Parameters.parameter:lastActiveVersion.part
        Definition

        A named part of a multi-part parameter.

        ShortNamed part of a multi-part parameter
        Comments

        Only one level of nested parameters is allowed.

        Control0..*
        TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        90. Parameters.parameter:system-version
        Slice Namesystem-version
        Definition

        Specifies a version to use for a code system, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [system]|[version] - e.g. http://loinc.org|2.56

        ShortCode system version (deprecated, use default-system-version)
        Comments

        Note that system-version is the name of the parameter in the R4 version of the $expand operation. It is being deprecated and replaced with default-system-version, but this profile supports both until the ecosystem fully supports the default-system-versionparameter.

        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
        92. Parameters.parameter:system-version.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        94. Parameters.parameter:system-version.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        96. Parameters.parameter:system-version.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        98. Parameters.parameter:system-version.name
        Definition

        The name of the parameter (reference to the operation definition).

        ShortName from the definition
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed Valuesystem-version
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        100. Parameters.parameter:system-version.value[x]
        Definition

        If the parameter is a data type.

        ShortIf parameter is a data type
        Control1..1
        This element is affected by the following invariants: inv-1
        Typecanonical
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        102. Parameters.parameter:system-version.value[x].id
        Definition

        unique id for the element within a resource (for internal references)

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        104. Parameters.parameter:system-version.value[x].extension
        Definition

        An Extension

        ShortExtension
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Parameters.parameter.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 106. Parameters.parameter:system-version.value[x].extension:display
          Slice Namedisplay
          Definition

          The title or other name to display when referencing a resource by canonical URL.

          ShortDisplay name for canonical reference
          Control0..1
          TypeExtension(Display Name) (Extension Type: string)
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          108. Parameters.parameter:system-version.value[x].value
          Definition

          Primitive value for canonical

          ShortPrimitive value for canonical
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          110. Parameters.parameter:system-version.resource
          Definition

          If the parameter is a whole resource.

          ShortIf parameter is a whole resource
          Comments

          When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

          Control0..1
          This element is affected by the following invariants: inv-1
          TypeResource
          Is Modifierfalse
          Summarytrue
          112. Parameters.parameter:system-version.part
          Definition

          A named part of a multi-part parameter.

          ShortNamed part of a multi-part parameter
          Comments

          Only one level of nested parameters is allowed.

          Control0..*
          TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          114. Parameters.parameter:default-system-version
          Slice Namedefault-system-version
          Definition

          Specifies a version to use for a code system, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [system]|[version] - e.g. http://loinc.org|2.56

          ShortCode system version
          Control0..*
          TypeBackboneElement
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
          116. Parameters.parameter:default-system-version.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          118. Parameters.parameter:default-system-version.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          120. Parameters.parameter:default-system-version.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          122. Parameters.parameter:default-system-version.name
          Definition

          The name of the parameter (reference to the operation definition).

          ShortName from the definition
          Control1..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Fixed Valuedefault-system-version
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          124. Parameters.parameter:default-system-version.value[x]
          Definition

          If the parameter is a data type.

          ShortIf parameter is a data type
          Control1..1
          This element is affected by the following invariants: inv-1
          Typecanonical
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          126. Parameters.parameter:default-system-version.value[x].id
          Definition

          unique id for the element within a resource (for internal references)

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          128. Parameters.parameter:default-system-version.value[x].extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Parameters.parameter.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 130. Parameters.parameter:default-system-version.value[x].extension:display
            Slice Namedisplay
            Definition

            The title or other name to display when referencing a resource by canonical URL.

            ShortDisplay name for canonical reference
            Control0..1
            TypeExtension(Display Name) (Extension Type: string)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            132. Parameters.parameter:default-system-version.value[x].value
            Definition

            Primitive value for canonical

            ShortPrimitive value for canonical
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            134. Parameters.parameter:default-system-version.resource
            Definition

            If the parameter is a whole resource.

            ShortIf parameter is a whole resource
            Comments

            When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

            Control0..1
            This element is affected by the following invariants: inv-1
            TypeResource
            Is Modifierfalse
            Summarytrue
            136. Parameters.parameter:default-system-version.part
            Definition

            A named part of a multi-part parameter.

            ShortNamed part of a multi-part parameter
            Comments

            Only one level of nested parameters is allowed.

            Control0..*
            TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            138. Parameters.parameter:default-valueset-version
            Slice Namedefault-valueset-version
            Definition

            Specifies a version to use for a value set, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [valueset]|[version] - e.g. http://example.org/ValueSet/example|1.0.0

            ShortValue set version
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
            140. Parameters.parameter:default-valueset-version.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            142. Parameters.parameter:default-valueset-version.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            144. Parameters.parameter:default-valueset-version.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            146. Parameters.parameter:default-valueset-version.name
            Definition

            The name of the parameter (reference to the operation definition).

            ShortName from the definition
            Control1..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Fixed Valuedefault-valueset-version
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            148. Parameters.parameter:default-valueset-version.value[x]
            Definition

            If the parameter is a data type.

            ShortIf parameter is a data type
            Control1..1
            This element is affected by the following invariants: inv-1
            Typecanonical
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            150. Parameters.parameter:default-valueset-version.value[x].id
            Definition

            unique id for the element within a resource (for internal references)

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            152. Parameters.parameter:default-valueset-version.value[x].extension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Parameters.parameter.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 154. Parameters.parameter:default-valueset-version.value[x].extension:display
              Slice Namedisplay
              Definition

              The title or other name to display when referencing a resource by canonical URL.

              ShortDisplay name for canonical reference
              Control0..1
              TypeExtension(Display Name) (Extension Type: string)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              156. Parameters.parameter:default-valueset-version.value[x].value
              Definition

              Primitive value for canonical

              ShortPrimitive value for canonical
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              158. Parameters.parameter:default-valueset-version.resource
              Definition

              If the parameter is a whole resource.

              ShortIf parameter is a whole resource
              Comments

              When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

              Control0..1
              This element is affected by the following invariants: inv-1
              TypeResource
              Is Modifierfalse
              Summarytrue
              160. Parameters.parameter:default-valueset-version.part
              Definition

              A named part of a multi-part parameter.

              ShortNamed part of a multi-part parameter
              Comments

              Only one level of nested parameters is allowed.

              Control0..*
              TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              162. Parameters.parameter:canonicalVersion
              Slice NamecanonicalVersion
              Definition

              Specifies a version to use for an artifact, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [artifact-url]|[version] - e.g. http://example.org/StructureDefinition/example|1.0.0

              ShortCanonical version (deprecated, use default-canonical-version)
              Comments

              In CRMI 1.0, this parameter was proposed as a generalization that could be used to specify canonical version for any artifact. In CRMI 2.0, the parameter is default-canonical-version, and is only used for artifacts other than code systems and value sets.

              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
              164. Parameters.parameter:canonicalVersion.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              166. Parameters.parameter:canonicalVersion.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              168. Parameters.parameter:canonicalVersion.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored even if unrecognized
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              Requirements

              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

              Alternate Namesextensions, user content, modifiers
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              170. Parameters.parameter:canonicalVersion.name
              Definition

              The name of the parameter (reference to the operation definition).

              ShortName from the definition
              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Fixed ValuecanonicalVersion
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              172. Parameters.parameter:canonicalVersion.value[x]
              Definition

              If the parameter is a data type.

              ShortIf parameter is a data type
              Control1..1
              This element is affected by the following invariants: inv-1
              Typecanonical
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              174. Parameters.parameter:canonicalVersion.value[x].id
              Definition

              unique id for the element within a resource (for internal references)

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              176. Parameters.parameter:canonicalVersion.value[x].extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Parameters.parameter.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 178. Parameters.parameter:canonicalVersion.value[x].extension:display
                Slice Namedisplay
                Definition

                The title or other name to display when referencing a resource by canonical URL.

                ShortDisplay name for canonical reference
                Control0..1
                TypeExtension(Display Name) (Extension Type: string)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                180. Parameters.parameter:canonicalVersion.value[x].extension:resourceType
                Slice NameresourceType
                Definition

                Specifies the type of resource the canonical references. If present, this extension SHALL be consistent with the actual type of the resource specified by the canonical on which it appears.

                ShortWhat type of resource
                Comments

                Knowing the actual type of the target of a canonical resource allows for improved processing of knowledge artifacts, but this information cannot be reliably inferred from the canonical URL, the URL must be resolved. This extension can be used to provide this information to facilitate dependency processing.

                Control0..1
                TypeExtension(Resource Type) (Extension Type: code)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                182. Parameters.parameter:canonicalVersion.value[x].value
                Definition

                Primitive value for canonical

                ShortPrimitive value for canonical
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                184. Parameters.parameter:canonicalVersion.resource
                Definition

                If the parameter is a whole resource.

                ShortIf parameter is a whole resource
                Comments

                When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

                Control0..1
                This element is affected by the following invariants: inv-1
                TypeResource
                Is Modifierfalse
                Summarytrue
                186. Parameters.parameter:canonicalVersion.part
                Definition

                A named part of a multi-part parameter.

                ShortNamed part of a multi-part parameter
                Comments

                Only one level of nested parameters is allowed.

                Control0..*
                TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                188. Parameters.parameter:default-canonical-version
                Slice Namedefault-canonical-version
                Definition

                Specifies a version to use for an artifact, if the reference does not specify which one to use (i.e. is a version-independent reference). The format is the same as a versioned canonical reference: [artifact-url]|[version] - e.g. http://example.org/StructureDefinition/example|1.0.0

                ShortCanonical version
                Comments

                This parameter specifies the version to use for any canonical type of canonical artifact. For legacy reasons, the system-version (deprecated) and default-system-version parameters are used for CodeSystem references, and the default-valueset-version parameter is used for ValueSet references.

                Control0..*
                TypeBackboneElement
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
                190. Parameters.parameter:default-canonical-version.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                192. Parameters.parameter:default-canonical-version.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                194. Parameters.parameter:default-canonical-version.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                196. Parameters.parameter:default-canonical-version.name
                Definition

                The name of the parameter (reference to the operation definition).

                ShortName from the definition
                Control1..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Fixed Valuedefault-canonical-version
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                198. Parameters.parameter:default-canonical-version.value[x]
                Definition

                If the parameter is a data type.

                ShortIf parameter is a data type
                Control1..1
                This element is affected by the following invariants: inv-1
                Typecanonical
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                200. Parameters.parameter:default-canonical-version.value[x].id
                Definition

                unique id for the element within a resource (for internal references)

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                202. Parameters.parameter:default-canonical-version.value[x].extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Parameters.parameter.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 204. Parameters.parameter:default-canonical-version.value[x].extension:display
                  Slice Namedisplay
                  Definition

                  The title or other name to display when referencing a resource by canonical URL.

                  ShortDisplay name for canonical reference
                  Control0..1
                  TypeExtension(Display Name) (Extension Type: string)
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  206. Parameters.parameter:default-canonical-version.value[x].extension:uriReference
                  Slice NameuriReference
                  Definition

                  If the reference is to a non-canonical-artifact, this extension is used to provide a canonical-like reference as a uri (e.g. http://example.org/fhir/Group/example|1.0.0).

                  ShortUri for non-canonical artifact
                  Control0..1
                  TypeExtension(Artifact URI Reference) (Extension Type: uri)
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  208. Parameters.parameter:default-canonical-version.value[x].extension:resourceType
                  Slice NameresourceType
                  Definition

                  Specifies the type of resource the canonical references. If present, this extension SHALL be consistent with the actual type of the resource specified by the canonical on which it appears.

                  ShortWhat type of resource
                  Comments

                  Knowing the actual type of the target of a canonical resource allows for improved processing of knowledge artifacts, but this information cannot be reliably inferred from the canonical URL, the URL must be resolved. This extension can be used to provide this information to facilitate dependency processing.

                  Control0..1
                  TypeExtension(Resource Type) (Extension Type: code)
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  210. Parameters.parameter:default-canonical-version.value[x].value
                  Definition

                  Primitive value for canonical

                  ShortPrimitive value for canonical
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  212. Parameters.parameter:default-canonical-version.resource
                  Definition

                  If the parameter is a whole resource.

                  ShortIf parameter is a whole resource
                  Comments

                  When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

                  Control0..1
                  This element is affected by the following invariants: inv-1
                  TypeResource
                  Is Modifierfalse
                  Summarytrue
                  214. Parameters.parameter:default-canonical-version.part
                  Definition

                  A named part of a multi-part parameter.

                  ShortNamed part of a multi-part parameter
                  Comments

                  Only one level of nested parameters is allowed.

                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))