Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4B_OperationDefinition_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-OperationDefinition resource profile.

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

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..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. OperationDefinition.extension
Definition

An Extension


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

ShortExtensionAdditional 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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on OperationDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. OperationDefinition.extension:title
    Slice Nametitle
    Definition

    R4B: OperationDefinition.title (new:string)

    ShortR4B: Name for this operation definition (human friendly) (new)
    Comments

    Element OperationDefinition.title has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Name for this operation definition (human friendly) (new)) (Extension Type: string)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. OperationDefinition.extension:inputProfile
    Slice NameinputProfile
    Definition

    R4B: OperationDefinition.inputProfile (new:canonical(StructureDefinition))

    ShortR4B: Validation information for in parameters (new)
    Comments

    Element OperationDefinition.inputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.inputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Validation information for in parameters (new)) (Extension Type: uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition))
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. OperationDefinition.extension:outputProfile
    Slice NameoutputProfile
    Definition

    R4B: OperationDefinition.outputProfile (new:canonical(StructureDefinition))

    ShortR4B: Validation information for out parameters (new)
    Comments

    Element OperationDefinition.outputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.outputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Validation information for out parameters (new)) (Extension Type: uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition))
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. 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. Usually modifier elements provide negation or qualification. In order 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.

    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 No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    14. 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 alpha-numeric type name to ensure that it is computable friendly.

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

    Support human navigation and code generation.

    16. 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 vs. not.
    This is labeled as "Is Modifier" because applications should not use a retired operation definition without due consideration.

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

    The lifecycle status of a Value Set or Concept Map.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    18. 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|3.0.2
    (required to http://hl7.org/fhir/ValueSet/operation-kind|3.0.2)

    Whether an operation is a normal operation or a query.

    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. 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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental operation definition in production.

    Control0..1
    Typeboolean
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    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.

    22. OperationDefinition.code
    Definition

    The name used to invoke the operation.

    ShortName used to invoke the operation
    Comments

    The code does not include the '$' prefix that is always included in the URL when the operation is invoked.

    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    24. 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    26. 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).

    ShortInvole at the type level?
    Control1..1
    Typeboolean
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    28. 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue

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

    0. OperationDefinition
    2. OperationDefinition.meta
    4. OperationDefinition.meta.extension
    Control0..*
    SlicingThis element introduces a set of slices on OperationDefinition.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. OperationDefinition.meta.extension:meta
      Slice Namemeta
      Definition

      R4B: OperationDefinition.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

      ShortR4B: meta additional types
      Comments

      Element OperationDefinition.meta is mapped to FHIR STU3 element OperationDefinition.meta as SourceIsBroaderThanTarget. The mappings for OperationDefinition.meta do not cover the following types: Meta. The mappings for OperationDefinition.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

      Control0..1
      TypeExtension(R4B: meta additional types) (Extension Type: Meta)
      8. OperationDefinition.text
      10. OperationDefinition.text.extension
      Control0..*
      SlicingThis element introduces a set of slices on OperationDefinition.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. OperationDefinition.text.extension:text
        Slice Nametext
        Definition

        R4B: OperationDefinition.text additional types (Narrative) additional types from child elements (div, status)

        ShortR4B: text additional types
        Comments

        Element OperationDefinition.text is mapped to FHIR STU3 element OperationDefinition.text as SourceIsBroaderThanTarget. The mappings for OperationDefinition.text do not cover the following types: Narrative. The mappings for OperationDefinition.text do not cover the following types based on type expansion: div, status. 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
        TypeExtension(R4B: text additional types) (Complex Extension)
        14. OperationDefinition.extension
        Control0..*
        SlicingThis element introduces a set of slices on OperationDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. OperationDefinition.extension:title
          Slice Nametitle
          Definition

          R4B: OperationDefinition.title (new:string)

          ShortR4B: Name for this operation definition (human friendly) (new)
          Comments

          Element OperationDefinition.title has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

          Control0..1
          TypeExtension(R4B: Name for this operation definition (human friendly) (new)) (Extension Type: string)
          18. OperationDefinition.extension:inputProfile
          Slice NameinputProfile
          Definition

          R4B: OperationDefinition.inputProfile (new:canonical(StructureDefinition))

          ShortR4B: Validation information for in parameters (new)
          Comments

          Element OperationDefinition.inputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.inputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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
          TypeExtension(R4B: Validation information for in parameters (new)) (Extension Type: uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition))
          20. OperationDefinition.extension:outputProfile
          Slice NameoutputProfile
          Definition

          R4B: OperationDefinition.outputProfile (new:canonical(StructureDefinition))

          ShortR4B: Validation information for out parameters (new)
          Comments

          Element OperationDefinition.outputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.outputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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
          TypeExtension(R4B: Validation information for out parameters (new)) (Extension Type: uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition))
          22. OperationDefinition.contact
          24. OperationDefinition.contact.extension
          Control0..*
          SlicingThis element introduces a set of slices on OperationDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 26. OperationDefinition.contact.extension:contact
            Slice Namecontact
            Definition

            R4B: OperationDefinition.contact additional types (ContactDetail) additional types from child elements (name, telecom)

            ShortR4B: contact additional types
            Comments

            Element OperationDefinition.contact is mapped to FHIR STU3 element OperationDefinition.contact as SourceIsBroaderThanTarget. The mappings for OperationDefinition.contact do not cover the following types: ContactDetail. The mappings for OperationDefinition.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

            Control0..*
            TypeExtension(R4B: contact additional types) (Complex Extension)
            28. OperationDefinition.useContext
            30. OperationDefinition.useContext.extension
            Control0..*
            SlicingThis element introduces a set of slices on OperationDefinition.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. OperationDefinition.useContext.extension:useContext
              Slice NameuseContext
              Definition

              R4B: OperationDefinition.useContext additional types (UsageContext) additional types from child elements (code, value[x])

              ShortR4B: The context that the content is intended to support additional types
              Comments

              Element OperationDefinition.useContext is mapped to FHIR STU3 element OperationDefinition.useContext as SourceIsBroaderThanTarget. The mappings for OperationDefinition.useContext do not cover the following types: UsageContext. The mappings for OperationDefinition.useContext do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

              Control0..*
              TypeExtension(R4B: The context that the content is intended to support additional types) (Complex Extension)
              34. OperationDefinition.base
              36. OperationDefinition.base.extension
              Control0..*
              SlicingThis element introduces a set of slices on OperationDefinition.base.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 38. OperationDefinition.base.extension:base
                Slice Namebase
                Definition

                R4B: OperationDefinition.base additional types (canonical(http://hl7.org/fhir/StructureDefinition/OperationDefinition)) additional types from child elements (value)

                ShortR4B: base additional types
                Comments

                Element OperationDefinition.base is mapped to FHIR STU3 element OperationDefinition.base as SourceIsBroaderThanTarget. The mappings for OperationDefinition.base do not cover the following types: canonical. The mappings for OperationDefinition.base do not cover the following types based on type expansion: value. A constrained profile can make optional parameters required or not used and clarify documentation.

                Control0..1
                TypeExtension(R4B: base additional types) (Extension Type: uri(Cross-version Profile for R4B.OperationDefinition for use in FHIR STU3, OperationDefinition))
                40. OperationDefinition.resource
                42. OperationDefinition.resource.extension
                Control0..*
                SlicingThis element introduces a set of slices on OperationDefinition.resource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 44. OperationDefinition.resource.extension:resource
                  Slice Nameresource
                  Definition

                  R4B: OperationDefinition.resource additional codes

                  ShortR4B: resource additional codes
                  Comments

                  Element OperationDefinition.resource is mapped to FHIR STU3 element OperationDefinition.resource as RelatedTo. The mappings for OperationDefinition.resource do not allow expression of the necessary codes, per the bindings on the source and target. If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization.

                  Control0..*
                  TypeExtension(R4B: resource additional codes) (Extension Type: code)
                  46. OperationDefinition.parameter
                  48. OperationDefinition.parameter.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on OperationDefinition.parameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 50. OperationDefinition.parameter.extension:referencedFrom
                    Slice NamereferencedFrom
                    Definition

                    R4B: OperationDefinition.parameter.referencedFrom (new:BackboneElement)

                    ShortR4B: References to this parameter (new)
                    Comments

                    Element OperationDefinition.parameter.referencedFrom has a context of OperationDefinition.parameter based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.parameter.referencedFrom has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Resolution applies if the referenced parameter exists.

                    Control0..*
                    TypeExtension(R4B: References to this parameter (new)) (Complex Extension)
                    52. OperationDefinition.parameter.type
                    54. OperationDefinition.parameter.type.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on OperationDefinition.parameter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 56. OperationDefinition.parameter.type.extension:type
                      Slice Nametype
                      Definition

                      R4B: OperationDefinition.parameter.type additional codes

                      ShortR4B: type additional codes
                      Comments

                      Element OperationDefinition.parameter.type is mapped to FHIR STU3 element OperationDefinition.parameter.type as RelatedTo. The mappings for OperationDefinition.parameter.type do not allow expression of the necessary codes, per the bindings on the source and target. 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
                      TypeExtension(R4B: type additional codes) (Extension Type: code)
                      58. OperationDefinition.parameter.searchType
                      60. OperationDefinition.parameter.searchType.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on OperationDefinition.parameter.searchType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 62. OperationDefinition.parameter.searchType.extension:searchType
                        Slice NamesearchType
                        Definition

                        R4B: OperationDefinition.parameter.searchType

                        ShortR4B: number | date | string | token | reference | composite | quantity | uri | special
                        Comments

                        Element OperationDefinition.parameter.searchType is mapped to FHIR STU3 element OperationDefinition.parameter.searchType as SourceIsBroaderThanTarget.

                        Control0..1
                        TypeExtension(R4B: number | date | string | token | reference | composite | quantity | uri | special) (Extension Type: code)
                        64. OperationDefinition.parameter.profile
                        66. OperationDefinition.parameter.profile.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on OperationDefinition.parameter.profile.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 68. OperationDefinition.parameter.profile.extension:targetProfile
                          Slice NametargetProfile
                          Definition

                          R4B: OperationDefinition.parameter.targetProfile additional types (canonical(http://hl7.org/fhir/StructureDefinition/StructureDefinition)) additional types from child elements (value)

                          ShortR4B: If type is Reference | canonical, allowed targets additional types
                          Comments

                          Element OperationDefinition.parameter.targetProfile is mapped to FHIR STU3 element OperationDefinition.parameter.profile as SourceIsBroaderThanTarget. The mappings for OperationDefinition.parameter.targetProfile do not cover the following types: canonical. The mappings for OperationDefinition.parameter.targetProfile do not cover the following types based on type expansion: value. Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).

                          Control0..*
                          TypeExtension(R4B: If type is Reference | canonical, allowed targets additional types) (Extension Type: uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition))

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

                          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..*
                          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                          dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
                          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
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          4. OperationDefinition.meta
                          Definition

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

                          ShortMetadata about the resource
                          Control0..1
                          TypeMeta
                          Summarytrue
                          6. OperationDefinition.meta.id
                          Definition

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

                          Shortxml:id (or equivalent in JSON)
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          XML FormatIn the XML format, this property is represented as an attribute.
                          8. OperationDefinition.meta.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..*
                          TypeExtension
                          SlicingThis element introduces a set of slices on OperationDefinition.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 10. OperationDefinition.meta.extension:meta
                            Slice Namemeta
                            Definition

                            R4B: OperationDefinition.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

                            ShortR4B: meta additional types
                            Comments

                            Element OperationDefinition.meta is mapped to FHIR STU3 element OperationDefinition.meta as SourceIsBroaderThanTarget. The mappings for OperationDefinition.meta do not cover the following types: Meta. The mappings for OperationDefinition.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

                            Control0..1
                            TypeExtension(R4B: meta additional types) (Extension Type: Meta)
                            12. OperationDefinition.meta.versionId
                            Definition

                            The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

                            ShortVersion specific identifier
                            Comments

                            The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                            Control0..1
                            Typeid
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            14. OperationDefinition.meta.lastUpdated
                            Definition

                            When the resource last changed - e.g. when the version changed.

                            ShortWhen the resource version last changed
                            Comments

                            This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

                            Control0..1
                            Typeinstant
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            16. OperationDefinition.meta.profile
                            Definition

                            A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                            ShortProfiles this resource claims to conform to
                            Comments

                            It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                            Control0..*
                            Typeuri
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            18. OperationDefinition.meta.security
                            Definition

                            Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                            ShortSecurity Labels applied to this resource
                            Comments

                            The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                            Control0..*
                            BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                            (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)

                            Security Labels from the Healthcare Privacy and Security Classification System.

                            TypeCoding
                            Summarytrue
                            20. OperationDefinition.meta.tag
                            Definition

                            Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                            ShortTags applied to this resource
                            Comments

                            The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                            Control0..*
                            BindingFor example codes, see Common Tags
                            (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)

                            Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

                            TypeCoding
                            Summarytrue
                            22. 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.

                            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.

                            This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

                            Control0..1
                            Typeuri
                            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            24. 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
                            BindingUnless not suitable, these codes SHALL be taken from Common Languages
                            (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

                            A human language.

                            Additional BindingsPurpose
                            All LanguagesMax Binding
                            Typecode
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            26. OperationDefinition.text
                            Definition

                            A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later.

                            Control0..1
                            This element is affected by the following invariants: dom-1
                            TypeNarrative
                            Alternate Namesnarrative, html, xhtml, display
                            28. OperationDefinition.text.id
                            Definition

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

                            Shortxml:id (or equivalent in JSON)
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            XML FormatIn the XML format, this property is represented as an attribute.
                            30. OperationDefinition.text.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..*
                            TypeExtension
                            SlicingThis element introduces a set of slices on OperationDefinition.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 32. OperationDefinition.text.extension:text
                              Slice Nametext
                              Definition

                              R4B: OperationDefinition.text additional types (Narrative) additional types from child elements (div, status)

                              ShortR4B: text additional types
                              Comments

                              Element OperationDefinition.text is mapped to FHIR STU3 element OperationDefinition.text as SourceIsBroaderThanTarget. The mappings for OperationDefinition.text do not cover the following types: Narrative. The mappings for OperationDefinition.text do not cover the following types based on type expansion: div, status. 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
                              TypeExtension(R4B: text additional types) (Complex Extension)
                              34. OperationDefinition.text.status
                              Definition

                              The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                              Shortgenerated | extensions | additional | empty
                              Control1..1
                              BindingThe codes SHALL be taken from NarrativeStatus
                              (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)

                              The status of a resource narrative

                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              36. OperationDefinition.text.div
                              Definition

                              The actual narrative content, a stripped down version of XHTML.

                              ShortLimited xhtml content
                              Comments

                              The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                              Control1..1
                              Typexhtml
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Invariantstxt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlchecks())
                              txt-2: The narrative SHALL have some non-whitespace content (htmlchecks())
                              38. 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.

                              Control0..*
                              TypeResource
                              Alternate Namesinline resources, anonymous resources, contained resources
                              40. OperationDefinition.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              SlicingThis element introduces a set of slices on OperationDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 42. OperationDefinition.extension:title
                                Slice Nametitle
                                Definition

                                R4B: OperationDefinition.title (new:string)

                                ShortR4B: Name for this operation definition (human friendly) (new)
                                Comments

                                Element OperationDefinition.title has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(R4B: Name for this operation definition (human friendly) (new)) (Extension Type: string)
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                44. OperationDefinition.extension:inputProfile
                                Slice NameinputProfile
                                Definition

                                R4B: OperationDefinition.inputProfile (new:canonical(StructureDefinition))

                                ShortR4B: Validation information for in parameters (new)
                                Comments

                                Element OperationDefinition.inputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.inputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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
                                This element is affected by the following invariants: ele-1
                                TypeExtension(R4B: Validation information for in parameters (new)) (Extension Type: uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition))
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                46. OperationDefinition.extension:outputProfile
                                Slice NameoutputProfile
                                Definition

                                R4B: OperationDefinition.outputProfile (new:canonical(StructureDefinition))

                                ShortR4B: Validation information for out parameters (new)
                                Comments

                                Element OperationDefinition.outputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.outputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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
                                This element is affected by the following invariants: ele-1
                                TypeExtension(R4B: Validation information for out parameters (new)) (Extension Type: uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition))
                                Is Modifierfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                48. 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. Usually modifier elements provide negation or qualification. In order 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.

                                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 No Modifier Reason provideed in previous versions of FHIR
                                Alternate Namesextensions, user content
                                50. 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see Technical and Business Versions.

                                ShortLogical URI to reference this operation definition (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.

                                Control0..1
                                Typeuri
                                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.

                                52. 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 refrence to a particular business version of the operation definition with the format [url]|[version].

                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                54. 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 alpha-numeric type name to ensure that it is computable friendly.

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

                                Support human navigation and code generation.

                                56. 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 vs. not.
                                This is labeled as "Is Modifier" because applications should not use a retired operation definition without due consideration.

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

                                The lifecycle status of a Value Set or Concept Map.

                                Typecode
                                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                58. 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|3.0.2)

                                Whether an operation is a normal operation or a query.

                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                60. 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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental operation definition in production.

                                Control0..1
                                Typeboolean
                                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                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.

                                62. OperationDefinition.date
                                Definition

                                The date (and optionally time) when the operation definition was published. The date must change if and 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 this was 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
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesRevision Date
                                64. OperationDefinition.publisher
                                Definition

                                The name of the individual or organization 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
                                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.

                                66. 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
                                Summarytrue
                                68. OperationDefinition.contact.id
                                Definition

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

                                Shortxml:id (or equivalent in JSON)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                XML FormatIn the XML format, this property is represented as an attribute.
                                70. OperationDefinition.contact.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                SlicingThis element introduces a set of slices on OperationDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 72. OperationDefinition.contact.extension:contact
                                  Slice Namecontact
                                  Definition

                                  R4B: OperationDefinition.contact additional types (ContactDetail) additional types from child elements (name, telecom)

                                  ShortR4B: contact additional types
                                  Comments

                                  Element OperationDefinition.contact is mapped to FHIR STU3 element OperationDefinition.contact as SourceIsBroaderThanTarget. The mappings for OperationDefinition.contact do not cover the following types: ContactDetail. The mappings for OperationDefinition.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

                                  Control0..*
                                  TypeExtension(R4B: contact additional types) (Complex Extension)
                                  74. OperationDefinition.contact.name
                                  Definition

                                  The name of an individual to contact.

                                  ShortName of an individual to contact
                                  Comments

                                  If there is no named individual, the telecom information is for the organization as a whole.

                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  76. OperationDefinition.contact.telecom
                                  Definition

                                  The contact details for the individual (if a name was provided) or the organization.

                                  ShortContact details for individual or organization
                                  Control0..*
                                  TypeContactPoint
                                  Summarytrue
                                  78. 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 profile is presumed to be the predominant language in the place the profile was created).

                                  Control0..1
                                  Typemarkdown
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  80. OperationDefinition.useContext
                                  Definition

                                  The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate operation definition instances.

                                  ShortContext the content is intended to support
                                  Comments

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

                                  Control0..*
                                  TypeUsageContext
                                  Summarytrue
                                  Requirements

                                  Assist in searching for appropriate content.

                                  82. OperationDefinition.useContext.id
                                  Definition

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

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  84. OperationDefinition.useContext.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  SlicingThis element introduces a set of slices on OperationDefinition.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 86. OperationDefinition.useContext.extension:useContext
                                    Slice NameuseContext
                                    Definition

                                    R4B: OperationDefinition.useContext additional types (UsageContext) additional types from child elements (code, value[x])

                                    ShortR4B: The context that the content is intended to support additional types
                                    Comments

                                    Element OperationDefinition.useContext is mapped to FHIR STU3 element OperationDefinition.useContext as SourceIsBroaderThanTarget. The mappings for OperationDefinition.useContext do not cover the following types: UsageContext. The mappings for OperationDefinition.useContext do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

                                    Control0..*
                                    TypeExtension(R4B: The context that the content is intended to support additional types) (Complex Extension)
                                    88. OperationDefinition.useContext.code
                                    Definition

                                    A code that identifies the type of context being specified by this usage context.

                                    ShortType of context being specified
                                    Control1..1
                                    BindingUnless not suitable, these codes SHALL be taken from UsageContextType
                                    (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|3.0.2)

                                    A code that specifies a type of context being specified by a usage context

                                    TypeCoding
                                    Summarytrue
                                    90. OperationDefinition.useContext.value[x]
                                    Definition

                                    A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

                                    ShortValue that defines the context
                                    Control1..1
                                    BindingFor example codes, see Context of Use ValueSet
                                    (example to http://hl7.org/fhir/ValueSet/use-context|3.0.2)

                                    A code that defines the specific value for the context being specified

                                    TypeChoice of: CodeableConcept, Quantity, Range
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    Summarytrue
                                    92. 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|3.0.2)

                                    Countries and regions within which this artifact is targeted for use

                                    TypeCodeableConcept
                                    Summarytrue
                                    94. OperationDefinition.purpose
                                    Definition

                                    Explaination 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
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    96. OperationDefinition.idempotent
                                    Definition

                                    Operations that are idempotent (see HTTP specification definition of idempotent) may be invoked by performing an HTTP GET operation instead of a POST.

                                    ShortWhether content is unchanged by the operation
                                    Control0..1
                                    Typeboolean
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    98. OperationDefinition.code
                                    Definition

                                    The name used to invoke the operation.

                                    ShortName used to invoke the operation
                                    Comments

                                    The code does not include the '$' prefix that is always included in the URL when the operation is invoked.

                                    Control1..1
                                    Typecode
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    100. OperationDefinition.comment
                                    Definition

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

                                    ShortAdditional information about use
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    102. 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
                                    TypeReference(OperationDefinition)
                                    Summarytrue
                                    104. OperationDefinition.base.id
                                    Definition

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

                                    Shortxml:id (or equivalent in JSON)
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    106. OperationDefinition.base.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..*
                                    TypeExtension
                                    SlicingThis element introduces a set of slices on OperationDefinition.base.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 108. OperationDefinition.base.extension:base
                                      Slice Namebase
                                      Definition

                                      R4B: OperationDefinition.base additional types (canonical(http://hl7.org/fhir/StructureDefinition/OperationDefinition)) additional types from child elements (value)

                                      ShortR4B: base additional types
                                      Comments

                                      Element OperationDefinition.base is mapped to FHIR STU3 element OperationDefinition.base as SourceIsBroaderThanTarget. The mappings for OperationDefinition.base do not cover the following types: canonical. The mappings for OperationDefinition.base do not cover the following types based on type expansion: value. A constrained profile can make optional parameters required or not used and clarify documentation.

                                      Control0..1
                                      TypeExtension(R4B: base additional types) (Extension Type: uri(Cross-version Profile for R4B.OperationDefinition for use in FHIR STU3, OperationDefinition))
                                      110. OperationDefinition.base.reference
                                      Definition

                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                      ShortLiteral reference, Relative, internal or absolute URL
                                      Comments

                                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                      Control0..1
                                      This element is affected by the following invariants: ref-1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      112. OperationDefinition.base.identifier
                                      Definition

                                      An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                      ShortLogical reference, when literal reference is not known
                                      Comments

                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      TypeIdentifier
                                      Summarytrue
                                      114. OperationDefinition.base.display
                                      Definition

                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                      ShortText alternative for the resource
                                      Comments

                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      116. 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|3.0.2)

                                      One of the resource types defined as part of FHIR.

                                      Typecode
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      118. OperationDefinition.resource.id
                                      Definition

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

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      120. OperationDefinition.resource.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      SlicingThis element introduces a set of slices on OperationDefinition.resource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 122. OperationDefinition.resource.extension:resource
                                        Slice Nameresource
                                        Definition

                                        R4B: OperationDefinition.resource additional codes

                                        ShortR4B: resource additional codes
                                        Comments

                                        Element OperationDefinition.resource is mapped to FHIR STU3 element OperationDefinition.resource as RelatedTo. The mappings for OperationDefinition.resource do not allow expression of the necessary codes, per the bindings on the source and target. If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization.

                                        Control0..*
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(R4B: resource additional codes) (Extension Type: code)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        124. OperationDefinition.resource.value
                                        Definition

                                        Primitive value for code

                                        ShortPrimitive value for code
                                        Control0..1
                                        Typecode
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        126. 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
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        128. 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).

                                        ShortInvole at the type level?
                                        Control1..1
                                        Typeboolean
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        130. 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
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        132. 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 may not be described, but can be to allow a profile to be defined.

                                        Control0..*
                                        TypeBackboneElement
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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 implies type = 'string')
                                        134. 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.

                                        Shortxml:id (or equivalent in JSON)
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        136. OperationDefinition.parameter.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        SlicingThis element introduces a set of slices on OperationDefinition.parameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 138. OperationDefinition.parameter.extension:referencedFrom
                                          Slice NamereferencedFrom
                                          Definition

                                          R4B: OperationDefinition.parameter.referencedFrom (new:BackboneElement)

                                          ShortR4B: References to this parameter (new)
                                          Comments

                                          Element OperationDefinition.parameter.referencedFrom has a context of OperationDefinition.parameter based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.parameter.referencedFrom has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Resolution applies if the referenced parameter exists.

                                          Control0..*
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(R4B: References to this parameter (new)) (Complex Extension)
                                          Is Modifierfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          140. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

                                          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 No Modifier Reason provideed in previous versions of FHIR
                                          Summarytrue
                                          Alternate Namesextensions, user content, modifiers
                                          142. 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
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          144. 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|3.0.2)

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

                                          Typecode
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          146. OperationDefinition.parameter.min
                                          Definition

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

                                          ShortMinimum Cardinality
                                          Control1..1
                                          Typeinteger
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          148. 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
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          150. OperationDefinition.parameter.documentation
                                          Definition

                                          Describes the meaning or use of this parameter.

                                          ShortDescription of meaning/use
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          152. 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|3.0.2)

                                          Either an abstract type, a resource or a data type.

                                          Typecode
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          154. OperationDefinition.parameter.type.id
                                          Definition

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

                                          Shortxml:id (or equivalent in JSON)
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          156. OperationDefinition.parameter.type.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..*
                                          TypeExtension
                                          SlicingThis element introduces a set of slices on OperationDefinition.parameter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 158. OperationDefinition.parameter.type.extension:type
                                            Slice Nametype
                                            Definition

                                            R4B: OperationDefinition.parameter.type additional codes

                                            ShortR4B: type additional codes
                                            Comments

                                            Element OperationDefinition.parameter.type is mapped to FHIR STU3 element OperationDefinition.parameter.type as RelatedTo. The mappings for OperationDefinition.parameter.type do not allow expression of the necessary codes, per the bindings on the source and target. 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: ele-1
                                            TypeExtension(R4B: type additional codes) (Extension Type: code)
                                            Is Modifierfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            160. OperationDefinition.parameter.type.value
                                            Definition

                                            Primitive value for code

                                            ShortPrimitive value for code
                                            Control0..1
                                            Typecode
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            162. 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
                                            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|3.0.2)

                                            Data types allowed to be used for search parameters.

                                            Typecode
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            164. OperationDefinition.parameter.searchType.id
                                            Definition

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

                                            Shortxml:id (or equivalent in JSON)
                                            Control0..1
                                            Typestring
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            166. OperationDefinition.parameter.searchType.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control0..*
                                            TypeExtension
                                            SlicingThis element introduces a set of slices on OperationDefinition.parameter.searchType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 168. OperationDefinition.parameter.searchType.extension:searchType
                                              Slice NamesearchType
                                              Definition

                                              R4B: OperationDefinition.parameter.searchType

                                              ShortR4B: number | date | string | token | reference | composite | quantity | uri | special
                                              Comments

                                              Element OperationDefinition.parameter.searchType is mapped to FHIR STU3 element OperationDefinition.parameter.searchType as SourceIsBroaderThanTarget.

                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(R4B: number | date | string | token | reference | composite | quantity | uri | special) (Extension Type: code)
                                              Is Modifierfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              170. OperationDefinition.parameter.searchType.value
                                              Definition

                                              Primitive value for code

                                              ShortPrimitive value for code
                                              Control0..1
                                              Typecode
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              172. OperationDefinition.parameter.profile
                                              Definition

                                              A profile the specifies the rules that this parameter must conform to.

                                              ShortProfile on the type
                                              Control0..1
                                              TypeReference(StructureDefinition)
                                              174. OperationDefinition.parameter.profile.id
                                              Definition

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

                                              Shortxml:id (or equivalent in JSON)
                                              Control0..1
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              176. OperationDefinition.parameter.profile.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..*
                                              TypeExtension
                                              SlicingThis element introduces a set of slices on OperationDefinition.parameter.profile.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 178. OperationDefinition.parameter.profile.extension:targetProfile
                                                Slice NametargetProfile
                                                Definition

                                                R4B: OperationDefinition.parameter.targetProfile additional types (canonical(http://hl7.org/fhir/StructureDefinition/StructureDefinition)) additional types from child elements (value)

                                                ShortR4B: If type is Reference | canonical, allowed targets additional types
                                                Comments

                                                Element OperationDefinition.parameter.targetProfile is mapped to FHIR STU3 element OperationDefinition.parameter.profile as SourceIsBroaderThanTarget. The mappings for OperationDefinition.parameter.targetProfile do not cover the following types: canonical. The mappings for OperationDefinition.parameter.targetProfile do not cover the following types based on type expansion: value. Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).

                                                Control0..*
                                                TypeExtension(R4B: If type is Reference | canonical, allowed targets additional types) (Extension Type: uri(Cross-version Profile for R4B.StructureDefinition for use in FHIR STU3, StructureDefinition))
                                                180. OperationDefinition.parameter.profile.reference
                                                Definition

                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                ShortLiteral reference, Relative, internal or absolute URL
                                                Comments

                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                Control0..1
                                                This element is affected by the following invariants: ref-1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                182. OperationDefinition.parameter.profile.identifier
                                                Definition

                                                An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                ShortLogical reference, when literal reference is not known
                                                Comments

                                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..1
                                                TypeIdentifier
                                                Summarytrue
                                                184. OperationDefinition.parameter.profile.display
                                                Definition

                                                Plain text narrative that identifies the resource in addition to the resource reference.

                                                ShortText alternative for the resource
                                                Comments

                                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                186. 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
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                188. 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.

                                                Shortxml:id (or equivalent in JSON)
                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                190. OperationDefinition.parameter.binding.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                                                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
                                                Alternate Namesextensions, user content
                                                192. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

                                                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 No Modifier Reason provideed in previous versions of FHIR
                                                Summarytrue
                                                Alternate Namesextensions, user content, modifiers
                                                194. 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|3.0.2)

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

                                                Typecode
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Alternate Namesconformance, extensibility
                                                196. OperationDefinition.parameter.binding.valueSet[x]
                                                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
                                                TypeChoice of: uri, Reference(ValueSet)
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                198. 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 may not be described, but can be to allow a profile to be defined.

                                                Control0..*
                                                This element is affected by the following invariants: opd-1
                                                TypeSeettp://hl7.org/fhir/StructureDefinition/OperationDefinition#OperationDefinition.parameter
                                                200. 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
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                202. 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.

                                                Shortxml:id (or equivalent in JSON)
                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                204. OperationDefinition.overload.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                                                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
                                                Alternate Namesextensions, user content
                                                206. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

                                                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 No Modifier Reason provideed in previous versions of FHIR
                                                Summarytrue
                                                Alternate Namesextensions, user content, modifiers
                                                208. OperationDefinition.overload.parameterName
                                                Definition

                                                Name of parameter to include in overload.

                                                ShortName of parameter to include in overload
                                                Control0..*
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                210. OperationDefinition.overload.comment
                                                Definition

                                                Comments to go on overload.

                                                ShortComments to go on overload
                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension