STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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
{
"resourceType": "StructureDefinition",
"id": "OperationDefinition",
"meta": {
"lastUpdated": "2016-03-31T08:01:25.570+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"name": "OperationDefinition",
"status": "draft",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"date": "2016-03-31T08:01:25+11:00",
"description": "Base StructureDefinition for OperationDefinition Resource",
"fhirVersion": "1.4.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"baseType": "DomainResource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"path": "OperationDefinition",
"short": "Definition of an operation or a named query",
"definition": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.behavior"
}
]
},
{
"path": "OperationDefinition.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "OperationDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "OperationDefinition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "OperationDefinition.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.extension",
"short": "Additional Content defined by implementations",
"definition": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.url",
"short": "Logical URL to reference this operation definition",
"definition": "An absolute URL 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.",
"comments": "Can be a urn:uuid: or a urn:oid:.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "OperationDefinition.version",
"short": "Logical id for this version of the operation definition",
"definition": "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": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"path": "OperationDefinition.name",
"short": "Informal name for this operation",
"definition": "A free text natural language name identifying the operation.",
"comments": "Not expected to be globally unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.status",
"short": "draft | active | retired",
"definition": "The status of the profile.",
"requirements": "Allows filtering of profiles that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conformance-resource-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "OperationDefinition.kind",
"short": "operation | query",
"definition": "Whether this is an operation or a named query.",
"comments": "Named queries are invoked differently, and have different capabilities.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Whether an operation is a normal operation or a query.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/operation-kind"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "OperationDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"requirements": "Allows filtering of profiles that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.date",
"short": "Date for this version of the operation definition",
"definition": "The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.",
"comments": "Additional specific dates may be added as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"path": "OperationDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the operation definition.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the operation definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"path": "OperationDefinition.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.contact.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.contact.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.contact.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact regarding the operation definition.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.description",
"short": "Natural language description of the operation",
"definition": "A free text natural language description of the profile and its use.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.useContext",
"short": "Content intends to support these contexts",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of operation definitions.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/use-context"
}
}
},
{
"path": "OperationDefinition.requirements",
"short": "Why this resource has been created",
"definition": "Explains why this operation definition is needed and why it's been constrained as it has.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.idempotent",
"short": "Whether content is unchanged by the operation",
"definition": "Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.code",
"short": "Name used to invoke the operation",
"definition": "The name used to invoke the operation.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.comment",
"short": "Additional information about use",
"definition": "Additional information about how to use this operation or named query.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.base",
"short": "Marks this as a profile of the base",
"definition": "Indicates that this operation definition is a constraining profile on the base.",
"comments": "A constrained profile can make optional parameters required or not used and clarify documentation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"
]
}
]
},
{
"path": "OperationDefinition.system",
"short": "Invoke at the system level?",
"definition": "Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.type",
"short": "Invoke at resource level for these type",
"definition": "Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"path": "OperationDefinition.instance",
"short": "Invoke on an instance?",
"definition": "Indicates whether this operation can be invoked on a particular instance of one of the given types.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "parameter",
"path": "OperationDefinition.parameter",
"short": "Parameters for the operation/query",
"definition": "The parameters for the operation/query.",
"comments": "Query Definitions only have one output parameter, named \"result\". This may not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "opd-1",
"severity": "error",
"human": "Either a type must be provided, or parts",
"expression": "type or part",
"xpath": "exists(f:type) or exists(f:part)"
},
{
"key": "opd-2",
"severity": "error",
"human": "A search type can only be specified for parameters of type string",
"expression": "searchType implies type = 'string'",
"xpath": "not(exists(f:searchType)) or (f:type/@value = 'string')"
}
]
},
{
"path": "OperationDefinition.parameter.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.parameter.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.parameter.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.parameter.name",
"short": "Name in Parameters.parameter.name or in URL",
"definition": "The name of used to identify the parameter.",
"comments": "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.parameter.use",
"short": "in | out",
"definition": "Whether this is an input or an output parameter.",
"comments": "If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Whether an operation parameter is an input or an output parameter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/operation-parameter-use"
}
}
},
{
"path": "OperationDefinition.parameter.min",
"short": "Minimum Cardinality",
"definition": "The minimum number of times this parameter SHALL appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "OperationDefinition.parameter.max",
"short": "Maximum Cardinality (a number or *)",
"definition": "The maximum number of times this element is permitted to appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.documentation",
"short": "Description of meaning/use",
"definition": "Describes the meaning or use of this parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.type",
"short": "What type this parameter has",
"definition": "The type for this parameter.",
"comments": "if there is no stated parameter, then the parameter is a \"Tuple\" type and must have at least one part defined.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"opd-1"
],
"binding": {
"strength": "required",
"description": "Either an abstract type, a resource or a data type.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-types"
}
}
},
{
"path": "OperationDefinition.parameter.searchType",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"opd-2"
],
"binding": {
"strength": "required",
"description": "Data types allowed to be used for search parameters.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-param-type"
}
}
},
{
"path": "OperationDefinition.parameter.profile",
"short": "Profile on the type",
"definition": "A profile the specifies the rules that this parameter must conform to.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"path": "OperationDefinition.parameter.binding",
"short": "ValueSet details if this is coded",
"definition": "Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"path": "OperationDefinition.parameter.binding.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.parameter.binding.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.parameter.binding.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.parameter.binding.strength",
"short": "required | extensible | preferred | example",
"definition": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.",
"comments": "For further discussion, see [[[Using Terminologies]]].",
"alias": [
"conformance",
"extensibility"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Indication of the degree of conformance expectations associated with a binding.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/binding-strength"
}
}
},
{
"path": "OperationDefinition.parameter.binding.valueSet[x]",
"short": "Source of value set",
"definition": "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.",
"comments": "For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/ValueSet"
]
}
]
},
{
"path": "OperationDefinition.parameter.part",
"short": "Parts of a Tuple Parameter",
"definition": "The parts of a Tuple Parameter.",
"comments": "Query Definitions only have one output parameter, named \"result\". This may not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"contentReference": "#parameter",
"condition": [
"opd-1"
]
}
]
},
"differential": {
"element": [
{
"path": "OperationDefinition",
"short": "Definition of an operation or a named query",
"definition": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.behavior"
}
]
},
{
"path": "OperationDefinition.url",
"short": "Logical URL to reference this operation definition",
"definition": "An absolute URL 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.",
"comments": "Can be a urn:uuid: or a urn:oid:.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "OperationDefinition.version",
"short": "Logical id for this version of the operation definition",
"definition": "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": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"path": "OperationDefinition.name",
"short": "Informal name for this operation",
"definition": "A free text natural language name identifying the operation.",
"comments": "Not expected to be globally unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.status",
"short": "draft | active | retired",
"definition": "The status of the profile.",
"requirements": "Allows filtering of profiles that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conformance-resource-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "OperationDefinition.kind",
"short": "operation | query",
"definition": "Whether this is an operation or a named query.",
"comments": "Named queries are invoked differently, and have different capabilities.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Whether an operation is a normal operation or a query.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/operation-kind"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "OperationDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"requirements": "Allows filtering of profiles that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.date",
"short": "Date for this version of the operation definition",
"definition": "The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.",
"comments": "Additional specific dates may be added as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"path": "OperationDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the operation definition.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the operation definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"path": "OperationDefinition.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.contact.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact regarding the operation definition.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.description",
"short": "Natural language description of the operation",
"definition": "A free text natural language description of the profile and its use.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.useContext",
"short": "Content intends to support these contexts",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of operation definitions.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/use-context"
}
}
},
{
"path": "OperationDefinition.requirements",
"short": "Why this resource has been created",
"definition": "Explains why this operation definition is needed and why it's been constrained as it has.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.idempotent",
"short": "Whether content is unchanged by the operation",
"definition": "Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.code",
"short": "Name used to invoke the operation",
"definition": "The name used to invoke the operation.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.comment",
"short": "Additional information about use",
"definition": "Additional information about how to use this operation or named query.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.base",
"short": "Marks this as a profile of the base",
"definition": "Indicates that this operation definition is a constraining profile on the base.",
"comments": "A constrained profile can make optional parameters required or not used and clarify documentation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"
]
}
]
},
{
"path": "OperationDefinition.system",
"short": "Invoke at the system level?",
"definition": "Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.type",
"short": "Invoke at resource level for these type",
"definition": "Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"path": "OperationDefinition.instance",
"short": "Invoke on an instance?",
"definition": "Indicates whether this operation can be invoked on a particular instance of one of the given types.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "parameter",
"path": "OperationDefinition.parameter",
"short": "Parameters for the operation/query",
"definition": "The parameters for the operation/query.",
"comments": "Query Definitions only have one output parameter, named \"result\". This may not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "opd-1",
"severity": "error",
"human": "Either a type must be provided, or parts",
"expression": "type or part",
"xpath": "exists(f:type) or exists(f:part)"
},
{
"key": "opd-2",
"severity": "error",
"human": "A search type can only be specified for parameters of type string",
"expression": "searchType implies type = 'string'",
"xpath": "not(exists(f:searchType)) or (f:type/@value = 'string')"
}
]
},
{
"path": "OperationDefinition.parameter.name",
"short": "Name in Parameters.parameter.name or in URL",
"definition": "The name of used to identify the parameter.",
"comments": "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.parameter.use",
"short": "in | out",
"definition": "Whether this is an input or an output parameter.",
"comments": "If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Whether an operation parameter is an input or an output parameter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/operation-parameter-use"
}
}
},
{
"path": "OperationDefinition.parameter.min",
"short": "Minimum Cardinality",
"definition": "The minimum number of times this parameter SHALL appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "OperationDefinition.parameter.max",
"short": "Maximum Cardinality (a number or *)",
"definition": "The maximum number of times this element is permitted to appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.documentation",
"short": "Description of meaning/use",
"definition": "Describes the meaning or use of this parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.type",
"short": "What type this parameter has",
"definition": "The type for this parameter.",
"comments": "if there is no stated parameter, then the parameter is a \"Tuple\" type and must have at least one part defined.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"opd-1"
],
"binding": {
"strength": "required",
"description": "Either an abstract type, a resource or a data type.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-types"
}
}
},
{
"path": "OperationDefinition.parameter.searchType",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"opd-2"
],
"binding": {
"strength": "required",
"description": "Data types allowed to be used for search parameters.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-param-type"
}
}
},
{
"path": "OperationDefinition.parameter.profile",
"short": "Profile on the type",
"definition": "A profile the specifies the rules that this parameter must conform to.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"path": "OperationDefinition.parameter.binding",
"short": "ValueSet details if this is coded",
"definition": "Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"path": "OperationDefinition.parameter.binding.strength",
"short": "required | extensible | preferred | example",
"definition": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.",
"comments": "For further discussion, see [[[Using Terminologies]]].",
"alias": [
"conformance",
"extensibility"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Indication of the degree of conformance expectations associated with a binding.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/binding-strength"
}
}
},
{
"path": "OperationDefinition.parameter.binding.valueSet[x]",
"short": "Source of value set",
"definition": "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.",
"comments": "For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/ValueSet"
]
}
]
},
{
"path": "OperationDefinition.parameter.part",
"short": "Parts of a Tuple Parameter",
"definition": "The parts of a Tuple Parameter.",
"comments": "Query Definitions only have one output parameter, named \"result\". This may not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"contentReference": "#parameter",
"condition": [
"opd-1"
]
}
]
}
}
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 STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:09+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change