STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

1.26.0 Parameter Definition

Clinical Decision Support Work GroupMaturity Level: N/ABallot Status: DSTU 2

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

Parameters are typically used to communicate patient-independent information such as configuration values, whereas DataRequirements are typically used to communicate patient-dependent information such as MedicationStatements and Encounters.

1.26.0.1 Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParameterDefinition ΣElementDefinition of a parameter to a module
... name Σ0..1codeParameter name
... use Σ1..1code
OperationParameterUse (Required)
... min Σ0..1integerMinimum cardinality
... max Σ0..1stringMaximum cardinality (a number of *)
... documentation Σ0..1stringA brief description of the parameter
... type Σ1..1code
FHIRAllTypes (Required)
... profile Σ0..1Reference(StructureDefinition)The profile of the parameter, any

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir"> doco
 <!-- from Element: extension -->
 <name value="[code]"/><!-- 0..1 Parameter name -->
 <use value="[code]"/><!-- 1..1  -->
 <min value="[integer]"/><!-- 0..1 Minimum cardinality -->
 <max value="[string]"/><!-- 0..1 Maximum cardinality (a number of *) -->
 <documentation value="[string]"/><!-- 0..1 A brief description of the parameter -->
 <type value="[code]"/><!-- 1..1  -->
 <profile><!-- 0..1 Reference(StructureDefinition) The profile of the parameter, any --></profile>
</[name]>

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParameterDefinition ΣElementDefinition of a parameter to a module
... name Σ0..1codeParameter name
... use Σ1..1code
OperationParameterUse (Required)
... min Σ0..1integerMinimum cardinality
... max Σ0..1stringMaximum cardinality (a number of *)
... documentation Σ0..1stringA brief description of the parameter
... type Σ1..1code
FHIRAllTypes (Required)
... profile Σ0..1Reference(StructureDefinition)The profile of the parameter, any

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir"> doco
 <!-- from Element: extension -->
 <name value="[code]"/><!-- 0..1 Parameter name -->
 <use value="[code]"/><!-- 1..1  -->
 <min value="[integer]"/><!-- 0..1 Minimum cardinality -->
 <max value="[string]"/><!-- 0..1 Maximum cardinality (a number of *) -->
 <documentation value="[string]"/><!-- 0..1 A brief description of the parameter -->
 <type value="[code]"/><!-- 1..1  -->
 <profile><!-- 0..1 Reference(StructureDefinition) The profile of the parameter, any --></profile>
</[name]>

Constraints