Parameters - FHIR v3.3.0

R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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.44.5 Resource Parameters - Detailed Descriptions

http://www.hl7.org/Special/committees/fiwg/index.cfm

Maturity Level: 5

Normative

Compartments: Not linked to any defined compartments

Normative Candidate Note: This page is candidate normative content for R4 in the Infrastructure Package. Once normative, it will lose it's Maturity Level, and breaking changes will no longer be made.

Detailed Descriptions for the elements in the Parameters Resource.

Parameters
Element Id	Parameters
Definition	This special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.
Control	1..1
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	0..*
Summary	true
Invariants	Defined on this element inv-1: A parameter must have 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)))
Parameters.parameter.name
Element Id	Parameters.parameter.name
Definition	The name of the parameter (reference to the operation definition).
Control	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	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: A parameter must have 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)))
Parameters.parameter.resource
Element Id	Parameters.parameter.resource
Definition	If the parameter is a whole resource.
Control	0..1
Type	Resource
Summary	true
Invariants	Affect this element inv-1: A parameter must have 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)))
Parameters.parameter.part
Element Id	Parameters.parameter.part
Definition	A named part of a multi-part parameter.
Control	0..*
Type	See Parameters.parameter
Summary	true
Comments	Only one level of nested parameters is allowed.