Others titles
- FHIR Parameters Resource
- Electronic Health Records Exchange Through FHIR
Keywords
- FHIR
- HL7
- Medical Terminology
- Processes Data
- Processes Information
- Processes Documentation
- Health Information Exchange
- Electronic Health Records
- FHIR Smart
- Smart on FHIR
Parameters
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. Operation Definition defines constraints on the Parameters resource instances that are used to convey the inputs and outputs of the operation.
Get The Data
- ResearchNon-Commercial, Share-Alike, Attribution Free Forever
- CommercialCommercial Use, Remix & Adapt, White Label Log in to download
Description
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. 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 version Id, or the last Updated id. The other features of Resource (tags, profiles, security labels, language, etc.) may have been used 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.
About this Dataset
Data Info
Date Created | 2018-09-20 |
---|---|
Last Modified | 2023-03-26 |
Version | 5.0.0 |
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 |
Data Fields
Name | Description | Type | Constraints |
---|---|---|---|
Concept_Name | Name of the concept in the FHIR structure. | string | required : 1 |
Computer_Ready_Name | A 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 | - |
Type | The type the structure describes. | string | - |
Dollar_Ref | The "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced. | string | - |
Description | A free text natural language description of the structure and its use. | string | - |
Items | The 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 | - |
Required | The 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 | - |
Const | The value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword. | string | - |
Data Preview
Concept Name | Computer Ready Name | Type | Dollar Ref | Description | Items | Required | Const |
Parameters | resourceType | This is a Parameters resource | |||||
Parameters | id | #/definitions/id | The logical id of the resource | ||||
Parameters | meta | #/definitions/Meta | The 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. | ||||
Parameters | implicitRules | #/definitions/uri | A reference to a set of rules that were followed when the resource was constructed | ||||
Parameters | _implicitRules | #/definitions/Element | Extensions for implicitRules | ||||
Parameters | language | #/definitions/code | The base language in which the resource is written. | ||||
Parameters | _language | #/definitions/Element | Extensions for language | ||||
Parameters | parameter | array | A parameter passed to or received from the operation. | {'$ref': '#/definitions/Parameters_Parameter'} | |||
Parameters | ['resourceType'] | ||||||
Parameters_Parameter | id | #/definitions/string | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |