Release 5
ConformanceThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
This is a representation of the json schema for OperationDefinition, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/OperationDefinition",
"$ref": "#/definitions/OperationDefinition",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"OperationDefinition": {
"description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"properties": {
"resourceType": {
"description": "This is a OperationDefinition resource",
"const": "OperationDefinition"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"name": {
"description": "A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the operation definition.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The current state of this operation definition.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "The date (and optionally time) when the operation definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the operation definition.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the operation definition from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the operation definition is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this operation definition is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "A copyright statement relating to the operation definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the operation definition.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "Element.schema.json#/definitions/Element"
},
"kind": {
"description": "Whether this is an operation or a named query.",
"$ref": "#/definitions/code"
},
"_kind": {
"description": "Extensions for kind",
"$ref": "Element.schema.json#/definitions/Element"
},
"affectsState": {
"description": "Whether the operation affects state. Side effects such as producing audit trail entries do not count as \u0027affecting state\u0027.",
"$ref": "#/definitions/boolean"
},
"_affectsState": {
"description": "Extensions for affectsState",
"$ref": "Element.schema.json#/definitions/Element"
},
"code": {
"description": "The label that is recommended to be used in the URL for this operation. In some cases, servers may need to use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the same code.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"comment": {
"description": "Additional information about how to use this operation or named query.",
"$ref": "#/definitions/markdown"
},
"_comment": {
"description": "Extensions for comment",
"$ref": "Element.schema.json#/definitions/Element"
},
"base": {
"description": "Indicates that this operation definition is a constraining profile on the base.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"resource": {
"description": "The types on which this operation can be executed.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_resource": {
"description": "Extensions for resource",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"system": {
"description": "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).",
"$ref": "#/definitions/boolean"
},
"_system": {
"description": "Extensions for system",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).",
"$ref": "#/definitions/boolean"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"instance": {
"description": "Indicates whether this operation can be invoked on a particular instance of one of the given types.",
"$ref": "#/definitions/boolean"
},
"_instance": {
"description": "Extensions for instance",
"$ref": "Element.schema.json#/definitions/Element"
},
"inputProfile": {
"description": "Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"outputProfile": {
"description": "Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"parameter": {
"description": "The parameters for the operation/query.",
"items": {
"$ref": "#/definitions/OperationDefinition_Parameter"
},
"type": "array"
},
"overload": {
"description": "Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.",
"items": {
"$ref": "#/definitions/OperationDefinition_Overload"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"OperationDefinition_Parameter": {
"description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The name of used to identify the parameter.",
"$ref": "#/definitions/code"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"use": {
"description": "Whether this is an input or an output parameter.",
"$ref": "#/definitions/code"
},
"_use": {
"description": "Extensions for use",
"$ref": "Element.schema.json#/definitions/Element"
},
"scope": {
"description": "If present, indicates that the parameter applies when the operation is being invoked at the specified level.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_scope": {
"description": "Extensions for scope",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"min": {
"description": "The minimum number of times this parameter SHALL appear in the request or response.",
"$ref": "#/definitions/integer"
},
"_min": {
"description": "Extensions for min",
"$ref": "Element.schema.json#/definitions/Element"
},
"max": {
"description": "The maximum number of times this element is permitted to appear in the request or response.",
"$ref": "#/definitions/string"
},
"_max": {
"description": "Extensions for max",
"$ref": "Element.schema.json#/definitions/Element"
},
"documentation": {
"description": "Describes the meaning or use of this parameter.",
"$ref": "#/definitions/markdown"
},
"_documentation": {
"description": "Extensions for documentation",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The type for this parameter.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"allowedType": {
"description": "Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_allowedType": {
"description": "Extensions for allowedType",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"targetProfile": {
"description": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"searchType": {
"description": "How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string.",
"$ref": "#/definitions/code"
},
"_searchType": {
"description": "Extensions for searchType",
"$ref": "Element.schema.json#/definitions/Element"
},
"binding": {
"description": "Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).",
"$ref": "#/definitions/OperationDefinition_Binding"
},
"referencedFrom": {
"description": "Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.",
"items": {
"$ref": "#/definitions/OperationDefinition_ReferencedFrom"
},
"type": "array"
},
"part": {
"description": "The parts of a nested Parameter.",
"items": {
"$ref": "#/definitions/OperationDefinition_Parameter"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"OperationDefinition_Binding": {
"description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"strength": {
"description": "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.",
"$ref": "#/definitions/code"
},
"_strength": {
"description": "Extensions for strength",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueSet": {
"description": "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.",
"$ref": "canonical.schema.json#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"valueSet"
]
},
"OperationDefinition_ReferencedFrom": {
"description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"source": {
"description": "The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.",
"$ref": "#/definitions/string"
},
"_source": {
"description": "Extensions for source",
"$ref": "Element.schema.json#/definitions/Element"
},
"sourceId": {
"description": "The id of the element in the referencing resource that is expected to resolve to this resource.",
"$ref": "#/definitions/string"
},
"_sourceId": {
"description": "Extensions for sourceId",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"OperationDefinition_Overload": {
"description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"parameterName": {
"description": "Name of parameter to include in overload.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_parameterName": {
"description": "Extensions for parameterName",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"comment": {
"description": "Comments to go on overload.",
"$ref": "#/definitions/string"
},
"_comment": {
"description": "Extensions for comment",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:25+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change