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

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

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

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

ShortA set of rules under which this content was created
Comments

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

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

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

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

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summaryfalse
Requirements

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

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

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

ShortName for this operation definition (computer friendly)
Comments

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

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

Support human navigation and code generation.

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

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

Shortdraft | active | retired | unknown
Comments

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

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

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. OperationDefinition.kind
Definition

Whether this is an operation or a named query.

Shortoperation | query
Comments

Named queries are invoked differently, and have different capabilities.

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

Whether an operation is a normal operation or a query.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. OperationDefinition.code
Definition

The name used to invoke the operation.

ShortName used to invoke the operation
Control1..1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. OperationDefinition.system
Definition

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

ShortInvoke at the system level?
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. OperationDefinition.type
Definition

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

ShortInvoke at the type level?
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. OperationDefinition.instance
Definition

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

ShortInvoke on an instance?
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be 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

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

    ShortSTU3: meta additional types
    Comments

    Element OperationDefinition.meta is mapped to FHIR R4B 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, tag, versionId.

    Control0..1
    TypeExtension(STU3: meta additional types) (Complex Extension)
    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

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

      ShortSTU3: text additional types
      Comments

      Element OperationDefinition.text is mapped to FHIR R4B 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 in formation is added later.

      Control0..1
      TypeExtension(STU3: text additional types) (Complex Extension)
      14. OperationDefinition.contact
      16. 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
      • 18. OperationDefinition.contact.extension:contact
        Slice Namecontact
        Definition

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

        ShortSTU3: contact additional types
        Comments

        Element OperationDefinition.contact is mapped to FHIR R4B 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(STU3: contact additional types) (Extension Type: ContactDetail)
        20. OperationDefinition.useContext
        22. 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
        • 24. OperationDefinition.useContext.extension:useContext
          Slice NameuseContext
          Definition

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

          ShortSTU3: Context the content is intended to support additional types
          Comments

          Element OperationDefinition.useContext is mapped to FHIR R4B 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 whether all or any of the contexts apply.

          Control0..*
          TypeExtension(STU3: Context the content is intended to support additional types) (Extension Type: UsageContext)
          26. OperationDefinition.base
          28. 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
          • 30. OperationDefinition.base.extension:base
            Slice Namebase
            Definition

            STU3: OperationDefinition.base additional types (Reference(http://hl7.org/fhir/StructureDefinition/OperationDefinition)) additional types from child elements (display, identifier, reference)

            ShortSTU3: base additional types
            Comments

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

            Control0..1
            TypeExtension(STU3: base additional types) (Extension Type: Reference(Cross-version Profile for STU3.OperationDefinition for use in FHIR R4B, OperationDefinition))
            32. OperationDefinition.resource
            34. 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
            • 36. OperationDefinition.resource.extension:resource
              Slice Nameresource
              Definition

              STU3: OperationDefinition.resource additional codes

              ShortSTU3: resource additional codes
              Comments

              Element OperationDefinition.resource is mapped to FHIR R4B 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(STU3: resource additional codes) (Extension Type: code)
              38. OperationDefinition.parameter
              40. OperationDefinition.parameter.type
              42. 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
              • 44. OperationDefinition.parameter.type.extension:type
                Slice Nametype
                Definition

                STU3: OperationDefinition.parameter.type additional codes

                ShortSTU3: type additional codes
                Comments

                Element OperationDefinition.parameter.type is mapped to FHIR R4B 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(STU3: type additional codes) (Extension Type: code)
                46. OperationDefinition.parameter.targetProfile
                48. OperationDefinition.parameter.targetProfile.extension
                Control0..*
                SlicingThis element introduces a set of slices on OperationDefinition.parameter.targetProfile.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 50. OperationDefinition.parameter.targetProfile.extension:profile
                  Slice Nameprofile
                  Definition

                  STU3: OperationDefinition.parameter.profile additional types (Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition)) additional types from child elements (display, identifier, reference)

                  ShortSTU3: Profile on the type additional types
                  Comments

                  Element OperationDefinition.parameter.profile is mapped to FHIR R4B element OperationDefinition.parameter.targetProfile as RelatedTo. The mappings for OperationDefinition.parameter.profile do not cover the following types: Reference. The mappings for OperationDefinition.parameter.profile do not cover the following types based on type expansion: display, identifier, reference.

                  Control0..1
                  TypeExtension(STU3: Profile on the type additional types) (Extension Type: Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B, StructureDefinition))
                  52. OperationDefinition.parameter.binding
                  54. OperationDefinition.parameter.binding.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on OperationDefinition.parameter.binding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 56. OperationDefinition.parameter.binding.extension:valueSet
                    Slice NamevalueSet
                    Definition

                    STU3: OperationDefinition.parameter.binding.valueSet[x] additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet)) additional types from child elements (display, identifier, reference)

                    ShortSTU3: Source of value set additional types
                    Comments

                    Element OperationDefinition.parameter.binding.valueSet[x] is mapped to FHIR R4B element OperationDefinition.parameter.binding.valueSet as SourceIsBroaderThanTarget. The mappings for OperationDefinition.parameter.binding.valueSet[x] do not cover the following types: Reference. The mappings for OperationDefinition.parameter.binding.valueSet[x] do not cover the following types based on type expansion: display, identifier, reference. For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

                    Control0..1
                    TypeExtension(STU3: Source of value set additional types) (Extension Type: Reference(Cross-version Profile for STU3.ValueSet for use in FHIR R4B, ValueSet))

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

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

                    ShortLogical id of this artifact
                    Comments

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

                    Control0..1
                    Typeid
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    4. OperationDefinition.meta
                    Definition

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

                    ShortMetadata about the resource
                    Control0..1
                    TypeMeta
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    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.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    8. OperationDefinition.meta.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on 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

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

                      ShortSTU3: meta additional types
                      Comments

                      Element OperationDefinition.meta is mapped to FHIR R4B 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, tag, versionId.

                      Control0..1
                      TypeExtension(STU3: meta additional types) (Complex Extension)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      12. OperationDefinition.meta.versionId
                      Definition

                      The version specific identifier, as it appears in the version portion of the URL. This value 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
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      14. OperationDefinition.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. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

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

                      A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                      ShortIdentifies where the resource comes from
                      Comments

                      In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                      This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      18. OperationDefinition.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..*
                      Typecanonical(StructureDefinition)
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      20. OperationDefinition.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|4.3.0)
                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      22. 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 CommonTags
                      (example to http://hl7.org/fhir/ValueSet/common-tags|4.3.0)
                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      24. OperationDefinition.implicitRules
                      Definition

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

                      ShortA set of rules under which this content was created
                      Comments

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

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

                      The base language in which the resource is written.

                      ShortLanguage of the resource content
                      Comments

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

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

                      IETF language tag

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

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

                      ShortText summary of the resource, for human interpretation
                      Comments

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

                      Control0..1
                      TypeNarrative
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Alternate Namesnarrative, html, xhtml, display
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      30. 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.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      32. OperationDefinition.text.extension
                      Definition

                      An Extension

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

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

                        ShortSTU3: text additional types
                        Comments

                        Element OperationDefinition.text is mapped to FHIR R4B 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 in formation is added later.

                        Control0..1
                        TypeExtension(STU3: text additional types) (Complex Extension)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        36. OperationDefinition.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|4.3.0)
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        38. 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 SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                        Control1..1
                        Typexhtml
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        txt-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())
                        40. OperationDefinition.contained
                        Definition

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

                        ShortContained, inline Resources
                        Comments

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

                        Control0..*
                        TypeResource
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Alternate Namesinline resources, anonymous resources, contained resources
                        Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                        42. OperationDefinition.extension
                        Definition

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

                        ShortAdditional content defined by implementations
                        Comments

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

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

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

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

                        ShortExtensions that cannot be ignored
                        Comments

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

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                        Must Supportfalse
                        Summaryfalse
                        Requirements

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

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

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

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

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

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

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

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

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

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

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

                        ShortBusiness version of the operation definition
                        Comments

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

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        50. OperationDefinition.name
                        Definition

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

                        ShortName for this operation definition (computer friendly)
                        Comments

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

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

                        Support human navigation and code generation.

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

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

                        ShortName for this operation definition (human friendly)
                        Comments

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

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        54. OperationDefinition.status
                        Definition

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

                        Shortdraft | active | retired | unknown
                        Comments

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

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

                        The lifecycle status of an artifact.

                        Typecode
                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        56. OperationDefinition.kind
                        Definition

                        Whether this is an operation or a named query.

                        Shortoperation | query
                        Comments

                        Named queries are invoked differently, and have different capabilities.

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

                        Whether an operation is a normal operation or a query.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        58. OperationDefinition.experimental
                        Definition

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

                        ShortFor testing purposes, not real usage
                        Comments

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

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

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

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

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

                        ShortDate last changed
                        Comments

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

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

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

                        ShortName of the publisher (organization or individual)
                        Comments

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

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

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

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

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

                        ShortContact details for the publisher
                        Comments

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

                        Control0..*
                        TypeContactDetail
                        Is Modifierfalse
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        66. 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.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typeid
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        68. OperationDefinition.contact.extension
                        Definition

                        An Extension

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

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

                          ShortSTU3: contact additional types
                          Comments

                          Element OperationDefinition.contact is mapped to FHIR R4B 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(STU3: contact additional types) (Extension Type: ContactDetail)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          72. 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
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          74. 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
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          76. OperationDefinition.description
                          Definition

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

                          ShortNatural language description of the operation definition
                          Comments

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

                          Control0..1
                          Typemarkdown
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          78. OperationDefinition.useContext
                          Definition

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

                          ShortThe context that the content is intended to support
                          Comments

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

                          Control0..*
                          TypeUsageContext
                          Is Modifierfalse
                          Must Supportfalse
                          Summarytrue
                          Requirements

                          Assist in searching for appropriate content.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          80. 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.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          82. OperationDefinition.useContext.extension
                          Definition

                          An Extension

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

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

                            ShortSTU3: Context the content is intended to support additional types
                            Comments

                            Element OperationDefinition.useContext is mapped to FHIR R4B 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 whether all or any of the contexts apply.

                            Control0..*
                            TypeExtension(STU3: Context the content is intended to support additional types) (Extension Type: UsageContext)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            86. 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|4.3.0)
                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            88. 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|4.3.0)
                            TypeChoice of: CodeableConcept, Quantity, Range, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization)
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            90. 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|4.3.0)

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

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

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

                            ShortWhy this operation definition is defined
                            Comments

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

                            Control0..1
                            Typemarkdown
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            94. OperationDefinition.affectsState
                            Definition

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

                            ShortWhether content is changed by the operation
                            Comments

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

                            1. Servers SHALL support POST method for all operations.

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

                            Control0..1
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            96. OperationDefinition.code
                            Definition

                            The name used to invoke the operation.

                            ShortName used to invoke the operation
                            Control1..1
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            98. OperationDefinition.comment
                            Definition

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

                            ShortAdditional information about use
                            Control0..1
                            Typemarkdown
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            100. OperationDefinition.base
                            Definition

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

                            ShortMarks this as a profile of the base
                            Comments

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

                            Control0..1
                            Typecanonical(OperationDefinition)
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            102. OperationDefinition.base.id
                            Definition

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

                            Shortxml:id (or equivalent in JSON)
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            104. OperationDefinition.base.extension
                            Definition

                            An Extension

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

                              STU3: OperationDefinition.base additional types (Reference(http://hl7.org/fhir/StructureDefinition/OperationDefinition)) additional types from child elements (display, identifier, reference)

                              ShortSTU3: base additional types
                              Comments

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

                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(STU3: base additional types) (Extension Type: Reference(Cross-version Profile for STU3.OperationDefinition for use in FHIR R4B, OperationDefinition))
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              108. OperationDefinition.base.value
                              Definition

                              Primitive value for canonical

                              ShortPrimitive value for canonical
                              Control0..1
                              Typecanonical
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              110. OperationDefinition.resource
                              Definition

                              The types on which this operation can be executed.

                              ShortTypes this operation applies to
                              Comments

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

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

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

                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              112. OperationDefinition.resource.id
                              Definition

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

                              Shortxml:id (or equivalent in JSON)
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              114. OperationDefinition.resource.extension
                              Definition

                              An Extension

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

                                STU3: OperationDefinition.resource additional codes

                                ShortSTU3: resource additional codes
                                Comments

                                Element OperationDefinition.resource is mapped to FHIR R4B 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(STU3: resource additional codes) (Extension Type: code)
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                118. OperationDefinition.resource.value
                                Definition

                                Primitive value for code

                                ShortPrimitive value for code
                                Control0..1
                                Typecode
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                120. OperationDefinition.system
                                Definition

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

                                ShortInvoke at the system level?
                                Control1..1
                                Typeboolean
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                122. OperationDefinition.type
                                Definition

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

                                ShortInvoke at the type level?
                                Control1..1
                                Typeboolean
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                124. OperationDefinition.instance
                                Definition

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

                                ShortInvoke on an instance?
                                Control1..1
                                Typeboolean
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                126. OperationDefinition.inputProfile
                                Definition

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

                                ShortValidation information for in parameters
                                Comments

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

                                Control0..1
                                Typecanonical(StructureDefinition)
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                128. OperationDefinition.outputProfile
                                Definition

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

                                ShortValidation information for out parameters
                                Comments

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

                                Control0..1
                                Typecanonical(StructureDefinition)
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                130. OperationDefinition.parameter
                                Definition

                                The parameters for the operation/query.

                                ShortParameters for the operation/query
                                Comments

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

                                Control0..*
                                TypeBackboneElement
                                Is Modifierfalse
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                opd-1: Either a type must be provided, or parts (type.exists() or part.exists())
                                opd-2: A search type can only be specified for parameters of type string (searchType.exists() implies type = 'string')
                                opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical (targetProfile.exists() implies (type = 'Reference' or type = 'canonical'))
                                132. OperationDefinition.parameter.id
                                Definition

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

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

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

                                ShortAdditional content defined by implementations
                                Comments

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

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

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

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

                                ShortExtensions that cannot be ignored even if unrecognized
                                Comments

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

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

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

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

                                The name of used to identify the parameter.

                                ShortName in Parameters.parameter.name or in URL
                                Comments

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

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

                                Whether this is an input or an output parameter.

                                Shortin | out
                                Comments

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

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

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

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

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

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

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

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

                                Describes the meaning or use of this parameter.

                                ShortDescription of meaning/use
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                148. OperationDefinition.parameter.type
                                Definition

                                The type for this parameter.

                                ShortWhat type this parameter has
                                Comments

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

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

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

                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                150. 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
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                152. OperationDefinition.parameter.type.extension
                                Definition

                                An Extension

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

                                  STU3: OperationDefinition.parameter.type additional codes

                                  ShortSTU3: type additional codes
                                  Comments

                                  Element OperationDefinition.parameter.type is mapped to FHIR R4B 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(STU3: type additional codes) (Extension Type: code)
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  156. OperationDefinition.parameter.type.value
                                  Definition

                                  Primitive value for code

                                  ShortPrimitive value for code
                                  Control0..1
                                  Typecode
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  158. OperationDefinition.parameter.targetProfile
                                  Definition

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

                                  ShortIf type is Reference | canonical, allowed targets
                                  Comments

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

                                  Control0..*
                                  Typecanonical(StructureDefinition)
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supportfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  160. OperationDefinition.parameter.targetProfile.id
                                  Definition

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

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  162. OperationDefinition.parameter.targetProfile.extension
                                  Definition

                                  An Extension

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

                                    STU3: OperationDefinition.parameter.profile additional types (Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition)) additional types from child elements (display, identifier, reference)

                                    ShortSTU3: Profile on the type additional types
                                    Comments

                                    Element OperationDefinition.parameter.profile is mapped to FHIR R4B element OperationDefinition.parameter.targetProfile as RelatedTo. The mappings for OperationDefinition.parameter.profile do not cover the following types: Reference. The mappings for OperationDefinition.parameter.profile do not cover the following types based on type expansion: display, identifier, reference.

                                    Control0..1
                                    This element is affected by the following invariants: ele-1
                                    TypeExtension(STU3: Profile on the type additional types) (Extension Type: Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B, StructureDefinition))
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    166. OperationDefinition.parameter.targetProfile.value
                                    Definition

                                    Primitive value for canonical

                                    ShortPrimitive value for canonical
                                    Control0..1
                                    Typecanonical
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    168. OperationDefinition.parameter.searchType
                                    Definition

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

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

                                    Data types allowed to be used for search parameters.

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

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

                                    ShortValueSet details if this is coded
                                    Control0..1
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                    172. OperationDefinition.parameter.binding.id
                                    Definition

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

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

                                    An Extension

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

                                      STU3: OperationDefinition.parameter.binding.valueSet[x] additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet)) additional types from child elements (display, identifier, reference)

                                      ShortSTU3: Source of value set additional types
                                      Comments

                                      Element OperationDefinition.parameter.binding.valueSet[x] is mapped to FHIR R4B element OperationDefinition.parameter.binding.valueSet as SourceIsBroaderThanTarget. The mappings for OperationDefinition.parameter.binding.valueSet[x] do not cover the following types: Reference. The mappings for OperationDefinition.parameter.binding.valueSet[x] do not cover the following types based on type expansion: display, identifier, reference. For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

                                      Control0..1
                                      This element is affected by the following invariants: ele-1
                                      TypeExtension(STU3: Source of value set additional types) (Extension Type: Reference(Cross-version Profile for STU3.ValueSet for use in FHIR R4B, ValueSet))
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      178. OperationDefinition.parameter.binding.modifierExtension
                                      Definition

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

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

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

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

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

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

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

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

                                      Shortrequired | extensible | preferred | example
                                      Comments

                                      For further discussion, see Using Terminologies.

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

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

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

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

                                      ShortSource of value set
                                      Comments

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

                                      Control1..1
                                      Typecanonical(ValueSet)
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      184. OperationDefinition.parameter.referencedFrom
                                      Definition

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

                                      ShortReferences to this parameter
                                      Comments

                                      Resolution applies if the referenced parameter exists.

                                      Control0..*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                      186. OperationDefinition.parameter.referencedFrom.id
                                      Definition

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

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

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

                                      ShortAdditional content defined by implementations
                                      Comments

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

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

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

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

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

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

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

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

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

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

                                      ShortReferencing parameter
                                      Control1..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      194. OperationDefinition.parameter.referencedFrom.sourceId
                                      Definition

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

                                      ShortElement id of reference
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      196. OperationDefinition.parameter.part
                                      Definition

                                      The parts of a nested Parameter.

                                      ShortParts of a nested Parameter
                                      Comments

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

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

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

                                      ShortDefine overloaded variants for when generating code
                                      Comments

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

                                      Control0..*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                      200. OperationDefinition.overload.id
                                      Definition

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

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

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

                                      ShortAdditional content defined by implementations
                                      Comments

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

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

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

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

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

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

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

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

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

                                      Name of parameter to include in overload.

                                      ShortName of parameter to include in overload
                                      Control0..*
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      208. OperationDefinition.overload.comment
                                      Definition

                                      Comments to go on overload.

                                      ShortComments to go on overload
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))