Release 5 R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v5.0.0: R5 - STU ). This is the (v3.5.0: R4 Ballot #2). The current published version. version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

2.11.7 2.46.5 Resource Parameters - Detailed Descriptions

FHIR Infrastructure Work Group Maturity Level : N 5   Normative (from v4.0.0) Security Category : N/A Compartments : No Not linked to any defined compartments

Detailed Descriptions for the elements in the Parameters resource.

Parameters
Element Id Parameters
Definition

This special resource type is used to pass information into and back from represent an operation (whether invoked directly from REST or within a messaging environment). request and response (operations.html). It is not persisted or allowed to be referenced by has no other resources. use, and there is no RESTful endpoint associated with it.

Short Display Operation Request or Response Cardinality Control 0..* 1..1
Type Resource
Summary false 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.

Short Display Operation Parameter Cardinality Control 0..*
Summary true
Invariants
Defined on this element
inv-1 Rule 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 Id Parameters.parameter.name
Definition

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

Short Display Name from the definition Cardinality Control 1..1
Type string
Summary true
Parameters.parameter.value[x]
Element Id Parameters.parameter.value[x]
Definition

Conveys the content if If the parameter is a data type.

Short Display If parameter is a data type Cardinality Control 0..1
Type *
[x] Note See Choice of Datatypes 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) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter.resource
Element Id Parameters.parameter.resource
Definition

Conveys the content if If the parameter is a whole resource.

Short Display If parameter is a whole resource Cardinality 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 its 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) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter.part
Element Id Parameters.parameter.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter Cardinality Control 0..*
Type See Parameters.parameter
Summary true
Invariants Affect this element inv-1 Comments Rule A parameter must have one and only

Only one level of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) nested parameters is allowed.