Parameter Definition

$10 / year

The Parameter Definition structure defines a parameter to a knowledge asset such as a decision support rule or quality measure.

Complexity

Parameters are typically used to communicate patient-independent information such as configuration values, whereas Data Requirements are typically used to communicate patient-dependent information such as Medication Statements and Encounters.

Date Created

2018-09-20

Last Modified

2019-11-01

Version

4.0.1

Update Frequency

Annual

Temporal Coverage

N/A

Spatial Coverage

United States

Source

John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements

N/A

Source Citation

N/A

Keywords

FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Parameter Definition Resource, Electronic Health Records Exchange Through FHIR

NameDescriptionTypeConstraints
Concept_NameName of the concept in the FHIR structurestringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its usestring-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItems
ParameterDefinitionid#/definitions/stringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ParameterDefinitionextensionarrayMay 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.{'$ref': '#/definitions/Extension'}
ParameterDefinitionname#/definitions/codeThe name of the parameter used to allow access to the value of the parameter in evaluation contexts.
ParameterDefinition_name#/definitions/ElementExtensions for name
ParameterDefinitionuse#/definitions/codeWhether the parameter is input or output for the module.
ParameterDefinition_use#/definitions/ElementExtensions for use
ParameterDefinitionmin#/definitions/integerThe minimum number of times this parameter SHALL appear in the request or response.
ParameterDefinition_min#/definitions/ElementExtensions for min
ParameterDefinitionmax#/definitions/stringThe maximum number of times this element is permitted to appear in the request or response.
ParameterDefinition_max#/definitions/ElementExtensions for max
Related Data Packages