FHIR Release 3 (STU) Current Build
FHIR Infrastructure Work Group Maturity Level : 5   Normative Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the Parameters Resource. resource.

Parameters
Element Id Parameters
Definition

This special resource type is a non-persisted resource used to represent pass information into and back from an operation request and response (operations.html). . It has no other use, and there is no RESTful endpoint associated with it.

Control 1..1
Type Resource
Summary true
Comments

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

Parameters.parameter
Element Id Parameters.parameter
Definition

A parameter passed to or received from the operation.

Control 0..*
Summary true
Invariants
Defined on this element
inv-1 : Rule A parameter must have one and only one of (value, resource, part) ( expression : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())), xpath: exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource))) resource.exists()))
Parameters.parameter.name
Element Id Parameters.parameter.name
Definition

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

Control 1..1
Type string
Summary true
Parameters.parameter.value[x]
Element Id Parameters.parameter.value[x]
Definition

If the parameter is a data type.

Control 0..1
Type *
[x] Note See Choice of Data Types for further information about how to use [x]
Summary true
Invariants
Affect this element
inv-1 : Rule A parameter must have one and only one of (value, resource, part) ( expression : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())), xpath: exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource))) resource.exists()))
Parameters.parameter.resource
Element Id Parameters.parameter.resource
Definition

If the parameter is a whole resource.

Control 0..1
Type Resource
Summary true
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 it's general resource resolution methods.

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

A named part of a multi-part parameter.

Control 0..*
Type See Parameters.parameter
Summary true
Comments

Only one level of nested parameters is allowed.