FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3 R2

2.45.5 Resource Parameters - Detailed Descriptions

FHIR Infrastructure Work Group Maturity Level : N   Normative (from v4.0.0) Compartments : Not linked to any defined compartments

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

Parameters
Element Id Parameters
Definition

This special resource type is a non-persisted resource used to represent pass information into and back from an operation request and response (operations.html). . It has no other use, and there is no RESTful endpoint associated with it.

Control Cardinality 1..1 0..*
Type Resource
Summary 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.

Control Cardinality 0..*
Summary true
Invariants :
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
Element Id Parameters.parameter.name
Definition

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

Control Cardinality 1..1
Type string
Summary true
Parameters.parameter.value[x]
Element Id Parameters.parameter.value[x]
Definition

If the parameter is a data type.

Control Cardinality 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 : 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
Element Id Parameters.parameter.resource
Definition

If the parameter is a whole resource.

Control Cardinality 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 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) ( 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
Element Id Parameters.parameter.part
Definition

A named part of a multi-part parameter.

Control Cardinality 0..*
Type See Parameters.parameter
Summary true
Comments

Only one level of nested parameters is allowed.