DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). The current 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 R3 R2

6.13.5 2.45.5 Resource Parameters - Detailed Descriptions

Detailed Descriptions for the elements in the Parameters Resource.

Parameters
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.

Control 1..1
Summary true
Comments

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

Parameters.parameter
Definition

A parameter passed to or received from the operation.

Control 0..*
Summary true
Invariants Defined on this element
inv-1 : A parameter must have a value or a only one of (value, resource, but not both (xpath: 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
Definition

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

Control 1..1
Type string
Summary true
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 : A parameter must have a value or a only one of (value, resource, but not both (xpath: 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
Definition

If the parameter is a whole resource.

Control 0..1
Type Resource
Summary true
Invariants Affect this element
inv-1 : A parameter must have a value or a only one of (value, resource, but not both (xpath: 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
Definition

A named part of a multi-part parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control 0..*
Type See Parameters.parameter
Comments Summary Only one level of Tuples is allowed. true
Invariants Comments Defined on this element inv-2 : A part must have a value or a resource, but not both (xpath: exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource)))

Only one level of nested parameters is allowed.