Parameters

$10 / year

The Parameters 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.

Complexity

The Parameters resource is a special resource that has no other use than for operation parameters, and there is no RESTful end-point associated with it. For further information, see the operations page. Operation Definition defines constraints on the Parameters resource instances that are used to convey the inputs and outputs of the operation.

Parameter names can be repeated at any level. The meaning of duplicate parameter names, and whether it is valid to repeat any given parameter name, depends on the context. Typically, operation definitions define what parameters can be used, and whether they can repeat. The order of parameters with different names is not considered significant. For technical compatibility reasons, the Parameters resource inherits from Resource, but since the parameter exchange format has no end-point and/or persistence, it never has an id, a versionId, or a last Updated. The other features of Resource (tags, profiles, security labels, language etc.) may have use when operations are executed. Resources in parameter resource do not need to be unique, though the interpretation of non-unique resources, or different versions of the same resource, may be ambiguous in cases where the parameter names do not clearly differentiate the purpose of the parameter.

Date Created

2018-09-20

Last Modified

2019-11-01

Version

4.0.1

Update Frequency

Annual

Temporal Coverage

N/A

Spatial Coverage

United States

Source

John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements

N/A

Source Citation

N/A

Keywords

FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Parameters Resource, Electronic Health Records Exchange Through FHIR

NameDescriptionTypeConstraints
Concept_NameName of the concept in the FHIR structure.stringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its use.string-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
RequiredThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
ConstThe value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItemsRequiredConst
ParametersresourceTypeThis is a Parameters resourceParameters
Parametersid#/definitions/idThe logical id of the resource as used in the URL for the resource. Once assigned this value never changes.
Parametersmeta#/definitions/MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
ParametersimplicitRules#/definitions/uriA reference to a set of rules that were followed when the resource was constructed and which must be understood when processing the content. Often this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Parameters_implicitRules#/definitions/ElementExtensions for implicitRules
Parameterslanguage#/definitions/codeThe base language in which the resource is written.
Parameters_language#/definitions/ElementExtensions for language
ParametersparameterarrayA parameter passed to or received from the operation.{'$ref': '#/definitions/Parameters_Parameter'}
Parameters['resourceType']
Parameters_Parameterid#/definitions/stringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Related Data Packages