Parameters - FHIR v4.0.1

Release 4

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) 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 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.

Parameters

Element Id Parameters

Definition

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

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

Cardinality 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).

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.

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) (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

If the parameter is a whole resource.

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) (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.

Cardinality 0..*

Type See Parameters.parameter

Summary true

Comments

Only one level of nested parameters is allowed.