FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

2.45.5 2.11.7 Resource Parameters - Detailed Descriptions

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

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

Control Control Control Control
Parameters
Definition Element Id Parameters
Definition

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

Short Display Operation Request or Response
Cardinality 0..*
1..1 Type Resource
Summary true false
Comments

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

Parameters.parameter
Definition Element Id Parameters.parameter
Definition

A parameter passed to or received from the operation.

Short Display Operation Parameter
Cardinality 0..*
Summary true
Invariants Constraints :
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
Definition Element Id Parameters.parameter.name
Definition

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

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

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

Short Display If parameter is a data type
Cardinality 0..1
Type *
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Summary true
Invariants Constraints :
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
Definition Element Id Parameters.parameter.resource
Definition

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

Short Display If parameter is a whole resource
Cardinality 0..1
Type Resource
Summary true
Invariants Comments

This may be a resource defined in the FHIR specification, or an additional resource . 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.

Constraints :
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
Definition Element Id Parameters.parameter.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Control Cardinality 0..*
Type See Parameters.parameter
Summary true
Comments Constraints
Affect this element
inv-1 Only Rule A parameter must have one and only one level of nested parameters is allowed. (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))