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