ParameterDefinition.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="ParameterDefinition" /> 4 <meta> 5 <lastUpdated value="2023-03-26T06:21:02.749+02:00" /> 6 </meta> 7 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 8 <valueCode value="trial-use" /> 9 </extension> 10 <url value="http://hl7.org/fhir/StructureDefinition/ParameterDefinition" /> 11 <version value="5.0.0" /> 12 <name value="ParameterDefinition" /> 13 <status value="draft" /> 14 <experimental value="false" /> 15 <date value="2023-03-26T06:21:02.0000000+02:00" /> 16 <publisher value="HL7 FHIR Standard" /> 17 <contact> 18 <telecom> 19 <system value="url" /> 20 <value value="http://hl7.org/fhir" /> 21 </telecom> 22 </contact> 23 <description value="ParameterDefinition Type: The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse." /> 24 <jurisdiction> 25 <coding> 26 <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" /> 27 <code value="001" /> 28 <display value="World" /> 29 </coding> 30 </jurisdiction> 31 <fhirVersion value="5.0.0" /> 32 <mapping> 33 <identity value="rim" /> 34 <uri value="http://hl7.org/v3" /> 35 <name value="RIM Mapping" /> 36 </mapping> 37 <kind value="complex-type" /> 38 <abstract value="false" /> 39 <type value="ParameterDefinition" /> 40 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType" /> 41 <derivation value="specialization" /> 42 <snapshot> 43 <element id="ParameterDefinition"> 44 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 45 <valueCode value="trial-use" /> 46 </extension> 47 <path value="ParameterDefinition" /> 48 <short value="Definition of a parameter to a module" /> 49 <definition value="The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse." /> 50 <min value="0" /> 51 <max value="*" /> 52 <base> 53 <path value="ParameterDefinition" /> 54 <min value="0" /> 55 <max value="*" /> 56 </base> 57 <constraint> 58 <key value="ele-1" /> 59 <severity value="error" /> 60 <human value="All FHIR elements must have a @value or children" /> 61 <expression value="hasValue() or (children().count() > id.count())" /> 62 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 63 </constraint> 64 <isModifier value="false" /> 65 <mapping> 66 <identity value="rim" /> 67 <map value="n/a" /> 68 </mapping> 69 </element> 70 <element id="ParameterDefinition.id"> 71 <path value="ParameterDefinition.id" /> 72 <representation value="xmlAttr" /> 73 <short value="Unique id for inter-element referencing" /> 74 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 75 <min value="0" /> 76 <max value="1" /> 77 <base> 78 <path value="Element.id" /> 79 <min value="0" /> 80 <max value="1" /> 81 </base> 82 <type> 83 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 84 <valueUrl value="id" /> 85 </extension> 86 <code value="http://hl7.org/fhirpath/System.String" /> 87 </type> 88 <condition value="ele-1" /> 89 <isModifier value="false" /> 90 <isSummary value="false" /> 91 <mapping> 92 <identity value="rim" /> 93 <map value="n/a" /> 94 </mapping> 95 </element> 96 <element id="ParameterDefinition.extension"> 97 <path value="ParameterDefinition.extension" /> 98 <slicing> 99 <discriminator> 100 <type value="value" /> 101 <path value="url" /> 102 </discriminator> 103 <description value="Extensions are always sliced by (at least) url" /> 104 <rules value="open" /> 105 </slicing> 106 <short value="Additional content defined by implementations" /> 107 <definition value="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." /> 108 <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> 109 <alias value="extensions" /> 110 <alias value="user content" /> 111 <min value="0" /> 112 <max value="*" /> 113 <base> 114 <path value="Element.extension" /> 115 <min value="0" /> 116 <max value="*" /> 117 </base> 118 <type> 119 <code value="Extension" /> 120 </type> 121 <constraint> 122 <key value="ele-1" /> 123 <severity value="error" /> 124 <human value="All FHIR elements must have a @value or children" /> 125 <expression value="hasValue() or (children().count() > id.count())" /> 126 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 127 </constraint> 128 <constraint> 129 <key value="ext-1" /> 130 <severity value="error" /> 131 <human value="Must have either extensions or value[x], not both" /> 132 <expression value="extension.exists() != value.exists()" /> 133 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 134 </constraint> 135 <isModifier value="false" /> 136 <isSummary value="false" /> 137 <mapping> 138 <identity value="rim" /> 139 <map value="n/a" /> 140 </mapping> 141 </element> 142 <element id="ParameterDefinition.name"> 143 <extension url="http://hl7.org/fhir/tools/StructureDefinition/no-binding"> 144 <valueBoolean value="true" /> 145 </extension> 146 <path value="ParameterDefinition.name" /> 147 <short value="Name used to access the parameter value" /> 148 <definition value="The name of the parameter used to allow access to the value of the parameter in evaluation contexts." /> 149 <min value="0" /> 150 <max value="1" /> 151 <base> 152 <path value="ParameterDefinition.name" /> 153 <min value="0" /> 154 <max value="1" /> 155 </base> 156 <type> 157 <code value="code" /> 158 </type> 159 <constraint> 160 <key value="ele-1" /> 161 <severity value="error" /> 162 <human value="All FHIR elements must have a @value or children" /> 163 <expression value="hasValue() or (children().count() > id.count())" /> 164 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 165 </constraint> 166 <isModifier value="false" /> 167 <isSummary value="true" /> 168 </element> 169 <element id="ParameterDefinition.use"> 170 <path value="ParameterDefinition.use" /> 171 <short value="in | out" /> 172 <definition value="Whether the parameter is input or output for the module." /> 173 <min value="1" /> 174 <max value="1" /> 175 <base> 176 <path value="ParameterDefinition.use" /> 177 <min value="1" /> 178 <max value="1" /> 179 </base> 180 <type> 181 <code value="code" /> 182 </type> 183 <constraint> 184 <key value="ele-1" /> 185 <severity value="error" /> 186 <human value="All FHIR elements must have a @value or children" /> 187 <expression value="hasValue() or (children().count() > id.count())" /> 188 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 189 </constraint> 190 <isModifier value="false" /> 191 <isSummary value="true" /> 192 <binding> 193 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 194 <valueString value="Whether the parameter is input or output." /> 195 </extension> 196 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 197 <valueString value="ParameterUse" /> 198 </extension> 199 <strength value="required" /> 200 <description value="Whether the parameter is input or output." /> 201 <valueSet value="http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0" /> 202 </binding> 203 </element> 204 <element id="ParameterDefinition.min"> 205 <path value="ParameterDefinition.min" /> 206 <short value="Minimum cardinality" /> 207 <definition value="The minimum number of times this parameter SHALL appear in the request or response." /> 208 <min value="0" /> 209 <max value="1" /> 210 <base> 211 <path value="ParameterDefinition.min" /> 212 <min value="0" /> 213 <max value="1" /> 214 </base> 215 <type> 216 <code value="integer" /> 217 </type> 218 <constraint> 219 <key value="ele-1" /> 220 <severity value="error" /> 221 <human value="All FHIR elements must have a @value or children" /> 222 <expression value="hasValue() or (children().count() > id.count())" /> 223 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 224 </constraint> 225 <isModifier value="false" /> 226 <isSummary value="true" /> 227 </element> 228 <element id="ParameterDefinition.max"> 229 <path value="ParameterDefinition.max" /> 230 <short value="Maximum cardinality (a number of *)" /> 231 <definition value="The maximum number of times this element is permitted to appear in the request or response." /> 232 <min value="0" /> 233 <max value="1" /> 234 <base> 235 <path value="ParameterDefinition.max" /> 236 <min value="0" /> 237 <max value="1" /> 238 </base> 239 <type> 240 <code value="string" /> 241 </type> 242 <constraint> 243 <key value="ele-1" /> 244 <severity value="error" /> 245 <human value="All FHIR elements must have a @value or children" /> 246 <expression value="hasValue() or (children().count() > id.count())" /> 247 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 248 </constraint> 249 <isModifier value="false" /> 250 <isSummary value="true" /> 251 </element> 252 <element id="ParameterDefinition.documentation"> 253 <path value="ParameterDefinition.documentation" /> 254 <short value="A brief description of the parameter" /> 255 <definition value="A brief discussion of what the parameter is for and how it is used by the module." /> 256 <min value="0" /> 257 <max value="1" /> 258 <base> 259 <path value="ParameterDefinition.documentation" /> 260 <min value="0" /> 261 <max value="1" /> 262 </base> 263 <type> 264 <code value="string" /> 265 </type> 266 <constraint> 267 <key value="ele-1" /> 268 <severity value="error" /> 269 <human value="All FHIR elements must have a @value or children" /> 270 <expression value="hasValue() or (children().count() > id.count())" /> 271 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 272 </constraint> 273 <isModifier value="false" /> 274 <isSummary value="true" /> 275 </element> 276 <element id="ParameterDefinition.type"> 277 <path value="ParameterDefinition.type" /> 278 <short value="What type of value" /> 279 <definition value="The type of the parameter." /> 280 <min value="1" /> 281 <max value="1" /> 282 <base> 283 <path value="ParameterDefinition.type" /> 284 <min value="1" /> 285 <max value="1" /> 286 </base> 287 <type> 288 <code value="code" /> 289 </type> 290 <constraint> 291 <key value="ele-1" /> 292 <severity value="error" /> 293 <human value="All FHIR elements must have a @value or children" /> 294 <expression value="hasValue() or (children().count() > id.count())" /> 295 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 296 </constraint> 297 <isModifier value="false" /> 298 <isSummary value="true" /> 299 <binding> 300 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 301 <valueString value="List of FHIR types (resources, data types)." /> 302 </extension> 303 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 304 <valueString value="FHIRTypes" /> 305 </extension> 306 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> 307 <valueBoolean value="true" /> 308 </extension> 309 <strength value="required" /> 310 <description value="List of FHIR types (resources, data types)." /> 311 <valueSet value="http://hl7.org/fhir/ValueSet/fhir-types|5.0.0" /> 312 </binding> 313 </element> 314 <element id="ParameterDefinition.profile"> 315 <path value="ParameterDefinition.profile" /> 316 <short value="What profile the value is expected to be" /> 317 <definition value="If specified, this indicates a profile that the input data must conform to, or that the output data will conform to." /> 318 <min value="0" /> 319 <max value="1" /> 320 <base> 321 <path value="ParameterDefinition.profile" /> 322 <min value="0" /> 323 <max value="1" /> 324 </base> 325 <type> 326 <code value="canonical" /> 327 <targetProfile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition" /> 328 </type> 329 <constraint> 330 <key value="ele-1" /> 331 <severity value="error" /> 332 <human value="All FHIR elements must have a @value or children" /> 333 <expression value="hasValue() or (children().count() > id.count())" /> 334 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 335 </constraint> 336 <isModifier value="false" /> 337 <isSummary value="true" /> 338 </element> 339 </snapshot> 340 <differential> 341 <element id="ParameterDefinition"> 342 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 343 <valueCode value="trial-use" /> 344 </extension> 345 <path value="ParameterDefinition" /> 346 <short value="Definition of a parameter to a module" /> 347 <definition value="The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse." /> 348 <min value="0" /> 349 <max value="*" /> 350 </element> 351 <element id="ParameterDefinition.name"> 352 <extension url="http://hl7.org/fhir/tools/StructureDefinition/no-binding"> 353 <valueBoolean value="true" /> 354 </extension> 355 <path value="ParameterDefinition.name" /> 356 <short value="Name used to access the parameter value" /> 357 <definition value="The name of the parameter used to allow access to the value of the parameter in evaluation contexts." /> 358 <min value="0" /> 359 <max value="1" /> 360 <type> 361 <code value="code" /> 362 </type> 363 <isSummary value="true" /> 364 </element> 365 <element id="ParameterDefinition.use"> 366 <path value="ParameterDefinition.use" /> 367 <short value="in | out" /> 368 <definition value="Whether the parameter is input or output for the module." /> 369 <min value="1" /> 370 <max value="1" /> 371 <type> 372 <code value="code" /> 373 </type> 374 <isSummary value="true" /> 375 <binding> 376 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 377 <valueString value="Whether the parameter is input or output." /> 378 </extension> 379 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 380 <valueString value="ParameterUse" /> 381 </extension> 382 <strength value="required" /> 383 <description value="Whether the parameter is input or output." /> 384 <valueSet value="http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0" /> 385 </binding> 386 </element> 387 <element id="ParameterDefinition.min"> 388 <path value="ParameterDefinition.min" /> 389 <short value="Minimum cardinality" /> 390 <definition value="The minimum number of times this parameter SHALL appear in the request or response." /> 391 <min value="0" /> 392 <max value="1" /> 393 <type> 394 <code value="integer" /> 395 </type> 396 <isSummary value="true" /> 397 </element> 398 <element id="ParameterDefinition.max"> 399 <path value="ParameterDefinition.max" /> 400 <short value="Maximum cardinality (a number of *)" /> 401 <definition value="The maximum number of times this element is permitted to appear in the request or response." /> 402 <min value="0" /> 403 <max value="1" /> 404 <type> 405 <code value="string" /> 406 </type> 407 <isSummary value="true" /> 408 </element> 409 <element id="ParameterDefinition.documentation"> 410 <path value="ParameterDefinition.documentation" /> 411 <short value="A brief description of the parameter" /> 412 <definition value="A brief discussion of what the parameter is for and how it is used by the module." /> 413 <min value="0" /> 414 <max value="1" /> 415 <type> 416 <code value="string" /> 417 </type> 418 <isSummary value="true" /> 419 </element> 420 <element id="ParameterDefinition.type"> 421 <path value="ParameterDefinition.type" /> 422 <short value="What type of value" /> 423 <definition value="The type of the parameter." /> 424 <min value="1" /> 425 <max value="1" /> 426 <type> 427 <code value="code" /> 428 </type> 429 <isSummary value="true" /> 430 <binding> 431 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 432 <valueString value="List of FHIR types (resources, data types)." /> 433 </extension> 434 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 435 <valueString value="FHIRTypes" /> 436 </extension> 437 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> 438 <valueBoolean value="true" /> 439 </extension> 440 <strength value="required" /> 441 <description value="List of FHIR types (resources, data types)." /> 442 <valueSet value="http://hl7.org/fhir/ValueSet/fhir-types|5.0.0" /> 443 </binding> 444 </element> 445 <element id="ParameterDefinition.profile"> 446 <path value="ParameterDefinition.profile" /> 447 <short value="What profile the value is expected to be" /> 448 <definition value="If specified, this indicates a profile that the input data must conform to, or that the output data will conform to." /> 449 <min value="0" /> 450 <max value="1" /> 451 <type> 452 <code value="canonical" /> 453 <targetProfile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition" /> 454 </type> 455 <isSummary value="true" /> 456 </element> 457 </differential> 458 </StructureDefinition>