This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

6.14.4 Parameters - Detailed Descriptions

Detailed Descriptions for the elements in the Parameters Resource.

Parameters
Definition

This special resource type is used to represent [operation](operations.html] request and response. It has no other use, and there is no RESTful end=point associated with it.

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

Control0..*
InvariantsDefined on this element
inv-1: A parameter 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)))
Parameters.parameter.name
Definition

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

Control1..1
Typestring
Parameters.parameter.value[x]
Definition

If the parameter is a data type.

Control0..1
Type*
InvariantsAffect this element
inv-1: A parameter 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)))
Parameters.parameter.resource
Definition

If the parameter is a whole resource.

Control0..1
TypeResource
InvariantsAffect this element
inv-1: A parameter 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)))
Parameters.parameter.part
Definition

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

Control0..*
Comments

Only one level of tuples is allowed.

InvariantsDefined 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)))
Parameters.parameter.part.name
Definition

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

Control1..1
Typestring
Parameters.parameter.part.value[x]
Definition

The value of the parameter.

Control0..1
Type*
Comments

If there is no value, simply omit the parameter.

InvariantsAffect 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)))
Parameters.parameter.part.resource
Definition

If the parameter is a whole resource.

Control0..1
TypeResource
InvariantsAffect 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)))