{ "description": "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.", "_filename": "StructureDefinition-ParameterDefinition.json", "package_name": "hl7.fhir.r4b.core", "date": "2021-03-11T17:06:20+11:00", "derivation": "specialization", "publisher": "HL7 FHIR Standard", "fhirVersion": "4.1.0", "name": "ParameterDefinition", "mapping": [ { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" } ], "abstract": false, "type": "ParameterDefinition", "experimental": null, "resourceType": "StructureDefinition", "title": null, "package_version": "4.1.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "snapshot": { "element": [ { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children unless an empty Parameters resource", "xpath": "@value|f:*|h:div|self::f:Parameters", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count()) or $this is Parameters" } ], "path": "ParameterDefinition", "min": 0, "definition": "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.", "isModifier": false, "short": "Definition of a parameter to a module", "mapping": [ { "map": "n/a", "identity": "rim" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "max": "*", "id": "ParameterDefinition", "condition": [ "ele-1" ], "base": { "max": "*", "min": 0, "path": "ParameterDefinition" } }, { "path": "ParameterDefinition.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "ParameterDefinition.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "ParameterDefinition.extension", "min": 0, "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.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "ParameterDefinition.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.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ParameterDefinition.name", "min": 0, "definition": "The name of the parameter used to allow access to the value of the parameter in evaluation contexts.", "isModifier": false, "short": "Name used to access the parameter value", "type": [ { "code": "code" } ], "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/no-binding", "valueBoolean": true } ], "max": "1", "id": "ParameterDefinition.name", "base": { "max": "1", "min": 0, "path": "ParameterDefinition.name" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ParameterDefinition.use", "min": 1, "definition": "Whether the parameter is input or output for the module.", "isModifier": false, "short": "in | out", "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/operation-parameter-use|4.1.0", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Whether the parameter is input or output." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParameterUse" } ] }, "max": "1", "id": "ParameterDefinition.use", "base": { "max": "1", "min": 1, "path": "ParameterDefinition.use" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ParameterDefinition.min", "min": 0, "definition": "The minimum number of times this parameter SHALL appear in the request or response.", "isModifier": false, "short": "Minimum cardinality", "type": [ { "code": "integer" } ], "max": "1", "id": "ParameterDefinition.min", "base": { "max": "1", "min": 0, "path": "ParameterDefinition.min" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ParameterDefinition.max", "min": 0, "definition": "The maximum number of times this element is permitted to appear in the request or response.", "isModifier": false, "short": "Maximum cardinality (a number of *)", "type": [ { "code": "string" } ], "max": "1", "id": "ParameterDefinition.max", "base": { "max": "1", "min": 0, "path": "ParameterDefinition.max" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ParameterDefinition.documentation", "min": 0, "definition": "A brief discussion of what the parameter is for and how it is used by the module.", "isModifier": false, "short": "A brief description of the parameter", "type": [ { "code": "string" } ], "max": "1", "id": "ParameterDefinition.documentation", "base": { "max": "1", "min": 0, "path": "ParameterDefinition.documentation" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ParameterDefinition.type", "min": 1, "definition": "The type of the parameter.", "isModifier": false, "short": "What type of value", "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/all-types|4.1.0", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRAllTypes" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ] }, "max": "1", "id": "ParameterDefinition.type", "base": { "max": "1", "min": 1, "path": "ParameterDefinition.type" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "ParameterDefinition.profile", "min": 0, "definition": "If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.", "isModifier": false, "short": "What profile the value is expected to be", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ] } ], "max": "1", "id": "ParameterDefinition.profile", "base": { "max": "1", "min": 0, "path": "ParameterDefinition.profile" }, "isSummary": true } ] }, "status": "draft", "id": "2059352d-d50c-48a5-a1d0-0b2fbda26043", "kind": "complex-type", "url": "http://hl7.org/fhir/StructureDefinition/ParameterDefinition", "version": "4.1.0", "differential": { "element": [ { "id": "ParameterDefinition", "max": "*", "min": 0, "path": "ParameterDefinition", "short": "Definition of a parameter to a module", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "definition": "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." }, { "path": "ParameterDefinition.name", "min": 0, "definition": "The name of the parameter used to allow access to the value of the parameter in evaluation contexts.", "short": "Name used to access the parameter value", "type": [ { "code": "code" } ], "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/no-binding", "valueBoolean": true } ], "max": "1", "id": "ParameterDefinition.name", "isSummary": true }, { "path": "ParameterDefinition.use", "min": 1, "definition": "Whether the parameter is input or output for the module.", "short": "in | out", "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/operation-parameter-use|4.1.0", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Whether the parameter is input or output." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParameterUse" } ] }, "max": "1", "id": "ParameterDefinition.use", "isSummary": true }, { "id": "ParameterDefinition.min", "max": "1", "min": 0, "path": "ParameterDefinition.min", "type": [ { "code": "integer" } ], "short": "Minimum cardinality", "isSummary": true, "definition": "The minimum number of times this parameter SHALL appear in the request or response." }, { "id": "ParameterDefinition.max", "max": "1", "min": 0, "path": "ParameterDefinition.max", "type": [ { "code": "string" } ], "short": "Maximum cardinality (a number of *)", "isSummary": true, "definition": "The maximum number of times this element is permitted to appear in the request or response." }, { "id": "ParameterDefinition.documentation", "max": "1", "min": 0, "path": "ParameterDefinition.documentation", "type": [ { "code": "string" } ], "short": "A brief description of the parameter", "isSummary": true, "definition": "A brief discussion of what the parameter is for and how it is used by the module." }, { "path": "ParameterDefinition.type", "min": 1, "definition": "The type of the parameter.", "short": "What type of value", "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/all-types|4.1.0", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRAllTypes" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ] }, "max": "1", "id": "ParameterDefinition.type", "isSummary": true }, { "id": "ParameterDefinition.profile", "max": "1", "min": 0, "path": "ParameterDefinition.profile", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ] } ], "short": "What profile the value is expected to be", "isSummary": true, "definition": "If specified, this indicates a profile that the input data must conform to, or that the output data will conform to." } ] }, "contact": [ { "telecom": [ { "value": "http://hl7.org/fhir", "system": "url" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element" }