STU 3 Ballot

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

14.13.0 Parameter Definition

Clinical Decision Support

Work Group

Maturity Level: N/A

Ballot Status: STU 3

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.

Structure

Name	Flags	Card.	Type	Description & Constraints
ParameterDefinition	Σ		Element	Definition of a parameter to a module
name	Σ	0..1	code	Parameter name
use	Σ	1..1	code	OperationParameterUse (Required)
min	Σ	0..1	integer	Minimum cardinality
max	Σ	0..1	string	Maximum cardinality (a number of *)
documentation	Σ	0..1	string	A brief description of the parameter
type	Σ	1..1	code	FHIRAllTypes (Required)
profile	Σ	0..1	Reference(StructureDefinition)	The profile of the parameter, any
Documentation for this format

UML Diagram (Legend)

XML Template

<[name] xmlns="http://hl7.org/fhir"> 
 <!-- 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]>

JSON Template

{
  // from Element: extension
  "name" : "<code>", // Parameter name
  "use" : "<code>", // R!  
  "min" : <integer>, // Minimum cardinality
  "max" : "<string>", // Maximum cardinality (a number of *)
  "documentation" : "<string>", // A brief description of the parameter
  "type" : "<code>", // R!  
  "profile" : { Reference(StructureDefinition) } // The profile of the parameter, any
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:ParameterDefinition.name [ code ]; # 0..1 Parameter name
  fhir:ParameterDefinition.use [ code ]; # 1..1 
  fhir:ParameterDefinition.min [ integer ]; # 0..1 Minimum cardinality
  fhir:ParameterDefinition.max [ string ]; # 0..1 Maximum cardinality (a number of *)
  fhir:ParameterDefinition.documentation [ string ]; # 0..1 A brief description of the parameter
  fhir:ParameterDefinition.type [ code ]; # 1..1 
  fhir:ParameterDefinition.profile [ Reference(StructureDefinition) ]; # 0..1 The profile of the parameter, any
]

Changes since DSTU2

This complex-type did not exist in Release 2