Parameters

ResourceFoundation · OtherNormativeMaturity 5

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

0 of 0 parameters tested

Structure

Show inherited elements (7)

Element	Card.	Type	Description
parameterΣ	0..*	BackboneElement	Operation Parameter
nameRequiredΣ	1..1	string	Name from the definition
value[x]Σ	0..1	base64Binary | 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	If parameter is a data type
resourceΣ	0..1	Resource	If parameter is a whole resource
partΣ	0..*	Same as Parameters.parameter	Named part of a multi-part parameter

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Parameters?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameters defines no search parameters of its own; the common parameters below apply.

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition