Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. 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.6 Resource Parameters - Detailed Descriptions

FHIR Infrastructure Work GroupMaturity 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 IdParameters
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.

Cardinality0..*
TypeResource
Summaryfalse
Comments

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

Parameters.parameter
Element IdParameters.parameter
Definition

A parameter passed to or received from the operation.

Cardinality0..*
Summarytrue
Invariants
Defined on this element
inv-1Rule 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 IdParameters.parameter.name
Definition

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

Cardinality1..1
Typestring
Summarytrue
Parameters.parameter.value[x]
Element IdParameters.parameter.value[x]
Definition

Conveys the content if the parameter is a data type.

Cardinality0..1
Typebase64Binary|boolean|canonical|code|date|dateTime|decimal|id|instant|integer|markdown|oid|positiveInt|string|time|unsignedInt|uri|url|uuid|Address|Age|Annotation|Attachment|CodeableConcept|Coding|ContactPoint|Count|Distance|Duration|HumanName|Identifier|Money|Period|Quantity|Range|Ratio|Reference|SampledData|Signature|Timing|ContactDetail|Contributor|DataRequirement|Expression|ParameterDefinition|RelatedArtifact|TriggerDefinition|UsageContext|Dosage|Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Invariants
Affect this element
inv-1Rule 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 IdParameters.parameter.resource
Definition

If the parameter is a whole resource.

Cardinality0..1
TypeResource
Summarytrue
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-1Rule 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 IdParameters.parameter.part
Definition

A named part of a multi-part parameter.

Cardinality0..*
TypeSee Parameters.parameter
Summarytrue
Comments

Only one level of nested parameters is allowed.