R4 Ballot #1 (Mixed Normative/Trial use)
ConformanceThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for operationdefinition
{
"resourceType": "StructureDefinition",
"id": "OperationDefinition",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"name": "OperationDefinition",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "OperationDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "OperationDefinition",
"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": "*",
"base": {
"path": "OperationDefinition",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Definition"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "OperationDefinition.id",
"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.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "OperationDefinition.meta",
"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 might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "OperationDefinition.implicitRules",
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "OperationDefinition.language",
"path": "OperationDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "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": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "OperationDefinition.text",
"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 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.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "OperationDefinition.contained",
"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.",
"comment": "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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "OperationDefinition.extension",
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "OperationDefinition.modifierExtension",
"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. 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.",
"comment": "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,
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "OperationDefinition.url",
"path": "OperationDefinition.url",
"short": "Canonical identifier for this operation definition, represented as a URI (globally unique)",
"definition": "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 this operation definition is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the operation definition to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "OperationDefinition.version",
"path": "OperationDefinition.version",
"short": "Business version of the operation definition",
"definition": "The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different operation definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format [url]|[version].",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
}
]
},
{
"id": "OperationDefinition.name",
"path": "OperationDefinition.name",
"short": "Name for this operation definition (computer friendly)",
"definition": "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.",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements": "Support human navigation and code generation.",
"min": 1,
"max": "1",
"base": {
"path": "OperationDefinition.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.title"
}
]
},
{
"id": "OperationDefinition.status",
"path": "OperationDefinition.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this operation definition. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of operation definitions that are appropriate for use versus not.",
"min": 1,
"max": "1",
"base": {
"path": "OperationDefinition.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status {different ValueSet}"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "OperationDefinition.kind",
"path": "OperationDefinition.kind",
"short": "operation | query",
"definition": "Whether this is an operation or a named query.",
"comment": "Named queries are invoked differently, and have different capabilities.",
"min": 1,
"max": "1",
"base": {
"path": "OperationDefinition.kind",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OperationKind"
}
],
"strength": "required",
"description": "Whether an operation is a normal operation or a query.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/operation-kind"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "OperationDefinition.experimental",
"path": "OperationDefinition.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of operation definitions that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level operation definition.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.experimental",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "OperationDefinition.date",
"path": "OperationDefinition.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "OperationDefinition.publisher",
"path": "OperationDefinition.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the operation definition.",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the operation definition. May also allow for contact.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.publisher",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
}
]
},
{
"id": "OperationDefinition.contact",
"path": "OperationDefinition.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.contact",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactDetail"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "OperationDefinition.description",
"path": "OperationDefinition.description",
"short": "Natural language description of the operation definition",
"definition": "A free text natural language description of the operation definition from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the operation definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
}
]
},
{
"id": "OperationDefinition.useContext",
"path": "OperationDefinition.useContext",
"short": "The context that the content is intended to support",
"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 for appropriate operation definition instances.",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.useContext",
"min": 0,
"max": "*"
},
"type": [
{
"code": "UsageContext"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "OperationDefinition.jurisdiction",
"path": "OperationDefinition.jurisdiction",
"short": "Intended jurisdiction for operation definition (if applicable)",
"definition": "A legal or geographic region in which the operation definition is intended to be used.",
"comment": "It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.jurisdiction",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "OperationDefinition.purpose",
"path": "OperationDefinition.purpose",
"short": "Why this operation definition is defined",
"definition": "Explanation of why this operation definition is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.purpose",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "OperationDefinition.affectsState",
"path": "OperationDefinition.affectsState",
"short": "Whether content is unchanged by the operation",
"definition": "Operations that have affects state = false (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.",
"comment": "Side effects such as producing audit trail entries do not count as 'changing state/content'.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.affectsState",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "OperationDefinition.code",
"path": "OperationDefinition.code",
"short": "Name used to invoke the operation",
"definition": "The name used to invoke the operation.",
"comment": "The code does not include the '$' prefix that is always included in the URL when the operation is invoked.",
"min": 1,
"max": "1",
"base": {
"path": "OperationDefinition.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "OperationDefinition.comment",
"path": "OperationDefinition.comment",
"short": "Additional information about use",
"definition": "Additional information about how to use this operation or named query.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.comment",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.base",
"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.",
"comment": "A constrained profile can make optional parameters required or not used and clarify documentation.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.base",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.derivedFrom"
}
]
},
{
"id": "OperationDefinition.resource",
"path": "OperationDefinition.resource",
"short": "Types this operation applies to",
"definition": "The types on which this operation can be executed.",
"comment": "If the type is an abstract resource (\"Resource\" or \"DomainResource\") then the operation can be invoked on any concrete specialization.",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.resource",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResourceType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "One of the resource types defined as part of this version of FHIR.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.subject[x]"
}
]
},
{
"id": "OperationDefinition.system",
"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",
"base": {
"path": "OperationDefinition.system",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "OperationDefinition.type",
"path": "OperationDefinition.type",
"short": "Invoke at the type level?",
"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 specific resource id for the context).",
"min": 1,
"max": "1",
"base": {
"path": "OperationDefinition.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "OperationDefinition.instance",
"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",
"base": {
"path": "OperationDefinition.instance",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "OperationDefinition.inputProfile",
"path": "OperationDefinition.inputProfile",
"short": "Validation information for in parameters",
"definition": "Additional validation information for the in parameters. The profile is a constraint on the parameters resource.",
"comment": "If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.).",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.inputProfile",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.outputProfile",
"path": "OperationDefinition.outputProfile",
"short": "Validation information for out parameters",
"definition": "Additional validation information for the out parameters. The profile is a constraint on the parameters resource.",
"comment": "If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.).",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.outputProfile",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter",
"path": "OperationDefinition.parameter",
"short": "Parameters for the operation/query",
"definition": "The parameters for the operation/query.",
"comment": "Query Definitions only have one output parameter, named \"result\". This might not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.parameter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "opd-1",
"severity": "error",
"human": "Either a type must be provided, or parts",
"expression": "type.exists() or part.exists()",
"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.exists() implies type = 'string'",
"xpath": "not(exists(f:searchType)) or (f:type/@value = 'string')"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter.id",
"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). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "OperationDefinition.parameter.extension",
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "OperationDefinition.parameter.modifierExtension",
"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 in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "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,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "OperationDefinition.parameter.name",
"path": "OperationDefinition.parameter.name",
"short": "Name in Parameters.parameter.name or in URL",
"definition": "The name of used to identify the parameter.",
"comment": "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.",
"min": 1,
"max": "1",
"base": {
"path": "OperationDefinition.parameter.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter.use",
"path": "OperationDefinition.parameter.use",
"short": "in | out",
"definition": "Whether this is an input or an output parameter.",
"comment": "If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.",
"min": 1,
"max": "1",
"base": {
"path": "OperationDefinition.parameter.use",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OperationParameterUse"
}
],
"strength": "required",
"description": "Whether an operation parameter is an input or an output parameter.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/operation-parameter-use"
}
},
{
"id": "OperationDefinition.parameter.min",
"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",
"base": {
"path": "OperationDefinition.parameter.min",
"min": 1,
"max": "1"
},
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter.max",
"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",
"base": {
"path": "OperationDefinition.parameter.max",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter.documentation",
"path": "OperationDefinition.parameter.documentation",
"short": "Description of meaning/use",
"definition": "Describes the meaning or use of this parameter.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.parameter.documentation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter.type",
"path": "OperationDefinition.parameter.type",
"short": "What type this parameter has",
"definition": "The type for this parameter.",
"comment": "if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.parameter.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"opd-1"
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRAllTypes"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/all-types"
}
},
{
"id": "OperationDefinition.parameter.targetProfile",
"path": "OperationDefinition.parameter.targetProfile",
"short": "If type is Reference, allowed targets",
"definition": "If the type is \"Reference\", then targetProfile lists a one or more profiles that the Reference can refer to.",
"comment": "Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.parameter.targetProfile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter.searchType",
"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",
"base": {
"path": "OperationDefinition.parameter.searchType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"opd-2"
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchParamType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "Data types allowed to be used for search parameters.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/search-param-type"
}
},
{
"id": "OperationDefinition.parameter.binding",
"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",
"base": {
"path": "OperationDefinition.parameter.binding",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter.binding.id",
"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). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "OperationDefinition.parameter.binding.extension",
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "OperationDefinition.parameter.binding.modifierExtension",
"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 in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "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,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "OperationDefinition.parameter.binding.strength",
"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.",
"comment": "For further discussion, see [Using Terminologies](terminologies.html).",
"alias": [
"conformance",
"extensibility"
],
"min": 1,
"max": "1",
"base": {
"path": "OperationDefinition.parameter.binding.strength",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BindingStrength"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "Indication of the degree of conformance expectations associated with a binding.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/binding-strength"
}
},
{
"id": "OperationDefinition.parameter.binding.valueSet[x]",
"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.",
"comment": "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",
"base": {
"path": "OperationDefinition.parameter.binding.valueSet[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
},
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ValueSet"
]
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.parameter.part",
"path": "OperationDefinition.parameter.part",
"short": "Parts of a nested Parameter",
"definition": "The parts of a nested Parameter.",
"comment": "Query Definitions only have one output parameter, named \"result\". This might not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.parameter.part",
"min": 0,
"max": "*"
},
"contentReference": "#OperationDefinition.parameter",
"condition": [
"opd-1"
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.overload",
"path": "OperationDefinition.overload",
"short": "Define overloaded variants for when generating code",
"definition": "Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.",
"comment": "The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.overload",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.overload.id",
"path": "OperationDefinition.overload.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "OperationDefinition.overload.extension",
"path": "OperationDefinition.overload.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "OperationDefinition.overload.modifierExtension",
"path": "OperationDefinition.overload.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 in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "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,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "OperationDefinition.overload.parameterName",
"path": "OperationDefinition.overload.parameterName",
"short": "Name of parameter to include in overload",
"definition": "Name of parameter to include in overload.",
"min": 0,
"max": "*",
"base": {
"path": "OperationDefinition.overload.parameterName",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "OperationDefinition.overload.comment",
"path": "OperationDefinition.overload.comment",
"short": "Comments to go on overload",
"definition": "Comments to go on overload.",
"min": 0,
"max": "1",
"base": {
"path": "OperationDefinition.overload.comment",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
}
]
},
"differential": {
"element": [
{
"id": "OperationDefinition",
"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": "*",
"mapping": [
{
"identity": "workflow",
"map": "Definition"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "OperationDefinition.url",
"path": "OperationDefinition.url",
"short": "Canonical identifier for this operation definition, represented as a URI (globally unique)",
"definition": "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 this operation definition is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the operation definition to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "OperationDefinition.version",
"path": "OperationDefinition.version",
"short": "Business version of the operation definition",
"definition": "The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different operation definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
}
]
},
{
"id": "OperationDefinition.name",
"path": "OperationDefinition.name",
"short": "Name for this operation definition (computer friendly)",
"definition": "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.",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements": "Support human navigation and code generation.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.title"
}
]
},
{
"id": "OperationDefinition.status",
"path": "OperationDefinition.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this operation definition. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of operation definitions that are appropriate for use versus not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status {different ValueSet}"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "OperationDefinition.kind",
"path": "OperationDefinition.kind",
"short": "operation | query",
"definition": "Whether this is an operation or a named query.",
"comment": "Named queries are invoked differently, and have different capabilities.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OperationKind"
}
],
"strength": "required",
"description": "Whether an operation is a normal operation or a query.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/operation-kind"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "OperationDefinition.experimental",
"path": "OperationDefinition.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of operation definitions that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level operation definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "OperationDefinition.date",
"path": "OperationDefinition.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "OperationDefinition.publisher",
"path": "OperationDefinition.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the operation definition.",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.",
"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": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
}
]
},
{
"id": "OperationDefinition.contact",
"path": "OperationDefinition.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "OperationDefinition.description",
"path": "OperationDefinition.description",
"short": "Natural language description of the operation definition",
"definition": "A free text natural language description of the operation definition from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the operation definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
}
]
},
{
"id": "OperationDefinition.useContext",
"path": "OperationDefinition.useContext",
"short": "The context that the content is intended to support",
"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 for appropriate operation definition instances.",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "OperationDefinition.jurisdiction",
"path": "OperationDefinition.jurisdiction",
"short": "Intended jurisdiction for operation definition (if applicable)",
"definition": "A legal or geographic region in which the operation definition is intended to be used.",
"comment": "It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "OperationDefinition.purpose",
"path": "OperationDefinition.purpose",
"short": "Why this operation definition is defined",
"definition": "Explanation of why this operation definition is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "OperationDefinition.affectsState",
"path": "OperationDefinition.affectsState",
"short": "Whether content is unchanged by the operation",
"definition": "Operations that have affects state = false (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.",
"comment": "Side effects such as producing audit trail entries do not count as 'changing state/content'.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "OperationDefinition.code",
"path": "OperationDefinition.code",
"short": "Name used to invoke the operation",
"definition": "The name used to invoke the operation.",
"comment": "The code does not include the '$' prefix that is always included in the URL when the operation is invoked.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true
},
{
"id": "OperationDefinition.comment",
"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": "markdown"
}
]
},
{
"id": "OperationDefinition.base",
"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.",
"comment": "A constrained profile can make optional parameters required or not used and clarify documentation.",
"min": 0,
"max": "1",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.derivedFrom"
}
]
},
{
"id": "OperationDefinition.resource",
"path": "OperationDefinition.resource",
"short": "Types this operation applies to",
"definition": "The types on which this operation can be executed.",
"comment": "If the type is an abstract resource (\"Resource\" or \"DomainResource\") then the operation can be invoked on any concrete specialization.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResourceType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "One of the resource types defined as part of this version of FHIR.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.subject[x]"
}
]
},
{
"id": "OperationDefinition.system",
"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"
}
],
"isSummary": true
},
{
"id": "OperationDefinition.type",
"path": "OperationDefinition.type",
"short": "Invoke at the type level?",
"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 specific resource id for the context).",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "OperationDefinition.instance",
"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"
}
],
"isSummary": true
},
{
"id": "OperationDefinition.inputProfile",
"path": "OperationDefinition.inputProfile",
"short": "Validation information for in parameters",
"definition": "Additional validation information for the in parameters. The profile is a constraint on the parameters resource.",
"comment": "If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.).",
"min": 0,
"max": "1",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"id": "OperationDefinition.outputProfile",
"path": "OperationDefinition.outputProfile",
"short": "Validation information for out parameters",
"definition": "Additional validation information for the out parameters. The profile is a constraint on the parameters resource.",
"comment": "If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.).",
"min": 0,
"max": "1",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"id": "OperationDefinition.parameter",
"path": "OperationDefinition.parameter",
"short": "Parameters for the operation/query",
"definition": "The parameters for the operation/query.",
"comment": "Query Definitions only have one output parameter, named \"result\". This might 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.exists() or part.exists()",
"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.exists() implies type = 'string'",
"xpath": "not(exists(f:searchType)) or (f:type/@value = 'string')"
}
]
},
{
"id": "OperationDefinition.parameter.name",
"path": "OperationDefinition.parameter.name",
"short": "Name in Parameters.parameter.name or in URL",
"definition": "The name of used to identify the parameter.",
"comment": "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "OperationDefinition.parameter.use",
"path": "OperationDefinition.parameter.use",
"short": "in | out",
"definition": "Whether this is an input or an output parameter.",
"comment": "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": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OperationParameterUse"
}
],
"strength": "required",
"description": "Whether an operation parameter is an input or an output parameter.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/operation-parameter-use"
}
},
{
"id": "OperationDefinition.parameter.min",
"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"
}
]
},
{
"id": "OperationDefinition.parameter.max",
"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"
}
]
},
{
"id": "OperationDefinition.parameter.documentation",
"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"
}
]
},
{
"id": "OperationDefinition.parameter.type",
"path": "OperationDefinition.parameter.type",
"short": "What type this parameter has",
"definition": "The type for this parameter.",
"comment": "if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"opd-1"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRAllTypes"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/all-types"
}
},
{
"id": "OperationDefinition.parameter.targetProfile",
"path": "OperationDefinition.parameter.targetProfile",
"short": "If type is Reference, allowed targets",
"definition": "If the type is \"Reference\", then targetProfile lists a one or more profiles that the Reference can refer to.",
"comment": "Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).",
"min": 0,
"max": "*",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"id": "OperationDefinition.parameter.searchType",
"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": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchParamType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "Data types allowed to be used for search parameters.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/search-param-type"
}
},
{
"id": "OperationDefinition.parameter.binding",
"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"
}
]
},
{
"id": "OperationDefinition.parameter.binding.strength",
"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.",
"comment": "For further discussion, see [Using Terminologies](terminologies.html).",
"alias": [
"conformance",
"extensibility"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BindingStrength"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "Indication of the degree of conformance expectations associated with a binding.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/binding-strength"
}
},
{
"id": "OperationDefinition.parameter.binding.valueSet[x]",
"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.",
"comment": "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": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ValueSet"
]
}
]
},
{
"id": "OperationDefinition.parameter.part",
"path": "OperationDefinition.parameter.part",
"short": "Parts of a nested Parameter",
"definition": "The parts of a nested Parameter.",
"comment": "Query Definitions only have one output parameter, named \"result\". This might not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"contentReference": "#OperationDefinition.parameter",
"condition": [
"opd-1"
]
},
{
"id": "OperationDefinition.overload",
"path": "OperationDefinition.overload",
"short": "Define overloaded variants for when generating code",
"definition": "Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.",
"comment": "The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "OperationDefinition.overload.parameterName",
"path": "OperationDefinition.overload.parameterName",
"short": "Name of parameter to include in overload",
"definition": "Name of parameter to include in overload.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "OperationDefinition.overload.comment",
"path": "OperationDefinition.overload.comment",
"short": "Comments to go on overload",
"definition": "Comments to go on overload.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}
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 Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:17+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change