Generated Narrative: StructureDefinition ti-operationdefinition Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> OperationDefinition <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( op-affectsState-vs-method )">C 0..* OperationDefinition Definition of an operation or a named query Constraints: op-affectsState-vs-method #xD; meta S 0..1 Meta Metadata about the resource #xD; versionId S 0..1 id Version specific identifier #xD; lastUpdated S 0..1 instant When the resource version last changed #xD; Slices for extension Content/Rules for all slices #xD; extension:method S 0..2 code HTTP Method for FHIR Operation URL: https://gematik.de/fhir/ti/StructureDefinition/extension-http-method Binding: HTTPVerb (required) #xD; kind S 1..1 code operation | query #xD; affectsState S 0..1 boolean Whether content is changed by the operation #xD; code S 1..1 code Name used to invoke the operation #xD; system S 1..1 boolean Invoke at the system level? #xD; type S 1..1 boolean Invoke at the type level? #xD; instance S 1..1 boolean Invoke on an instance? #xD; inputProfile S 0..1 canonical(StructureDefinition) Validation information for in parameters #xD; outputProfile S 0..1 canonical(StructureDefinition) Validation information for out parameters #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
OperationDefinition Profil für TI FHIR Data Service
Dieses Profil beschreibt FHIR Operationen des FHIR Data Service innerhalb der Telematikinfrastruktur (TI). Es stellt sicher, dass zustandsverändernde Operationen (`affectsState = true`) nicht über HTTP GET ausgeführt werden dürfen.
Definition of an operation or a named query
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Name should be usable as an identifier for the module by machine processing applications such as code generation
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
Wenn affectsState = true, darf keine http-method Extension GET enthalten.
affectsState != true or extension.where(url = 'https://gematik.de/fhir/ti/StructureDefinition/http-method').all(value != 'GET')
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 might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
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.
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.
When the resource last changed - e.g. when the version changed.
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](http://hl7.org/fhir/R4/http.html#read) interaction.
Identifies where the resource comes from
A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) 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.
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.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).
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.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
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.
Security Labels from the Healthcare Privacy and Security Classification System.
CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
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.
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.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
A set of rules under which this content was created
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.
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.
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
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).
Text summary of the resource, for human interpretation
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.
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.
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
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.
Gibt an, ob eine FHIR Operation mit GET, POST oder beidem verwendet werden darf.
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).
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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this operation definition, represented as a URI (globally unique)
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.
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](http://hl7.org/fhir/R4/resource.html#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](http://hl7.org/fhir/R4/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the operation definition to be referenced by a single globally unique identifier.
Business version of the operation 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.
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].
Name for this operation definition (computer friendly)
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 alphanumeric type name to ensure that it is machine-processing friendly.
Support human navigation and code generation.
Name for this operation definition (human friendly)
A short, descriptive, user-friendly title for the operation definition.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
The status of this operation definition. Enables tracking the life-cycle of the content.
Allows filtering of operation definitions that are appropriate for use versus not.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
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.
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 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.
Name of the publisher (organization or individual)
The name of the organization or individual 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.
Natural language description of the operation definition
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 operation definition is presumed to be the predominant language in the place the operation definition was created).
The context that the content is intended to support
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.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for operation definition (if applicable)
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.
fhir:CodeableConcept rdfs:subClassOf dt:CD
Why this operation definition is defined
Explanation 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.
Whether content is changed by the operation
Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
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.
Additional information about how to use this operation or named query.
Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
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.
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.
One of the resource types defined as part of this version 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.
Validation information for in parameters
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.
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.
Validation information for out parameters
Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.
Either a type must be provided, or parts
A search type can only be specified for parameters of type string
searchType.exists() implies type = 'string'
not(exists(f:searchType)) or (f:type/@value = 'string')
A targetProfile can only be specified for parameters of type Reference or Canonical
targetProfile.exists() implies (type = 'Reference' or type = 'canonical')
not(exists(f:targetProfile)) or ((f:type/@value = 'Reference') or (f:type/@value = 'canonical'))
Extensions that cannot be ignored even if unrecognized
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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Name in Parameters.parameter.name or in URL
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.
32 bit number; for values larger than this, use decimal
The maximum number of times this element is permitted to appear in the request or response.
Note that FHIR strings SHALL NOT exceed 1MB in size
Describes the meaning or use of 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.
A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
If type is Reference | canonical, allowed targets
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.
Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).
number | date | string | token | reference | composite | quantity | uri | special
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.
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
required | extensible | preferred | example
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](http://hl7.org/fhir/R4/terminologies.html).
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.
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.
Resolution applies if the referenced parameter exists.
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.
The id of the element in the referencing resource that is expected to resolve to this resource.
Define overloaded variants for when generating code
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.
Name of parameter to include in overload
Name of parameter to include in overload.