{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/Resource","contact":[{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg"}]}],"date":"2026-03-31T17:43:31+00:00","derivation":"specialization","description":"This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources except as described in the definition of the Parameters resource.","differential":{"element":[{"comment":"The parameters that may be used are defined by the OperationDefinition resource.","definition":"This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources.","id":"Parameters","isModifier":false,"mapping":[{"identity":"w5","map":"infrastructure.exchange"},{"identity":"v2","map":"n/a"},{"identity":"rim","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Parameters","short":"Operation Request or Response"},{"constraint":[{"expression":"(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))","human":"A parameter must have one and only one of (value, resource, part)","key":"inv-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Parameters"}],"definition":"A parameter passed to or received from the operation.","id":"Parameters.parameter","isModifier":false,"isSummary":true,"max":"*","min":0,"mustSupport":false,"path":"Parameters.parameter","short":"Operation Parameter","type":[{"code":"BackboneElement"}]},{"definition":"The name of the parameter (reference to the operation definition).","id":"Parameters.parameter.name","isModifier":false,"isSummary":true,"max":"1","min":1,"mustSupport":false,"path":"Parameters.parameter.name","short":"Name from the definition","type":[{"code":"string"}]},{"condition":["inv-1"],"definition":"Conveys the content if the parameter is a data type.","id":"Parameters.parameter.value[x]","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Parameters.parameter.value[x]","short":"If parameter is a data type","type":[{"code":"base64Binary"},{"code":"boolean"},{"code":"canonical"},{"code":"code"},{"code":"date"},{"code":"dateTime"},{"code":"decimal"},{"code":"id"},{"code":"instant"},{"code":"integer"},{"code":"integer64"},{"code":"markdown"},{"code":"oid"},{"code":"positiveInt"},{"code":"string"},{"code":"time"},{"code":"unsignedInt"},{"code":"uri"},{"code":"url"},{"code":"uuid"},{"code":"Address"},{"code":"Age"},{"code":"Annotation"},{"code":"Attachment"},{"code":"CodeableConcept"},{"code":"CodeableReference"},{"code":"Coding"},{"code":"ContactPoint"},{"code":"Count"},{"code":"Distance"},{"code":"Duration"},{"code":"HumanName"},{"code":"Identifier"},{"code":"Money"},{"code":"Period"},{"code":"Quantity"},{"code":"Range"},{"code":"Ratio"},{"code":"RatioRange"},{"code":"Reference"},{"code":"SampledData"},{"code":"Signature"},{"code":"Timing"},{"code":"ContactDetail"},{"code":"DataRequirement"},{"code":"Expression"},{"code":"ParameterDefinition"},{"code":"RelatedArtifact"},{"code":"TriggerDefinition"},{"code":"UsageContext"},{"code":"Availability"},{"code":"ExtendedContactDetail"},{"code":"VirtualServiceDetail"},{"code":"Dosage"},{"code":"Meta"}]},{"comment":"This may be a resource defined in the FHIR specification, or an [additional resource](resource.html#additional). When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.","condition":["inv-1"],"definition":"Conveys the content if the parameter is a whole resource.","id":"Parameters.parameter.resource","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Parameters.parameter.resource","short":"If parameter is a whole resource","type":[{"code":"Resource"}]},{"condition":["inv-1"],"contentReference":"#Parameters.parameter","definition":"A named part of a multi-part parameter.","id":"Parameters.parameter.part","isModifier":false,"isSummary":true,"max":"*","min":0,"mustSupport":false,"path":"Parameters.parameter.part","short":"Named part of a multi-part parameter"}]},"experimental":false,"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version","valueCode":"4.0.0"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":5}],"fhirVersion":"6.0.0-ballot4","id":"Parameters","jurisdiction":[{"coding":[{"code":"001","display":"World","system":"http://unstats.un.org/unsd/methods/m49/m49.htm"}]}],"kind":"resource","mapping":[{"identity":"w5","name":"FiveWs Pattern Mapping","uri":"http://hl7.org/fhir/fivews"},{"identity":"v2","name":"HL7 V2 Mapping","uri":"http://hl7.org/v2"},{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"}],"meta":{"lastUpdated":"2026-03-31T17:43:31.836+00:00"},"name":"Parameters","publisher":"HL7 International / FHIR Infrastructure","resourceType":"StructureDefinition","snapshot":{"element":[{"base":{"max":"*","min":0,"path":"Parameters"},"comment":"The parameters that may be used are defined by the OperationDefinition resource.","definition":"This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources.","id":"Parameters","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity. Role, or Act,n/a"},{"identity":"w5","map":"infrastructure.exchange"},{"identity":"v2","map":"n/a"}],"max":"*","min":0,"mustSupport":false,"path":"Parameters","short":"Operation Request or Response"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"Parameters.id","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Parameters.id","short":"Logical id of this artifact","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"id"}]}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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.","id":"Parameters.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Parameters.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"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 its narrative along with other profiles, value sets, etc.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.","id":"Parameters.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Parameters.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}],"description":"IETF language tag for a human language","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot4"},"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The base language in which the resource is written.","id":"Parameters.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"Parameters.language","short":"Language of the resource content","type":[{"code":"code"}]},{"base":{"max":"*","min":0,"path":"Parameters.parameter"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children or both","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"},{"expression":"(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))","human":"A parameter must have one and only one of (value, resource, part)","key":"inv-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Parameters"}],"definition":"A parameter passed to or received from the operation.","id":"Parameters.parameter","isModifier":false,"isSummary":true,"max":"*","min":0,"mustSupport":false,"path":"Parameters.parameter","short":"Operation Parameter","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Parameters.parameter.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Parameters.parameter.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 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.","id":"Parameters.parameter.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Parameters.parameter.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).","id":"Parameters.parameter.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"Parameters.parameter.modifierExtension","requirements":"Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":1,"path":"Parameters.parameter.name"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The name of the parameter (reference to the operation definition).","id":"Parameters.parameter.name","isModifier":false,"isSummary":true,"max":"1","min":1,"mustSupport":false,"path":"Parameters.parameter.name","short":"Name from the definition","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"Parameters.parameter.value[x]"},"condition":["inv-1"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Conveys the content if the parameter is a data type.","id":"Parameters.parameter.value[x]","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Parameters.parameter.value[x]","short":"If parameter is a data type","type":[{"code":"base64Binary"},{"code":"boolean"},{"code":"canonical"},{"code":"code"},{"code":"date"},{"code":"dateTime"},{"code":"decimal"},{"code":"id"},{"code":"instant"},{"code":"integer"},{"code":"integer64"},{"code":"markdown"},{"code":"oid"},{"code":"positiveInt"},{"code":"string"},{"code":"time"},{"code":"unsignedInt"},{"code":"uri"},{"code":"url"},{"code":"uuid"},{"code":"Address"},{"code":"Age"},{"code":"Annotation"},{"code":"Attachment"},{"code":"CodeableConcept"},{"code":"CodeableReference"},{"code":"Coding"},{"code":"ContactPoint"},{"code":"Count"},{"code":"Distance"},{"code":"Duration"},{"code":"HumanName"},{"code":"Identifier"},{"code":"Money"},{"code":"Period"},{"code":"Quantity"},{"code":"Range"},{"code":"Ratio"},{"code":"RatioRange"},{"code":"Reference"},{"code":"SampledData"},{"code":"Signature"},{"code":"Timing"},{"code":"ContactDetail"},{"code":"DataRequirement"},{"code":"Expression"},{"code":"ParameterDefinition"},{"code":"RelatedArtifact"},{"code":"TriggerDefinition"},{"code":"UsageContext"},{"code":"Availability"},{"code":"ExtendedContactDetail"},{"code":"VirtualServiceDetail"},{"code":"Dosage"},{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Parameters.parameter.resource"},"comment":"This may be a resource defined in the FHIR specification, or an [additional resource](resource.html#additional). When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.","condition":["inv-1"],"definition":"Conveys the content if the parameter is a whole resource.","id":"Parameters.parameter.resource","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"Parameters.parameter.resource","short":"If parameter is a whole resource","type":[{"code":"Resource"}]},{"base":{"max":"*","min":0,"path":"Parameters.parameter.part"},"condition":["inv-1"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"contentReference":"#Parameters.parameter","definition":"A named part of a multi-part parameter.","id":"Parameters.parameter.part","isModifier":false,"isSummary":true,"max":"*","min":0,"mustSupport":false,"path":"Parameters.parameter.part","short":"Named part of a multi-part parameter"}]},"status":"active","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Parameters NResourceOperation Request or Response

Elements defined in Ancestors: id, meta, implicitRules, language
\".\"\".\"\".\" parameter ΣC0..*BackboneElementOperation Parameter
+ Rule: A parameter must have one and only one of (value, resource, part)

\".\"\".\"\".\"\".\" name Σ1..1stringName from the definition
\".\"\".\"\".\"\".\" value[x] ΣC0..1*If parameter is a data type
\".\"\".\"\".\"\".\" resource ΣC0..1ResourceIf parameter is a whole resource
\".\"\".\"\".\"\".\" part ΣC0..*see parameterNamed part of a multi-part parameter


\"doco\" Documentation for this format
","status":"generated"},"type":"Parameters","url":"http://hl7.org/fhir/StructureDefinition/Parameters","version":"6.0.0-ballot4"}