FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Parameter definition

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-parameterDefinition Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Clinical Decision Support Computable Name: ParameterDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1578

The definition of a parameter that is expected to be provided as part of the invocation of the trigger.

Context of Use

This extension may be used on the following element(s):

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • The resource metadata has changed (status, publisher)
  • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension of type ParameterDefinition: The definition of a parameter that is expected to be provided as part of the invocation of the trigger.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension What parameter
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-parameterDefinition"
    ... value[x] 1..1 ParameterDefinition Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension What parameter
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-parameterDefinition"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type ParameterDefinition: The definition of a parameter that is expected to be provided as part of the invocation of the trigger.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension What parameter
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-parameterDefinition"
    ... value[x] 1..1 ParameterDefinition Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension What parameter
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-parameterDefinition"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is represented a little differently in R3:

    • Replace the type ParameterDefinition with a set of extensions for the content of the type along with the _datatype extension
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints doco
    . . Extension 0..* Extension What parameter
    . . . Slices for extension 0 ..* Extension Extension
    Slice: Unordered, Open by value:url
    . . . . extension:_datatype 1..1 (Complex) DataType name 'ParameterDefinition' from R5
    URL: http://hl7.org/fhir/StructureDefinition/_datatype
    . . . . . value[x] 1.. 1 string Value of extension
    Fixed Value: ParameterDefinition
    . . . . extension:name 0..1 Extension Name used to access the parameter value
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "name"
    . . . . . value[x] 1.. 1 code Value of extension
    . . . . extension:use 1..1 Extension in | out
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "use"
    . . . . . value[x] 1.. 1 code Value of extension
    Binding: OperationParameterUse ( required ): Whether the parameter is input or output.

    . . . . extension:min 0..1 Extension Minimum cardinality
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "min"
    . . . . . value[x] 1.. 1 integer Value of extension
    . . . . extension:max 0..1 Extension Maximum cardinality (a number of *)
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "max"
    . . . . . value[x] 1.. 1 string Value of extension
    . . . . extension:documentation 0..1 Extension A brief description of the parameter
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "documentation"
    . . . . . value[x] 1.. 1 string Value of extension
    . . . . extension:type 1..1 Extension What type of value
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "type"
    . . . . . value[x] 1.. 1 code Value of extension
    Binding: FHIRTypes ( required ): List of FHIR types (resources, data types).

    . . . . extension:profile 0..1 Extension What profile the value is expected to be
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "profile"
    . . . . . value[x] 1.. 1 uri Value of extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/cqf-parameterDefinition"
    . . . value[x] 0 .. 0

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)