Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

2.11.7 Resource Parameters - Detailed Descriptions

FHIR Infrastructure icon Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: N/A Compartments: No defined compartments

Detailed Descriptions for the elements in the Parameters resource.

Parameters
Element IdParameters
Definition

This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources.

Short DisplayOperation Request or Response
Cardinality0..*
TypeResource
Summaryfalse
Comments

The parameters that may be used are defined by the OperationDefinition resource.

Parameters.parameter
Element IdParameters.parameter
Definition

A parameter passed to or received from the operation.

Short DisplayOperation Parameter
Cardinality0..*
Summarytrue
Invariants
Defined on this element
inv-1Rule A parameter must have one and only one of (value, resource, part)(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter.name
Element IdParameters.parameter.name
Definition

The name of the parameter (reference to the operation definition).

Short DisplayName from the definition
Cardinality1..1
Typestring
Summarytrue
Parameters.parameter.value[x]
Element IdParameters.parameter.value[x]
Definition

Conveys the content if the parameter is a data type.

Short DisplayIf parameter is a data type
Cardinality0..1
Type*
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Invariants
Affect this element
inv-1Rule A parameter must have one and only one of (value, resource, part)(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter.resource
Element IdParameters.parameter.resource
Definition

Conveys the content if the parameter is a whole resource.

Short DisplayIf parameter is a whole resource
Cardinality0..1
TypeResource
Summarytrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Invariants
Affect this element
inv-1Rule A parameter must have one and only one of (value, resource, part)(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter.part
Element IdParameters.parameter.part
Definition

A named part of a multi-part parameter.

Short DisplayNamed part of a multi-part parameter
Cardinality0..*
TypeSee Parameters.parameter
Summarytrue
Invariants
Affect this element
inv-1Rule A parameter must have one and only one of (value, resource, part)(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))