Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1 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 1.0.0 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: ArtifactEndpointConfigurableOperation - Detailed Descriptions

Active as of 2024-05-08

Definitions for the crmi-artifact-endpoint-configurable-operation resource profile.

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

0. OperationDefinition
2. OperationDefinition.parameter
SlicingThis element introduces a set of slices on OperationDefinition.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ name
  • 4. OperationDefinition.parameter:artifactEndpointConfiguration
    Slice NameartifactEndpointConfiguration
    Control0..*
    Must Supporttrue
    6. OperationDefinition.parameter:artifactEndpointConfiguration.name
    Fixed ValueartifactEndpointConfiguration
    8. OperationDefinition.parameter:artifactEndpointConfiguration.use
    Pattern Valuein
    10. OperationDefinition.parameter:artifactEndpointConfiguration.min
    Pattern Value0
    12. OperationDefinition.parameter:artifactEndpointConfiguration.max
    Pattern Value*
    14. OperationDefinition.parameter:artifactEndpointConfiguration.part
    SlicingThis element introduces a set of slices on OperationDefinition.parameter.part. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ name
    • 16. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute
      Slice NameartifactRoute
      Control0..1
      TypeBackboneElement
      Must Supporttrue
      18. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.name
      Pattern ValueartifactRoute
      20. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.min
      Pattern Value0
      22. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.max
      Pattern Value1
      24. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.type
      Pattern Valueuri
      26. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri
      Slice NameendpointUri
      Control0..1
      TypeBackboneElement
      Must Supporttrue
      28. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.name
      Pattern ValueendpointUri
      30. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.min
      Pattern Value0
      32. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.max
      Pattern Value1
      34. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.type
      Pattern Valueuri
      36. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint
      Slice Nameendpoint
      Control0..1
      TypeBackboneElement
      Must Supporttrue
      38. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.name
      Pattern Valueendpoint
      40. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.min
      Pattern Value0
      42. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.max
      Pattern Value1
      44. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.type
      Pattern ValueEndpoint

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

      0. OperationDefinition
      Definition

      A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

      ShortDefinition of an operation or a named query
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      opd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
      opd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
      2. OperationDefinition.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. OperationDefinition.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
      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 resource that contains them
      Summaryfalse
      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
      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())
      6. OperationDefinition.name
      Definition

      A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

      ShortName for this operation definition (computer friendly)
      Comments

      The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

      Control1..1
      This element is affected by the following invariants: inv-0
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Support human navigation and code generation.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. OperationDefinition.status
      Definition

      The status of this operation definition. Enables tracking the life-cycle of the content.

      Shortdraft | active | retired | unknown
      Comments

      Allows filtering of operation definitions that are appropriate for use versus not.

      Control1..1
      BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
      (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

      The lifecycle status of an artifact.

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
      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. OperationDefinition.kind
      Definition

      Whether this is an operation or a named query.

      Shortoperation | query
      Comments

      Named queries are invoked differently, and have different capabilities.

      Control1..1
      BindingThe codes SHALL be taken from OperationKindhttp://hl7.org/fhir/ValueSet/operation-kind|4.0.1
      (required to http://hl7.org/fhir/ValueSet/operation-kind|4.0.1)

      Whether an operation is a normal operation or a query.

      Typecode
      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()))
      12. OperationDefinition.code
      Definition

      The name used to invoke the operation.

      ShortName used to invoke the operation
      Control1..1
      Typecode
      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()))
      14. OperationDefinition.system
      Definition

      Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).

      ShortInvoke at the system level?
      Control1..1
      Typeboolean
      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()))
      16. OperationDefinition.type
      Definition

      Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).

      ShortInvoke at the type level?
      Control1..1
      Typeboolean
      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. OperationDefinition.instance
      Definition

      Indicates whether this operation can be invoked on a particular instance of one of the given types.

      ShortInvoke on an instance?
      Control1..1
      Typeboolean
      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. OperationDefinition.parameter
      Definition

      The parameters for the operation/query.

      ShortParameters for the operation/query
      Comments

      Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      opd-1: Either a type must be provided, or parts (type.exists() or part.exists())
      opd-2: A search type can only be specified for parameters of type string (searchType.exists() implies type = 'string')
      opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical (targetProfile.exists() implies (type = 'Reference' or type = 'canonical'))
      opd-1: Either a type must be provided, or parts (type.exists() or part.exists())
      opd-2: A search type can only be specified for parameters of type string (searchType.exists() implies type = 'string')
      opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical (targetProfile.exists() implies (type = 'Reference' or type = 'canonical'))
      SlicingThis element introduces a set of slices on OperationDefinition.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ name
      • 22. OperationDefinition.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())
        24. OperationDefinition.parameter.name
        Definition

        The name of used to identify the parameter.

        ShortName in Parameters.parameter.name or in URL
        Comments

        This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

        Control1..1
        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()))
        26. OperationDefinition.parameter.use
        Definition

        Whether this is an input or an output parameter.

        Shortin | out
        Comments

        If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

        Control1..1
        BindingThe codes SHALL be taken from OperationParameterUsehttp://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
        (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

        Whether an operation parameter is an input or an output parameter.

        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()))
        28. OperationDefinition.parameter.min
        Definition

        The minimum number of times this parameter SHALL appear in the request or response.

        ShortMinimum Cardinality
        Control1..1
        Typeinteger
        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()))
        30. OperationDefinition.parameter.max
        Definition

        The maximum number of times this element is permitted to appear in the request or response.

        ShortMaximum Cardinality (a number or *)
        Control1..1
        Typestring
        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()))
        32. OperationDefinition.parameter:artifactEndpointConfiguration
        Slice NameartifactEndpointConfiguration
        Definition

        The parameters for the operation/query.

        ShortParameters for the operation/query
        Comments

        Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        opd-1: Either a type must be provided, or parts (type.exists() or part.exists())
        opd-2: A search type can only be specified for parameters of type string (searchType.exists() implies type = 'string')
        opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical (targetProfile.exists() implies (type = 'Reference' or type = 'canonical'))
        opd-1: Either a type must be provided, or parts (type.exists() or part.exists())
        opd-2: A search type can only be specified for parameters of type string (searchType.exists() implies type = 'string')
        opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical (targetProfile.exists() implies (type = 'Reference' or type = 'canonical'))
        34. OperationDefinition.parameter:artifactEndpointConfiguration.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())
        36. OperationDefinition.parameter:artifactEndpointConfiguration.name
        Definition

        The name of used to identify the parameter.

        ShortName in Parameters.parameter.name or in URL
        Comments

        This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

        Control1..1
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Fixed ValueartifactEndpointConfiguration
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. OperationDefinition.parameter:artifactEndpointConfiguration.use
        Definition

        Whether this is an input or an output parameter.

        Shortin | out
        Comments

        If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

        Control1..1
        BindingThe codes SHALL be taken from OperationParameterUsehttp://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
        (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

        Whether an operation parameter is an input or an output parameter.

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Pattern Valuein
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. OperationDefinition.parameter:artifactEndpointConfiguration.min
        Definition

        The minimum number of times this parameter SHALL appear in the request or response.

        ShortMinimum Cardinality
        Control1..1
        Typeinteger
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Pattern Value0
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. OperationDefinition.parameter:artifactEndpointConfiguration.max
        Definition

        The maximum number of times this element is permitted to appear in the request or response.

        ShortMaximum Cardinality (a number or *)
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Pattern Value*
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. OperationDefinition.parameter:artifactEndpointConfiguration.part
        Definition

        The parts of a nested Parameter.

        ShortParts of a nested Parameter
        Comments

        Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

        Control0..*
        This element is affected by the following invariants: opd-1
        TypeSee ttp://hl7.org/fhir/StructureDefinition/OperationDefinition#OperationDefinition.parameter
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on OperationDefinition.parameter.part. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ name
        • 46. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute
          Slice NameartifactRoute
          Definition

          The parts of a nested Parameter.

          ShortParts of a nested Parameter
          Comments

          Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

          Control0..1*
          This element is affected by the following invariants: opd-1
          TypeBackboneElement
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.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. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.name
          Definition

          The name of used to identify the parameter.

          ShortName in Parameters.parameter.name or in URL
          Comments

          This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

          Control1..1
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern ValueartifactRoute
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.use
          Definition

          Whether this is an input or an output parameter.

          Shortin | out
          Comments

          If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

          Control1..1
          BindingThe codes SHALL be taken from OperationParameterUsehttp://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
          (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

          Whether an operation parameter is an input or an output parameter.

          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()))
          54. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.min
          Definition

          The minimum number of times this parameter SHALL appear in the request or response.

          ShortMinimum Cardinality
          Control1..1
          Typeinteger
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Value0
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.max
          Definition

          The maximum number of times this element is permitted to appear in the request or response.

          ShortMaximum Cardinality (a number or *)
          Control1..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Value1
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          58. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.type
          Definition

          The type for this parameter.

          ShortWhat type this parameter has
          Comments

          if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.

          Control0..1
          This element is affected by the following invariants: opd-1
          BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
          (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

          A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Valueuri
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          60. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri
          Slice NameendpointUri
          Definition

          The parts of a nested Parameter.

          ShortParts of a nested Parameter
          Comments

          Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

          Control0..1*
          This element is affected by the following invariants: opd-1
          TypeBackboneElement
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          62. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.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())
          64. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.name
          Definition

          The name of used to identify the parameter.

          ShortName in Parameters.parameter.name or in URL
          Comments

          This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

          Control1..1
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern ValueendpointUri
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          66. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.use
          Definition

          Whether this is an input or an output parameter.

          Shortin | out
          Comments

          If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

          Control1..1
          BindingThe codes SHALL be taken from OperationParameterUsehttp://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
          (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

          Whether an operation parameter is an input or an output parameter.

          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()))
          68. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.min
          Definition

          The minimum number of times this parameter SHALL appear in the request or response.

          ShortMinimum Cardinality
          Control1..1
          Typeinteger
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Value0
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          70. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.max
          Definition

          The maximum number of times this element is permitted to appear in the request or response.

          ShortMaximum Cardinality (a number or *)
          Control1..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Value1
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          72. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.type
          Definition

          The type for this parameter.

          ShortWhat type this parameter has
          Comments

          if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.

          Control0..1
          This element is affected by the following invariants: opd-1
          BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
          (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

          A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Valueuri
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          74. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint
          Slice Nameendpoint
          Definition

          The parts of a nested Parameter.

          ShortParts of a nested Parameter
          Comments

          Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

          Control0..1*
          This element is affected by the following invariants: opd-1
          TypeBackboneElement
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          76. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.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())
          78. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.name
          Definition

          The name of used to identify the parameter.

          ShortName in Parameters.parameter.name or in URL
          Comments

          This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

          Control1..1
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Valueendpoint
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          80. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.use
          Definition

          Whether this is an input or an output parameter.

          Shortin | out
          Comments

          If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

          Control1..1
          BindingThe codes SHALL be taken from OperationParameterUsehttp://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
          (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

          Whether an operation parameter is an input or an output parameter.

          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()))
          82. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.min
          Definition

          The minimum number of times this parameter SHALL appear in the request or response.

          ShortMinimum Cardinality
          Control1..1
          Typeinteger
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Value0
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          84. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.max
          Definition

          The maximum number of times this element is permitted to appear in the request or response.

          ShortMaximum Cardinality (a number or *)
          Control1..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern Value1
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          86. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.type
          Definition

          The type for this parameter.

          ShortWhat type this parameter has
          Comments

          if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.

          Control0..1
          This element is affected by the following invariants: opd-1
          BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
          (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

          A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Pattern ValueEndpoint
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

          0. OperationDefinition
          Definition

          A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

          ShortDefinition of an operation or a named query
          Control0..*
          Is Modifierfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          opd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
          2. OperationDefinition.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. OperationDefinition.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. OperationDefinition.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. OperationDefinition.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. OperationDefinition.text
          Definition

          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

          Control0..1
          TypeNarrative
          Is Modifierfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. OperationDefinition.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

          ShortContained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

          Control0..*
          TypeResource
          Is Modifierfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. OperationDefinition.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource. 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. OperationDefinition.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
          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 resource that contains them
          Summaryfalse
          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
          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. OperationDefinition.url
          Definition

          An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.

          ShortCanonical identifier for this operation definition, represented as a URI (globally unique)
          Comments

          Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

          The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

          In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

          Control0..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the operation definition to be referenced by a single globally unique identifier.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          20. OperationDefinition.version
          Definition

          The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

          ShortBusiness version of the operation definition
          Comments

          There may be different operation definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format [url]|[version].

          NoteThis is a business versionId, not a resource version id (see discussion)
          Control0..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()))
          22. OperationDefinition.name
          Definition

          A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

          ShortName for this operation definition (computer friendly)
          Comments

          The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

          Control1..1
          This element is affected by the following invariants: inv-0
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Support human navigation and code generation.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          24. OperationDefinition.title
          Definition

          A short, descriptive, user-friendly title for the operation definition.

          ShortName for this operation definition (human friendly)
          Comments

          This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

          Control0..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()))
          26. OperationDefinition.status
          Definition

          The status of this operation definition. Enables tracking the life-cycle of the content.

          Shortdraft | active | retired | unknown
          Comments

          Allows filtering of operation definitions that are appropriate for use versus not.

          Control1..1
          BindingThe codes SHALL be taken from PublicationStatus
          (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

          The lifecycle status of an artifact.

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
          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()))
          28. OperationDefinition.kind
          Definition

          Whether this is an operation or a named query.

          Shortoperation | query
          Comments

          Named queries are invoked differently, and have different capabilities.

          Control1..1
          BindingThe codes SHALL be taken from OperationKind
          (required to http://hl7.org/fhir/ValueSet/operation-kind|4.0.1)

          Whether an operation is a normal operation or a query.

          Typecode
          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()))
          30. OperationDefinition.experimental
          Definition

          A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

          ShortFor testing purposes, not real usage
          Comments

          Allows filtering of operation definitions that are appropriate for use versus not.

          Control0..1
          Typeboolean
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Enables experimental content to be developed following the same lifecycle that would be used for a production-level operation definition.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          32. OperationDefinition.date
          Definition

          The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.

          ShortDate last changed
          Comments

          Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

          Control0..1
          TypedateTime
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate NamesRevision Date
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          34. OperationDefinition.publisher
          Definition

          The name of the organization or individual that published the operation definition.

          ShortName of the publisher (organization or individual)
          Comments

          Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Helps establish the "authority/credibility" of the operation definition. May also allow for contact.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. OperationDefinition.contact
          Definition

          Contact details to assist a user in finding and communicating with the publisher.

          ShortContact details for the publisher
          Comments

          May be a web site, an email address, a telephone number, etc.

          Control0..*
          TypeContactDetail
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. OperationDefinition.description
          Definition

          A free text natural language description of the operation definition from a consumer's perspective.

          ShortNatural language description of the operation definition
          Comments

          This description can be used to capture details such as why the operation definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the operation definition is presumed to be the predominant language in the place the operation definition was created).

          Control0..1
          Typemarkdown
          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()))
          40. OperationDefinition.useContext
          Definition

          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances.

          ShortThe context that the content is intended to support
          Comments

          When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

          Control0..*
          TypeUsageContext
          Is Modifierfalse
          Summarytrue
          Requirements

          Assist in searching for appropriate content.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. OperationDefinition.jurisdiction
          Definition

          A legal or geographic region in which the operation definition is intended to be used.

          ShortIntended jurisdiction for operation definition (if applicable)
          Comments

          It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.

          Control0..*
          BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
          (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

          Countries and regions within which this artifact is targeted for use.

          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. OperationDefinition.purpose
          Definition

          Explanation of why this operation definition is needed and why it has been designed as it has.

          ShortWhy this operation definition is defined
          Comments

          This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.

          Control0..1
          Typemarkdown
          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()))
          46. OperationDefinition.affectsState
          Definition

          Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.

          ShortWhether content is changed by the operation
          Comments

          What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex:

          1. Servers SHALL support POST method for all operations.

          2. Servers SHALL support GET method if all the parameters for the operation are primitive or there are no parameters and the operation has affectsState = false.

          Control0..1
          Typeboolean
          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()))
          48. OperationDefinition.code
          Definition

          The name used to invoke the operation.

          ShortName used to invoke the operation
          Control1..1
          Typecode
          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. OperationDefinition.comment
          Definition

          Additional information about how to use this operation or named query.

          ShortAdditional information about use
          Control0..1
          Typemarkdown
          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()))
          52. OperationDefinition.base
          Definition

          Indicates that this operation definition is a constraining profile on the base.

          ShortMarks this as a profile of the base
          Comments

          A constrained profile can make optional parameters required or not used and clarify documentation.

          Control0..1
          Typecanonical(OperationDefinition)
          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. OperationDefinition.resource
          Definition

          The types on which this operation can be executed.

          ShortTypes this operation applies to
          Comments

          If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization.

          Control0..*
          BindingThe codes SHALL be taken from ResourceType
          (required to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

          One of the resource types defined as part of this version of FHIR.

          Typecode
          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()))
          56. OperationDefinition.system
          Definition

          Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).

          ShortInvoke at the system level?
          Control1..1
          Typeboolean
          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()))
          58. OperationDefinition.type
          Definition

          Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).

          ShortInvoke at the type level?
          Control1..1
          Typeboolean
          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. OperationDefinition.instance
          Definition

          Indicates whether this operation can be invoked on a particular instance of one of the given types.

          ShortInvoke on an instance?
          Control1..1
          Typeboolean
          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()))
          62. OperationDefinition.inputProfile
          Definition

          Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.

          ShortValidation information for in parameters
          Comments

          If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

          Control0..1
          Typecanonical(StructureDefinition)
          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()))
          64. OperationDefinition.outputProfile
          Definition

          Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.

          ShortValidation information for out parameters
          Comments

          If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

          Control0..1
          Typecanonical(StructureDefinition)
          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()))
          66. OperationDefinition.parameter
          Definition

          The parameters for the operation/query.

          ShortParameters for the operation/query
          Comments

          Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

          Control0..*
          TypeBackboneElement
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          opd-1: Either a type must be provided, or parts (type.exists() or part.exists())
          opd-2: A search type can only be specified for parameters of type string (searchType.exists() implies type = 'string')
          opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical (targetProfile.exists() implies (type = 'Reference' or type = 'canonical'))
          SlicingThis element introduces a set of slices on OperationDefinition.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • value @ name
          • 68. OperationDefinition.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
            70. OperationDefinition.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())
            72. OperationDefinition.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())
            74. OperationDefinition.parameter.name
            Definition

            The name of used to identify the parameter.

            ShortName in Parameters.parameter.name or in URL
            Comments

            This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

            Control1..1
            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()))
            76. OperationDefinition.parameter.use
            Definition

            Whether this is an input or an output parameter.

            Shortin | out
            Comments

            If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

            Control1..1
            BindingThe codes SHALL be taken from OperationParameterUse
            (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

            Whether an operation parameter is an input or an output parameter.

            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()))
            78. OperationDefinition.parameter.min
            Definition

            The minimum number of times this parameter SHALL appear in the request or response.

            ShortMinimum Cardinality
            Control1..1
            Typeinteger
            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()))
            80. OperationDefinition.parameter.max
            Definition

            The maximum number of times this element is permitted to appear in the request or response.

            ShortMaximum Cardinality (a number or *)
            Control1..1
            Typestring
            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()))
            82. OperationDefinition.parameter.documentation
            Definition

            Describes the meaning or use of this parameter.

            ShortDescription of meaning/use
            Control0..1
            Typestring
            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()))
            84. OperationDefinition.parameter.type
            Definition

            The type for this parameter.

            ShortWhat type this parameter has
            Comments

            if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.

            Control0..1
            This element is affected by the following invariants: opd-1
            BindingThe codes SHALL be taken from FHIRAllTypes
            (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

            A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

            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()))
            86. OperationDefinition.parameter.targetProfile
            Definition

            Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

            ShortIf type is Reference | canonical, allowed targets
            Comments

            Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).

            Control0..*
            Typecanonical(StructureDefinition)
            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()))
            88. OperationDefinition.parameter.searchType
            Definition

            How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.

            Shortnumber | date | string | token | reference | composite | quantity | uri | special
            Control0..1
            This element is affected by the following invariants: opd-2
            BindingThe codes SHALL be taken from SearchParamType
            (required to http://hl7.org/fhir/ValueSet/search-param-type|4.0.1)

            Data types allowed to be used for search parameters.

            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()))
            90. OperationDefinition.parameter.binding
            Definition

            Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

            ShortValueSet details if this is coded
            Control0..1
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. OperationDefinition.parameter.binding.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. OperationDefinition.parameter.binding.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. OperationDefinition.parameter.binding.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. OperationDefinition.parameter.binding.strength
            Definition

            Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

            Shortrequired | extensible | preferred | example
            Comments

            For further discussion, see Using Terminologies.

            Control1..1
            BindingThe codes SHALL be taken from BindingStrength
            (required to http://hl7.org/fhir/ValueSet/binding-strength|4.0.1)

            Indication of the degree of conformance expectations associated with a binding.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Alternate Namesconformance, extensibility
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            100. OperationDefinition.parameter.binding.valueSet
            Definition

            Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

            ShortSource of value set
            Comments

            For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

            Control1..1
            Typecanonical(ValueSet)
            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()))
            102. OperationDefinition.parameter.referencedFrom
            Definition

            Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

            ShortReferences to this parameter
            Comments

            Resolution applies if the referenced parameter exists.

            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            104. OperationDefinition.parameter.referencedFrom.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
            106. OperationDefinition.parameter.referencedFrom.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())
            108. OperationDefinition.parameter.referencedFrom.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())
            110. OperationDefinition.parameter.referencedFrom.source
            Definition

            The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

            ShortReferencing parameter
            Control1..1
            Typestring
            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()))
            112. OperationDefinition.parameter.referencedFrom.sourceId
            Definition

            The id of the element in the referencing resource that is expected to resolve to this resource.

            ShortElement id of reference
            Control0..1
            Typestring
            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()))
            114. OperationDefinition.parameter.part
            Definition

            The parts of a nested Parameter.

            ShortParts of a nested Parameter
            Comments

            Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

            Control0..*
            This element is affected by the following invariants: opd-1
            TypeSee ttp://hl7.org/fhir/StructureDefinition/OperationDefinition#OperationDefinition.parameter
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            116. OperationDefinition.parameter:artifactEndpointConfiguration
            Slice NameartifactEndpointConfiguration
            Definition

            The parameters for the operation/query.

            ShortParameters for the operation/query
            Comments

            Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            opd-1: Either a type must be provided, or parts (type.exists() or part.exists())
            opd-2: A search type can only be specified for parameters of type string (searchType.exists() implies type = 'string')
            opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical (targetProfile.exists() implies (type = 'Reference' or type = 'canonical'))
            118. OperationDefinition.parameter:artifactEndpointConfiguration.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
            120. OperationDefinition.parameter:artifactEndpointConfiguration.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())
            122. OperationDefinition.parameter:artifactEndpointConfiguration.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())
            124. OperationDefinition.parameter:artifactEndpointConfiguration.name
            Definition

            The name of used to identify the parameter.

            ShortName in Parameters.parameter.name or in URL
            Comments

            This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

            Control1..1
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Fixed ValueartifactEndpointConfiguration
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            126. OperationDefinition.parameter:artifactEndpointConfiguration.use
            Definition

            Whether this is an input or an output parameter.

            Shortin | out
            Comments

            If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

            Control1..1
            BindingThe codes SHALL be taken from OperationParameterUse
            (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

            Whether an operation parameter is an input or an output parameter.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Pattern Valuein
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            128. OperationDefinition.parameter:artifactEndpointConfiguration.min
            Definition

            The minimum number of times this parameter SHALL appear in the request or response.

            ShortMinimum Cardinality
            Control1..1
            Typeinteger
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Pattern Value0
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            130. OperationDefinition.parameter:artifactEndpointConfiguration.max
            Definition

            The maximum number of times this element is permitted to appear in the request or response.

            ShortMaximum Cardinality (a number or *)
            Control1..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Pattern Value*
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            132. OperationDefinition.parameter:artifactEndpointConfiguration.documentation
            Definition

            Describes the meaning or use of this parameter.

            ShortDescription of meaning/use
            Control0..1
            Typestring
            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()))
            134. OperationDefinition.parameter:artifactEndpointConfiguration.type
            Definition

            The type for this parameter.

            ShortWhat type this parameter has
            Comments

            if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.

            Control0..1
            This element is affected by the following invariants: opd-1
            BindingThe codes SHALL be taken from FHIRAllTypes
            (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

            A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

            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()))
            136. OperationDefinition.parameter:artifactEndpointConfiguration.targetProfile
            Definition

            Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

            ShortIf type is Reference | canonical, allowed targets
            Comments

            Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).

            Control0..*
            Typecanonical(StructureDefinition)
            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()))
            138. OperationDefinition.parameter:artifactEndpointConfiguration.searchType
            Definition

            How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.

            Shortnumber | date | string | token | reference | composite | quantity | uri | special
            Control0..1
            This element is affected by the following invariants: opd-2
            BindingThe codes SHALL be taken from SearchParamType
            (required to http://hl7.org/fhir/ValueSet/search-param-type|4.0.1)

            Data types allowed to be used for search parameters.

            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()))
            140. OperationDefinition.parameter:artifactEndpointConfiguration.binding
            Definition

            Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

            ShortValueSet details if this is coded
            Control0..1
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            142. OperationDefinition.parameter:artifactEndpointConfiguration.binding.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
            144. OperationDefinition.parameter:artifactEndpointConfiguration.binding.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())
            146. OperationDefinition.parameter:artifactEndpointConfiguration.binding.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())
            148. OperationDefinition.parameter:artifactEndpointConfiguration.binding.strength
            Definition

            Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

            Shortrequired | extensible | preferred | example
            Comments

            For further discussion, see Using Terminologies.

            Control1..1
            BindingThe codes SHALL be taken from BindingStrength
            (required to http://hl7.org/fhir/ValueSet/binding-strength|4.0.1)

            Indication of the degree of conformance expectations associated with a binding.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Alternate Namesconformance, extensibility
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            150. OperationDefinition.parameter:artifactEndpointConfiguration.binding.valueSet
            Definition

            Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

            ShortSource of value set
            Comments

            For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

            Control1..1
            Typecanonical(ValueSet)
            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()))
            152. OperationDefinition.parameter:artifactEndpointConfiguration.referencedFrom
            Definition

            Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

            ShortReferences to this parameter
            Comments

            Resolution applies if the referenced parameter exists.

            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            154. OperationDefinition.parameter:artifactEndpointConfiguration.referencedFrom.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
            156. OperationDefinition.parameter:artifactEndpointConfiguration.referencedFrom.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())
            158. OperationDefinition.parameter:artifactEndpointConfiguration.referencedFrom.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())
            160. OperationDefinition.parameter:artifactEndpointConfiguration.referencedFrom.source
            Definition

            The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

            ShortReferencing parameter
            Control1..1
            Typestring
            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()))
            162. OperationDefinition.parameter:artifactEndpointConfiguration.referencedFrom.sourceId
            Definition

            The id of the element in the referencing resource that is expected to resolve to this resource.

            ShortElement id of reference
            Control0..1
            Typestring
            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()))
            164. OperationDefinition.parameter:artifactEndpointConfiguration.part
            Definition

            The parts of a nested Parameter.

            ShortParts of a nested Parameter
            Comments

            Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

            Control0..*
            This element is affected by the following invariants: opd-1
            TypeSee ttp://hl7.org/fhir/StructureDefinition/OperationDefinition#OperationDefinition.parameter
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on OperationDefinition.parameter.part. The slices are unordered and Open, and can be differentiated using the following discriminators:
            • value @ name
            • 166. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute
              Slice NameartifactRoute
              Definition

              The parts of a nested Parameter.

              ShortParts of a nested Parameter
              Comments

              Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

              Control0..1
              This element is affected by the following invariants: opd-1
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              168. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.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
              170. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.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())
              172. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.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())
              174. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.name
              Definition

              The name of used to identify the parameter.

              ShortName in Parameters.parameter.name or in URL
              Comments

              This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

              Control1..1
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern ValueartifactRoute
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              176. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.use
              Definition

              Whether this is an input or an output parameter.

              Shortin | out
              Comments

              If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

              Control1..1
              BindingThe codes SHALL be taken from OperationParameterUse
              (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

              Whether an operation parameter is an input or an output parameter.

              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()))
              178. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.min
              Definition

              The minimum number of times this parameter SHALL appear in the request or response.

              ShortMinimum Cardinality
              Control1..1
              Typeinteger
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Value0
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              180. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.max
              Definition

              The maximum number of times this element is permitted to appear in the request or response.

              ShortMaximum Cardinality (a number or *)
              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Value1
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              182. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.documentation
              Definition

              Describes the meaning or use of this parameter.

              ShortDescription of meaning/use
              Control0..1
              Typestring
              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()))
              184. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.type
              Definition

              The type for this parameter.

              ShortWhat type this parameter has
              Comments

              if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.

              Control0..1
              This element is affected by the following invariants: opd-1
              BindingThe codes SHALL be taken from FHIRAllTypes
              (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

              A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Valueuri
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              186. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.targetProfile
              Definition

              Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

              ShortIf type is Reference | canonical, allowed targets
              Comments

              Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).

              Control0..*
              Typecanonical(StructureDefinition)
              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()))
              188. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.searchType
              Definition

              How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.

              Shortnumber | date | string | token | reference | composite | quantity | uri | special
              Control0..1
              This element is affected by the following invariants: opd-2
              BindingThe codes SHALL be taken from SearchParamType
              (required to http://hl7.org/fhir/ValueSet/search-param-type|4.0.1)

              Data types allowed to be used for search parameters.

              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()))
              190. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.binding
              Definition

              Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

              ShortValueSet details if this is coded
              Control0..1
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              192. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.binding.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
              194. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.binding.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())
              196. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.binding.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())
              198. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.binding.strength
              Definition

              Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

              Shortrequired | extensible | preferred | example
              Comments

              For further discussion, see Using Terminologies.

              Control1..1
              BindingThe codes SHALL be taken from BindingStrength
              (required to http://hl7.org/fhir/ValueSet/binding-strength|4.0.1)

              Indication of the degree of conformance expectations associated with a binding.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Alternate Namesconformance, extensibility
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              200. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.binding.valueSet
              Definition

              Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

              ShortSource of value set
              Comments

              For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

              Control1..1
              Typecanonical(ValueSet)
              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()))
              202. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.referencedFrom
              Definition

              Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

              ShortReferences to this parameter
              Comments

              Resolution applies if the referenced parameter exists.

              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              204. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.referencedFrom.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
              206. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.referencedFrom.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())
              208. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.referencedFrom.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())
              210. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.referencedFrom.source
              Definition

              The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

              ShortReferencing parameter
              Control1..1
              Typestring
              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()))
              212. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.referencedFrom.sourceId
              Definition

              The id of the element in the referencing resource that is expected to resolve to this resource.

              ShortElement id of reference
              Control0..1
              Typestring
              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()))
              214. OperationDefinition.parameter:artifactEndpointConfiguration.part:artifactRoute.part
              Definition

              The parts of a nested Parameter.

              ShortParts of a nested Parameter
              Comments

              Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

              Control0..*
              This element is affected by the following invariants: opd-1
              TypeSee ttp://hl7.org/fhir/StructureDefinition/OperationDefinition#OperationDefinition.parameter
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              216. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri
              Slice NameendpointUri
              Definition

              The parts of a nested Parameter.

              ShortParts of a nested Parameter
              Comments

              Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

              Control0..1
              This element is affected by the following invariants: opd-1
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              218. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.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
              220. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.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())
              222. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.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())
              224. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.name
              Definition

              The name of used to identify the parameter.

              ShortName in Parameters.parameter.name or in URL
              Comments

              This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

              Control1..1
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern ValueendpointUri
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              226. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.use
              Definition

              Whether this is an input or an output parameter.

              Shortin | out
              Comments

              If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

              Control1..1
              BindingThe codes SHALL be taken from OperationParameterUse
              (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

              Whether an operation parameter is an input or an output parameter.

              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()))
              228. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.min
              Definition

              The minimum number of times this parameter SHALL appear in the request or response.

              ShortMinimum Cardinality
              Control1..1
              Typeinteger
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Value0
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              230. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.max
              Definition

              The maximum number of times this element is permitted to appear in the request or response.

              ShortMaximum Cardinality (a number or *)
              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Value1
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              232. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.documentation
              Definition

              Describes the meaning or use of this parameter.

              ShortDescription of meaning/use
              Control0..1
              Typestring
              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()))
              234. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.type
              Definition

              The type for this parameter.

              ShortWhat type this parameter has
              Comments

              if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.

              Control0..1
              This element is affected by the following invariants: opd-1
              BindingThe codes SHALL be taken from FHIRAllTypes
              (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

              A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Valueuri
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              236. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.targetProfile
              Definition

              Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

              ShortIf type is Reference | canonical, allowed targets
              Comments

              Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).

              Control0..*
              Typecanonical(StructureDefinition)
              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()))
              238. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.searchType
              Definition

              How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.

              Shortnumber | date | string | token | reference | composite | quantity | uri | special
              Control0..1
              This element is affected by the following invariants: opd-2
              BindingThe codes SHALL be taken from SearchParamType
              (required to http://hl7.org/fhir/ValueSet/search-param-type|4.0.1)

              Data types allowed to be used for search parameters.

              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()))
              240. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.binding
              Definition

              Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

              ShortValueSet details if this is coded
              Control0..1
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              242. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.binding.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
              244. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.binding.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())
              246. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.binding.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())
              248. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.binding.strength
              Definition

              Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

              Shortrequired | extensible | preferred | example
              Comments

              For further discussion, see Using Terminologies.

              Control1..1
              BindingThe codes SHALL be taken from BindingStrength
              (required to http://hl7.org/fhir/ValueSet/binding-strength|4.0.1)

              Indication of the degree of conformance expectations associated with a binding.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Alternate Namesconformance, extensibility
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              250. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.binding.valueSet
              Definition

              Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

              ShortSource of value set
              Comments

              For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

              Control1..1
              Typecanonical(ValueSet)
              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()))
              252. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.referencedFrom
              Definition

              Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

              ShortReferences to this parameter
              Comments

              Resolution applies if the referenced parameter exists.

              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              254. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.referencedFrom.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
              256. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.referencedFrom.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())
              258. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.referencedFrom.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())
              260. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.referencedFrom.source
              Definition

              The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

              ShortReferencing parameter
              Control1..1
              Typestring
              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()))
              262. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.referencedFrom.sourceId
              Definition

              The id of the element in the referencing resource that is expected to resolve to this resource.

              ShortElement id of reference
              Control0..1
              Typestring
              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()))
              264. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpointUri.part
              Definition

              The parts of a nested Parameter.

              ShortParts of a nested Parameter
              Comments

              Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

              Control0..*
              This element is affected by the following invariants: opd-1
              TypeSee ttp://hl7.org/fhir/StructureDefinition/OperationDefinition#OperationDefinition.parameter
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              266. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint
              Slice Nameendpoint
              Definition

              The parts of a nested Parameter.

              ShortParts of a nested Parameter
              Comments

              Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

              Control0..1
              This element is affected by the following invariants: opd-1
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              268. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.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
              270. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.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())
              272. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.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())
              274. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.name
              Definition

              The name of used to identify the parameter.

              ShortName in Parameters.parameter.name or in URL
              Comments

              This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

              Control1..1
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Valueendpoint
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              276. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.use
              Definition

              Whether this is an input or an output parameter.

              Shortin | out
              Comments

              If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

              Control1..1
              BindingThe codes SHALL be taken from OperationParameterUse
              (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

              Whether an operation parameter is an input or an output parameter.

              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()))
              278. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.min
              Definition

              The minimum number of times this parameter SHALL appear in the request or response.

              ShortMinimum Cardinality
              Control1..1
              Typeinteger
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Value0
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              280. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.max
              Definition

              The maximum number of times this element is permitted to appear in the request or response.

              ShortMaximum Cardinality (a number or *)
              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Value1
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              282. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.documentation
              Definition

              Describes the meaning or use of this parameter.

              ShortDescription of meaning/use
              Control0..1
              Typestring
              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()))
              284. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.type
              Definition

              The type for this parameter.

              ShortWhat type this parameter has
              Comments

              if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.

              Control0..1
              This element is affected by the following invariants: opd-1
              BindingThe codes SHALL be taken from FHIRAllTypes
              (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

              A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern ValueEndpoint
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              286. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.targetProfile
              Definition

              Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

              ShortIf type is Reference | canonical, allowed targets
              Comments

              Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).

              Control0..*
              Typecanonical(StructureDefinition)
              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()))
              288. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.searchType
              Definition

              How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.

              Shortnumber | date | string | token | reference | composite | quantity | uri | special
              Control0..1
              This element is affected by the following invariants: opd-2
              BindingThe codes SHALL be taken from SearchParamType
              (required to http://hl7.org/fhir/ValueSet/search-param-type|4.0.1)

              Data types allowed to be used for search parameters.

              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()))
              290. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.binding
              Definition

              Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

              ShortValueSet details if this is coded
              Control0..1
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              292. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.binding.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
              294. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.binding.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())
              296. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.binding.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())
              298. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.binding.strength
              Definition

              Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

              Shortrequired | extensible | preferred | example
              Comments

              For further discussion, see Using Terminologies.

              Control1..1
              BindingThe codes SHALL be taken from BindingStrength
              (required to http://hl7.org/fhir/ValueSet/binding-strength|4.0.1)

              Indication of the degree of conformance expectations associated with a binding.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Alternate Namesconformance, extensibility
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              300. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.binding.valueSet
              Definition

              Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

              ShortSource of value set
              Comments

              For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

              Control1..1
              Typecanonical(ValueSet)
              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()))
              302. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.referencedFrom
              Definition

              Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

              ShortReferences to this parameter
              Comments

              Resolution applies if the referenced parameter exists.

              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              304. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.referencedFrom.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
              306. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.referencedFrom.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())
              308. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.referencedFrom.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())
              310. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.referencedFrom.source
              Definition

              The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

              ShortReferencing parameter
              Control1..1
              Typestring
              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()))
              312. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.referencedFrom.sourceId
              Definition

              The id of the element in the referencing resource that is expected to resolve to this resource.

              ShortElement id of reference
              Control0..1
              Typestring
              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()))
              314. OperationDefinition.parameter:artifactEndpointConfiguration.part:endpoint.part
              Definition

              The parts of a nested Parameter.

              ShortParts of a nested Parameter
              Comments

              Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

              Control0..*
              This element is affected by the following invariants: opd-1
              TypeSee ttp://hl7.org/fhir/StructureDefinition/OperationDefinition#OperationDefinition.parameter
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              316. OperationDefinition.overload
              Definition

              Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

              ShortDefine overloaded variants for when generating code
              Comments

              The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.

              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              318. OperationDefinition.overload.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
              320. OperationDefinition.overload.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())
              322. OperationDefinition.overload.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())
              324. OperationDefinition.overload.parameterName
              Definition

              Name of parameter to include in overload.

              ShortName of parameter to include in overload
              Control0..*
              Typestring
              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()))
              326. OperationDefinition.overload.comment
              Definition

              Comments to go on overload.

              ShortComments to go on overload
              Control0..1
              Typestring
              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()))