FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

2.11.7 Resource Parameters - Detailed Descriptions

Responsible Owner: FHIR Infrastructure icon Work Group Normative (from v4.0.0)Security Category: N/A Compartments: No defined compartments

Detailed Descriptions for the elements in the Parameters resource.

Parameters
Element Id Parameters
Definition

This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources.

Short Display Operation Request or Response
Cardinality 0..*
Type Resource
Summary false
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.

Short Display Operation Parameter
Cardinality 0..*
Summary true
Constraints
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 Id Parameters.parameter.name
Definition

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

Short Display Name from the definition
Cardinality 1..1
Type string
Summary true
Parameters.parameter.value[x]
Element Id Parameters.parameter.value[x]
Definition

Conveys the content if the parameter is a data type.

Short Display If parameter is a data type
Cardinality 0..1
Type base64Binary|boolean|canonical|code|date|dateTime|decimal|id|instant|integer|integer64|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|DataRequirement|Expression|ParameterDefinition|RelatedArtifact|TriggerDefinition|UsageContext|Dosage|Meta
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Constraints
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 Id Parameters.parameter.resource
Definition

Conveys the content if the parameter is a whole resource.

Short Display If parameter is a whole resource
Cardinality 0..1
Type Resource
Summary true
Comments

This may be a resource defined in the FHIR specification, or an additional resource. 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 its general resource resolution methods.

Constraints
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 Id Parameters.parameter.part
Definition

A named part of a multi-part parameter.

Short Display Named part of a multi-part parameter
Cardinality 0..*
Type See Parameters.parameter
Summary true
Constraints
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()))