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

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

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

An Extension

R5: OperationDefinition.identifier (new:Identifier)

Element OperationDefinition.identifier has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.identifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.identifier: http://hl7.org/fhir/StructureDefinition/artifact-identifier.

R5: OperationDefinition.versionAlgorithm[x] (new:Coding, string)

Element OperationDefinition.versionAlgorithm[x] has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

R5: OperationDefinition.title (new:string)

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

R5: OperationDefinition.copyright (new:markdown)

Element OperationDefinition.copyright has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.copyright has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.copyright: http://hl7.org/fhir/StructureDefinition/artifact-copyright.

R5: OperationDefinition.copyrightLabel (new:string)

Element OperationDefinition.copyrightLabel has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.copyrightLabel has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

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

Element OperationDefinition.inputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.inputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

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

Element OperationDefinition.outputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.outputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

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

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.

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.

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.

Support human navigation and code generation.

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

Allows filtering of operation definitions that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired operation definition without due consideration.

The lifecycle status of a Value Set or Concept Map.

Whether this is an operation or a named query.

Named queries are invoked differently, and have different capabilities.

Whether an operation is a normal operation or a query.

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.

Allows filtering of operation definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental operation definition in production.

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

The name used to invoke the operation.

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

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).

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).

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

R5: OperationDefinition.identifier (new:Identifier)

Element OperationDefinition.identifier has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.identifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.identifier: http://hl7.org/fhir/StructureDefinition/artifact-identifier.

R5: OperationDefinition.versionAlgorithm[x] (new:Coding, string)

Element OperationDefinition.versionAlgorithm[x] has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

R5: OperationDefinition.title (new:string)

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

R5: OperationDefinition.copyright (new:markdown)

Element OperationDefinition.copyright has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.copyright has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.copyright: http://hl7.org/fhir/StructureDefinition/artifact-copyright.

R5: OperationDefinition.copyrightLabel (new:string)

Element OperationDefinition.copyrightLabel has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.copyrightLabel has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

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

Element OperationDefinition.inputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.inputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

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

Element OperationDefinition.outputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.outputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

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

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

See guidance around (not) making local changes to elements here.

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

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

R5: OperationDefinition.parameter.scope (new:code)

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

R5: OperationDefinition.parameter.allowedType (new:code)

Element OperationDefinition.parameter.allowedType has a context of OperationDefinition.parameter based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.parameter.allowedType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). In previous versions of FHIR, there was an extension for this: http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type

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

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

R5: OperationDefinition.parameter.searchType

Element OperationDefinition.parameter.searchType is mapped to FHIR STU3 element OperationDefinition.parameter.searchType as SourceIsBroaderThanTarget. Parameters that are search parameter usually - but not always - are also defined for use with general searches, and function in the operation to filter the set of resources in scope for the operation just like the do when searching. The searchType describes how the server processes the value. For an example, see the Evaluate Measure Operation

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

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

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

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

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

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

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

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

The base language in which the resource is written.

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).

Unless not suitable, these codes SHALL be taken from Common Languages
(extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

A human language.

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

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.

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.

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.

An Extension

R5: OperationDefinition.identifier (new:Identifier)

Element OperationDefinition.identifier has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.identifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.identifier: http://hl7.org/fhir/StructureDefinition/artifact-identifier.

R5: OperationDefinition.versionAlgorithm[x] (new:Coding, string)

Element OperationDefinition.versionAlgorithm[x] has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

R5: OperationDefinition.title (new:string)

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

R5: OperationDefinition.copyright (new:markdown)

Element OperationDefinition.copyright has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.copyright has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.copyright: http://hl7.org/fhir/StructureDefinition/artifact-copyright.

R5: OperationDefinition.copyrightLabel (new:string)

Element OperationDefinition.copyrightLabel has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.copyrightLabel has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element OperationDefinition.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

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

Element OperationDefinition.inputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.inputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

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

Element OperationDefinition.outputProfile has a context of OperationDefinition based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.outputProfile has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

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

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.

An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see Technical and Business Versions.

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.

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

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.

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

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.

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.

Support human navigation and code generation.

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

Allows filtering of operation definitions that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired operation definition without due consideration.

The lifecycle status of a Value Set or Concept Map.

Whether this is an operation or a named query.

Named queries are invoked differently, and have different capabilities.

Whether an operation is a normal operation or a query.

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.

Allows filtering of operation definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental operation definition in production.

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

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

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.

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

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.

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

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

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

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

An Extension

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

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

See guidance around (not) making local changes to elements here.

The name of an individual to contact.

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

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

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

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

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

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

Assist in searching for appropriate content.

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

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

Countries and regions within which this artifact is targeted for use

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

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.

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

The name used to invoke the operation.

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

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

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

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

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

An Extension

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

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

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

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

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

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

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

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

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

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

The types on which this operation can be executed.

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

The codes SHALL be taken from ResourceType
(required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)

One of the resource types defined as part of FHIR.

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).

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).

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

The parameters for the operation/query.

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

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

An Extension

R5: OperationDefinition.parameter.scope (new:code)

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

R5: OperationDefinition.parameter.allowedType (new:code)

Element OperationDefinition.parameter.allowedType has a context of OperationDefinition.parameter based on following the parent source element upwards and mapping to OperationDefinition. Element OperationDefinition.parameter.allowedType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). In previous versions of FHIR, there was an extension for this: http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type

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

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

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

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.

The name of used to identify the parameter.

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.

Whether this is an input or an output parameter.

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

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

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

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

Describes the meaning or use of this parameter.

The type for this parameter.

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

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

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

Data types allowed to be used for search parameters.

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

An Extension

R5: OperationDefinition.parameter.searchType

Element OperationDefinition.parameter.searchType is mapped to FHIR STU3 element OperationDefinition.parameter.searchType as SourceIsBroaderThanTarget. Parameters that are search parameter usually - but not always - are also defined for use with general searches, and function in the operation to filter the set of resources in scope for the operation just like the do when searching. The searchType describes how the server processes the value. For an example, see the Evaluate Measure Operation

Primitive value for code

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

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

An Extension

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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.

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.

For further discussion, see Using Terminologies.

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

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

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

The parts of a nested Parameter.

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

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

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

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

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

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.

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

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.

Name of parameter to include in overload.

Comments to go on overload.