Current Build
FHIR Infrastructure Work GroupMaturity Level: 5 Normative Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the Parameters resource.

Parameters
Element IdParameters
Definition

This special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.

Control1..1
Summarytrue
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.

Control0..*
Summarytrue
InvariantsDefined on this element
  • Rule inv-1: A parameter must have 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)))
Parameters.parameter.name
Element IdParameters.parameter.name
Definition

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

Control1..1
Typestring
Summarytrue
Parameters.parameter.value[x]
Element IdParameters.parameter.value[x]
Definition

If the parameter is a data type.

Control0..1
Type*
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
InvariantsAffect this element
  • Rule inv-1: A parameter must have 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)))
Parameters.parameter.resource
Element IdParameters.parameter.resource
Definition

If the parameter is a whole resource.

Control0..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 it's general resource resolution methods.

InvariantsAffect this element
  • Rule inv-1: A parameter must have 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)))
Parameters.parameter.part
Element IdParameters.parameter.part
Definition

A named part of a multi-part parameter.

Control0..*
TypeSee Parameters.parameter
Summarytrue
Comments

Only one level of nested parameters is allowed.