LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
| Active as of 2022-11-10 |
Definitions for the parameter-definition-with-default data type profile.
| 1. ParameterDefinition | |
| 2. ParameterDefinition.extension:defaultValue | |
| SliceName | defaultValue |
| Definition | Default value for the parameter |
| Control | 0..1 |
| Type | Extension(DefaultValue) (Extension Type: Choice of: base64Binary, boolean, date, dateTime, decimal, instant, integer, string, time, uri, Annotation, Attachment, CodeableConcept, Coding, Period, Quantity, Range, Ratio) |
| 1. ParameterDefinition | |
| Definition | The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. ParameterDefinition.extension:defaultValue | |
| SliceName | defaultValue |
| Definition | Default value for the parameter |
| Control | 0..1 |
| Type | Extension(DefaultValue) (Extension Type: Choice of: base64Binary, boolean, date, dateTime, decimal, instant, integer, string, time, uri, Annotation, Attachment, CodeableConcept, Coding, Period, Quantity, Range, Ratio) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 3. ParameterDefinition.use | |
| Definition | Whether the parameter is input or output for the module. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from OperationParameterUse Whether the parameter is input or output. |
| Type | code |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 4. ParameterDefinition.type | |
| Definition | The type of the parameter. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from FHIRAllTypes A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
| Type | code |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 1. ParameterDefinition | |
| Definition | The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 2. ParameterDefinition.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 3. ParameterDefinition.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensionsuser content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ParameterDefinition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. ParameterDefinition.extension:defaultValue | |
| SliceName | defaultValue |
| Definition | Default value for the parameter |
| Control | 0..1 |
| Type | Extension(DefaultValue) (Extension Type: Choice of: base64Binary, boolean, date, dateTime, decimal, instant, integer, string, time, uri, Annotation, Attachment, CodeableConcept, Coding, Period, Quantity, Range, Ratio) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 5. ParameterDefinition.name | |
| Definition | The name of the parameter used to allow access to the value of the parameter in evaluation contexts. |
| Control | 0..1 |
| Type | code |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 6. ParameterDefinition.use | |
| Definition | Whether the parameter is input or output for the module. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from OperationParameterUse Whether the parameter is input or output |
| Type | code |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 7. ParameterDefinition.min | |
| Definition | The minimum number of times this parameter SHALL appear in the request or response. |
| Control | 0..1 |
| Type | integer |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. ParameterDefinition.max | |
| Definition | The maximum number of times this element is permitted to appear in the request or response. |
| Control | 0..1 |
| Type | string |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. ParameterDefinition.documentation | |
| Definition | A brief discussion of what the parameter is for and how it is used by the module. |
| Control | 0..1 |
| Type | string |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 10. ParameterDefinition.type | |
| Definition | The type of the parameter. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from FHIRAllTypes A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types |
| Type | code |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. ParameterDefinition.profile | |
| Definition | If specified, this indicates a profile that the input data must conform to, or that the output data will conform to. |
| Control | 0..1 |
| Type | canonical(StructureDefinition)) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |