Others titles
- FHIR Parameter Definition Resource
- Electronic Health Records Exchange Through FHIR
Keywords
- FHIR
- HL7
- Medical Terminology
- Processes Data
- Processes Information
- Processes Documentation
- Health Information Exchange
- Electronic Health Records
- FHIR Smart
- Smart on FHIR
Parameter Definition

The Parameter Definition structure defines a parameter to a knowledge asset such as a decision support rule or quality measure.
Get The Data
- Research
Non-Commercial,
Share-Alike,
Attribution Free Forever
- Commercial
Commercial Use,
Remix & Adapt,
White Label Log in to download
Description
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.
About this Dataset
Data Info
Date Created | 2018-09-20 |
---|---|
Last Modified | 2023-03-26 |
Version | 5.0.0 |
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 |
Data Fields
Name | Description | Type | Constraints |
---|---|---|---|
Concept_Name | Name of the concept in the FHIR structure | string | required : 1 |
Computer_Ready_Name | A 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 | - |
Type | The type the structure describes. | string | - |
Dollar_Ref | The "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced. | string | - |
Description | A free text natural language description of the structure and its use | string | - |
Items | The 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 | - |
Data Preview
Concept Name | Computer Ready Name | Type | Dollar Ref | Description | Items |
ParameterDefinition | id | #/definitions/string | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
ParameterDefinition | extension | array | 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. | {'$ref': '#/definitions/Extension'} | |
ParameterDefinition | name | #/definitions/code | The name of the parameter used to allow access to the value of the parameter in evaluation contexts. | ||
ParameterDefinition | _name | #/definitions/Element | Extensions for name | ||
ParameterDefinition | use | #/definitions/code | Whether the parameter is input or output for the module. | ||
ParameterDefinition | _use | #/definitions/Element | Extensions for use | ||
ParameterDefinition | min | #/definitions/integer | The minimum number of times this parameter SHALL appear in the request or response. | ||
ParameterDefinition | _min | #/definitions/Element | Extensions for min | ||
ParameterDefinition | max | #/definitions/string | The maximum number of times this element is permitted to appear in the request or response. | ||
ParameterDefinition | _max | #/definitions/Element | Extensions for max |