. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
StructureDefinition for operationdefinition
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="OperationDefinition"/> <meta> <lastUpdated value="2015-03-27T00:13:00.999+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/> <name value="OperationDefinition"/> <publisher value="HL7 FHIR Project (FHIR Management Group)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/> </telecom> </contact> <description value="Base StructureDefinition for OperationDefinition Resource"/> <status value="draft"/> <date value="2015-03-27T00:13:00+11:00"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <type value="resource"/> <abstract value="true"/> <snapshot> <element> <path value="OperationDefinition"/> <short value="Definition of an operation or a named query"/> <definition value="A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction)."/> <min value="1"/> <max value="1"/> <type> <code value="OperationDefinition"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="OperationDefinition.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="OperationDefinition.meta"/> <short value="Metadata about the resource"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="OperationDefinition.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="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 as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="OperationDefinition.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <strength value="required"/> <description value="A human language"/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="OperationDefinition.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="OperationDefinition.contained"/> <short value="Contained, inline Resources"/> <definition value="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."/> <comments value="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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="OperationDefinition.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="OperationDefinition.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="OperationDefinition.url"/> <short value="Logical url to reference this operation definition"/> <definition value="An absolute url that is used to identify this operation definition when it is referenced in a specification, model, design or an instance (should be globally unique uri)."/> <comments value="Can be a urn:uuid: or a urn:oid:."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> </element> <element> <path value="OperationDefinition.version"/> <short value="Logical id for this version of the operation definition"/> <definition value="The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp."/> <requirements value="There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.name"/> <short value="Informal name for this profile"/> <definition value="A free text natural language name identifying the Profile."/> <comments value="Not expected to be globally unique."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.publisher"/> <short value="Name of the publisher (Organization or individual)"/> <definition value="The name of the individual or organization that published the operation definition."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <requirements value="Helps establish the "authority/credibility" of the operation definition. May also allow for contact."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="OperationDefinition.contact"/> <short value="Contact details of the publisher"/> <definition value="Contacts to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number (tel:), etc."/> <min value="0"/> <max value="*"/> <isSummary value="true"/> </element> <element> <path value="OperationDefinition.contact.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="OperationDefinition.contact.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="OperationDefinition.contact.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="OperationDefinition.contact.name"/> <short value="Name of a individual to contact"/> <definition value="The name of an individual to contact regarding the operation definition."/> <comments value="If there is no named individual, the telecom is for the organization as a whole."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="OperationDefinition.contact.telecom"/> <short value="Contact details for individual or publisher"/> <definition value="Contact details for individual (if a name was provided) or the publisher."/> <min value="0"/> <max value="*"/> <type> <code value="ContactPoint"/> </type> <isSummary value="true"/> </element> <element> <path value="OperationDefinition.description"/> <short value="Natural language description of the operation"/> <definition value="A free text natural language description of the profile and its use."/> <comments value="This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the profile as conveyed in Profile.text. This item SHOULD be populated unless the information is available from context."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.requirements"/> <short value="Why is this needed?"/> <definition value="Explains why this operation definition is needed and why it's been constrained as it has."/> <comments value="This element does not describe the usage of the operation definition (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.status"/> <short value="draft | active | retired"/> <definition value="The status of the profile."/> <requirements value="Allows filtering of profiles that are appropriate for use vs. not."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ConformanceResourceStatus"/> <strength value="required"/> <description value="The lifecycle status of a Value Set or Concept Map"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/conformance-resource-status"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.experimental"/> <short value="If for testing purposes, not real usage"/> <definition value="This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <requirements value="Allows filtering of profiles that are appropriate for use vs. not."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="OperationDefinition.date"/> <short value="Date for this version of the operation definition"/> <definition value="The date that this version of the profile was published."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> </element> <element> <path value="OperationDefinition.kind"/> <short value="operation | query"/> <definition value="Whether this is operation or named query."/> <comments value="Named queries are invoked differently, and have different capabilities."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="OperationKind"/> <strength value="required"/> <description value="Whether an operation is a normal operation or a query"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/operation-kind"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.code"/> <short value="Name used to invoke the operation"/> <definition value="The name used to invoke the operation."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element> <path value="OperationDefinition.notes"/> <short value="Additional information about use"/> <definition value="Additional information about how to use this operation or named query."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.base"/> <short value="Marks this as a profile of the base"/> <definition value="Indicates that this operation definition is a constraining profile on the base."/> <comments value="A constrained profile can make optional parameters required or not used and clarify documentation."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/> </type> </element> <element> <path value="OperationDefinition.system"/> <short value="Invoke at the system level?"/> <definition value="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)."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="OperationDefinition.type"/> <short value="Invoke at resource level for these type"/> <definition value="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 resource type for the context)."/> <min value="0"/> <max value="*"/> <type> <code value="code"/> </type> <binding> <name value="ResourceType"/> <strength value="required"/> <description value="One of the resource types defined as part of FHIR"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/resource-types"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.instance"/> <short value="Invoke on an instance?"/> <definition value="Indicates whether this operation can be invoked on a particular instance of one of the given types."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="OperationDefinition.parameter"/> <short value="Parameters for the operation/query"/> <definition value="The parameters for the operation/query."/> <comments value="Query Definitions only have one output parameter, named "result". This may not be described, but can be to allow a profile to be defined."/> <min value="0"/> <max value="*"/> <constraint> <key value="opd-1"/> <name value="Tuple Parameteter"/> <severity value="error"/> <human value="Either a type must be provided, or parts"/> <xpath value="exists(f:type) or exists(f:part)"/> </constraint> </element> <element> <path value="OperationDefinition.parameter.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="OperationDefinition.parameter.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="OperationDefinition.parameter.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="OperationDefinition.parameter.name"/> <short value="Name of the parameter"/> <definition value="The name of used to identify the parameter."/> <comments value="This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element> <path value="OperationDefinition.parameter.use"/> <short value="in | out"/> <definition value="Whether this is an input or an output parameter."/> <comments value="If a parameter name is used for both an input and an output parameter, the parameter should be defined twice."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="OperationParameterUse"/> <strength value="required"/> <description value="Whether an operation parameter is an input or an output parameter"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/operation-parameter-use"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.parameter.min"/> <short value="Minimum Cardinality"/> <definition value="The minimum number of times this parameter SHALL appear in the request or response."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> </element> <element> <path value="OperationDefinition.parameter.max"/> <short value="Maximum Cardinality (a number or *)"/> <definition value="The maximum number of times this element is permitted to appear in the request or response."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.parameter.documentation"/> <short value="Description of meaning/use"/> <definition value="Describes the meaning or use of this parameter."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.parameter.type"/> <short value="What type this parameter hs"/> <definition value="The type for this parameter."/> <comments value="if there is no stated parameter, then the parameter is a "Tuple" type and must have at least one part defined."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <condition value="opd-1"/> <binding> <name value="OperationParameterType"/> <strength value="required"/> <description value="The type of a parameter"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/operation-definition-parameter-type"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.parameter.profile"/> <short value="Profile on the type"/> <definition value="A profile the specifies the rules that this parameter must conform to."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/> </type> </element> <element> <path value="OperationDefinition.parameter.part"/> <short value="Parts of a Tuple Parameter"/> <definition value="The parts of a Tuple Parameter."/> <comments value="Query Definitions only have one output parameter, named "result". This may not be described, but can be to allow a profile to be defined."/> <min value="0"/> <max value="*"/> <condition value="opd-1"/> </element> <element> <path value="OperationDefinition.parameter.part.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="OperationDefinition.parameter.part.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="OperationDefinition.parameter.part.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="OperationDefinition.parameter.part.name"/> <short value="Name of the parameter"/> <definition value="The name of used to identify the parameter."/> <comments value="This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element> <path value="OperationDefinition.parameter.part.min"/> <short value="Minimum Cardinality"/> <definition value="The minimum number of times this parameter SHALL appear in the request or response."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> </element> <element> <path value="OperationDefinition.parameter.part.max"/> <short value="Maximum Cardinality (a number or *)"/> <definition value="The maximum number of times this element is permitted to appear in the request or response."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.parameter.part.documentation"/> <short value="Description of meaning/use"/> <definition value="Describes the meaning or use of this parameter."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.parameter.part.type"/> <short value="What type this parameter hs"/> <definition value="The type for this parameter."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="OperationParameterType"/> <strength value="required"/> <description value="The type of a parameter"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/operation-definition-parameter-type"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.parameter.part.profile"/> <short value="Profile on the type"/> <definition value="A profile the specifies the rules that this parameter must conform to."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/> </type> </element> </snapshot> <differential> <element> <path value="OperationDefinition"/> <short value="Definition of an operation or a named query"/> <definition value="A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction)."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="OperationDefinition.url"/> <short value="Logical url to reference this operation definition"/> <definition value="An absolute url that is used to identify this operation definition when it is referenced in a specification, model, design or an instance (should be globally unique uri)."/> <comments value="Can be a urn:uuid: or a urn:oid:."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> </element> <element> <path value="OperationDefinition.version"/> <short value="Logical id for this version of the operation definition"/> <definition value="The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp."/> <requirements value="There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.name"/> <short value="Informal name for this profile"/> <definition value="A free text natural language name identifying the Profile."/> <comments value="Not expected to be globally unique."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.publisher"/> <short value="Name of the publisher (Organization or individual)"/> <definition value="The name of the individual or organization that published the operation definition."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <requirements value="Helps establish the "authority/credibility" of the operation definition. May also allow for contact."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="OperationDefinition.contact"/> <short value="Contact details of the publisher"/> <definition value="Contacts to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number (tel:), etc."/> <min value="0"/> <max value="*"/> <isSummary value="true"/> </element> <element> <path value="OperationDefinition.contact.name"/> <short value="Name of a individual to contact"/> <definition value="The name of an individual to contact regarding the operation definition."/> <comments value="If there is no named individual, the telecom is for the organization as a whole."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="OperationDefinition.contact.telecom"/> <short value="Contact details for individual or publisher"/> <definition value="Contact details for individual (if a name was provided) or the publisher."/> <min value="0"/> <max value="*"/> <type> <code value="ContactPoint"/> </type> <isSummary value="true"/> </element> <element> <path value="OperationDefinition.description"/> <short value="Natural language description of the operation"/> <definition value="A free text natural language description of the profile and its use."/> <comments value="This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the profile as conveyed in Profile.text. This item SHOULD be populated unless the information is available from context."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.requirements"/> <short value="Why is this needed?"/> <definition value="Explains why this operation definition is needed and why it's been constrained as it has."/> <comments value="This element does not describe the usage of the operation definition (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.status"/> <short value="draft | active | retired"/> <definition value="The status of the profile."/> <requirements value="Allows filtering of profiles that are appropriate for use vs. not."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ConformanceResourceStatus"/> <strength value="required"/> <description value="The lifecycle status of a Value Set or Concept Map"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/conformance-resource-status"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.experimental"/> <short value="If for testing purposes, not real usage"/> <definition value="This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <requirements value="Allows filtering of profiles that are appropriate for use vs. not."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="OperationDefinition.date"/> <short value="Date for this version of the operation definition"/> <definition value="The date that this version of the profile was published."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> </element> <element> <path value="OperationDefinition.kind"/> <short value="operation | query"/> <definition value="Whether this is operation or named query."/> <comments value="Named queries are invoked differently, and have different capabilities."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="OperationKind"/> <strength value="required"/> <description value="Whether an operation is a normal operation or a query"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/operation-kind"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.code"/> <short value="Name used to invoke the operation"/> <definition value="The name used to invoke the operation."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element> <path value="OperationDefinition.notes"/> <short value="Additional information about use"/> <definition value="Additional information about how to use this operation or named query."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.base"/> <short value="Marks this as a profile of the base"/> <definition value="Indicates that this operation definition is a constraining profile on the base."/> <comments value="A constrained profile can make optional parameters required or not used and clarify documentation."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/> </type> </element> <element> <path value="OperationDefinition.system"/> <short value="Invoke at the system level?"/> <definition value="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)."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="OperationDefinition.type"/> <short value="Invoke at resource level for these type"/> <definition value="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 resource type for the context)."/> <min value="0"/> <max value="*"/> <type> <code value="code"/> </type> <binding> <name value="ResourceType"/> <strength value="required"/> <description value="One of the resource types defined as part of FHIR"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/resource-types"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.instance"/> <short value="Invoke on an instance?"/> <definition value="Indicates whether this operation can be invoked on a particular instance of one of the given types."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="OperationDefinition.parameter"/> <short value="Parameters for the operation/query"/> <definition value="The parameters for the operation/query."/> <comments value="Query Definitions only have one output parameter, named "result". This may not be described, but can be to allow a profile to be defined."/> <min value="0"/> <max value="*"/> <constraint> <key value="opd-1"/> <name value="Tuple Parameteter"/> <severity value="error"/> <human value="Either a type must be provided, or parts"/> <xpath value="exists(f:type) or exists(f:part)"/> </constraint> </element> <element> <path value="OperationDefinition.parameter.name"/> <short value="Name of the parameter"/> <definition value="The name of used to identify the parameter."/> <comments value="This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element> <path value="OperationDefinition.parameter.use"/> <short value="in | out"/> <definition value="Whether this is an input or an output parameter."/> <comments value="If a parameter name is used for both an input and an output parameter, the parameter should be defined twice."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="OperationParameterUse"/> <strength value="required"/> <description value="Whether an operation parameter is an input or an output parameter"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/operation-parameter-use"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.parameter.min"/> <short value="Minimum Cardinality"/> <definition value="The minimum number of times this parameter SHALL appear in the request or response."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> </element> <element> <path value="OperationDefinition.parameter.max"/> <short value="Maximum Cardinality (a number or *)"/> <definition value="The maximum number of times this element is permitted to appear in the request or response."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.parameter.documentation"/> <short value="Description of meaning/use"/> <definition value="Describes the meaning or use of this parameter."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.parameter.type"/> <short value="What type this parameter hs"/> <definition value="The type for this parameter."/> <comments value="if there is no stated parameter, then the parameter is a "Tuple" type and must have at least one part defined."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <condition value="opd-1"/> <binding> <name value="OperationParameterType"/> <strength value="required"/> <description value="The type of a parameter"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/operation-definition-parameter-type"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.parameter.profile"/> <short value="Profile on the type"/> <definition value="A profile the specifies the rules that this parameter must conform to."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/> </type> </element> <element> <path value="OperationDefinition.parameter.part"/> <short value="Parts of a Tuple Parameter"/> <definition value="The parts of a Tuple Parameter."/> <comments value="Query Definitions only have one output parameter, named "result". This may not be described, but can be to allow a profile to be defined."/> <min value="0"/> <max value="*"/> <condition value="opd-1"/> </element> <element> <path value="OperationDefinition.parameter.part.name"/> <short value="Name of the parameter"/> <definition value="The name of used to identify the parameter."/> <comments value="This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element> <path value="OperationDefinition.parameter.part.min"/> <short value="Minimum Cardinality"/> <definition value="The minimum number of times this parameter SHALL appear in the request or response."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> </element> <element> <path value="OperationDefinition.parameter.part.max"/> <short value="Maximum Cardinality (a number or *)"/> <definition value="The maximum number of times this element is permitted to appear in the request or response."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.parameter.part.documentation"/> <short value="Description of meaning/use"/> <definition value="Describes the meaning or use of this parameter."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="OperationDefinition.parameter.part.type"/> <short value="What type this parameter hs"/> <definition value="The type for this parameter."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="OperationParameterType"/> <strength value="required"/> <description value="The type of a parameter"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/operation-definition-parameter-type"/> </valueSetReference> </binding> </element> <element> <path value="OperationDefinition.parameter.part.profile"/> <short value="Profile on the type"/> <definition value="A profile the specifies the rules that this parameter must conform to."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/> </type> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:21+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change