Private OptionalnameParameterDefinition.name Element
Private ReadonlyoperationFHIR CodeSystem: OperationParameterUse
PrivateuseParameterDefinition.use Element
FHIR Specification
codeCodeSystem Enumeration: OperationParameterUseEnum
Private OptionalminParameterDefinition.min Element
Private OptionalmaxParameterDefinition.max Element
Private OptionaldocumentationParameterDefinition.documentation Element
Private ReadonlyfhirFHIR CodeSystem: FhirTypes
Privatetype_ParameterDefinition.type Element
FHIR Specification
codeCodeSystem Enumeration: FhirTypesEnum
Private OptionalprofileParameterDefinition.profile Element
FHIR Specification
canonical
StaticparseParse the provided ParameterDefinition JSON to instantiate the ParameterDefinition data model.
JSON representing FHIR ParameterDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ParameterDefinition
ParameterDefinition data model or undefined for ParameterDefinition
JsonError if the provided JSON is not a valid JSON object
the name property value as a CodeType object if defined; else an empty CodeType object
Assigns the provided PrimitiveType value to the name property.
the name value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the name property value as a fhirCode if defined; else undefined
Assigns the provided primitive value to the name property.
the name value
this
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the use property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: OperationParameterUseEnum
Assigns the provided EnumCodeType value to the use property.
the use value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: OperationParameterUseEnum
true if the use property exists and has a value; false otherwise
the use property value as a CodeType if defined; else null
CodeSystem Enumeration: OperationParameterUseEnum
Assigns the provided PrimitiveType value to the use property.
the use value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: OperationParameterUseEnum
true if the use property exists and has a value; false otherwise
the use property value as a fhirCode if defined; else null
CodeSystem Enumeration: OperationParameterUseEnum
Assigns the provided primitive value to the use property.
the use value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: OperationParameterUseEnum
true if the use property exists and has a value; false otherwise
the min property value as a IntegerType object if defined; else an empty IntegerType object
Assigns the provided PrimitiveType value to the min property.
the min value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the min property exists and has a value; false otherwise
the min property value as a fhirInteger if defined; else undefined
Assigns the provided primitive value to the min property.
the min value
this
PrimitiveTypeError for invalid primitive types
true if the min property exists and has a value; false otherwise
the max property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the max property.
the max value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the max property exists and has a value; false otherwise
the max property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the max property.
the max value
this
PrimitiveTypeError for invalid primitive types
true if the max property exists and has a value; false otherwise
the documentation property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the documentation property.
the documentation value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the documentation property exists and has a value; false otherwise
the documentation property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the documentation property.
the documentation value
this
PrimitiveTypeError for invalid primitive types
true if the documentation property exists and has a value; false otherwise
the type_ property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided EnumCodeType value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirTypesEnum
true if the type_ property exists and has a value; false otherwise
the type_ property value as a CodeType if defined; else null
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided PrimitiveType value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirTypesEnum
true if the type_ property exists and has a value; false otherwise
the type_ property value as a fhirCode if defined; else null
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided primitive value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: FhirTypesEnum
true if the type_ property exists and has a value; false otherwise
the profile property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the profile property.
the profile value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the profile property exists and has a value; false otherwise
the profile property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the profile property.
the profile value
this
PrimitiveTypeError for invalid primitive types
true if the profile property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
true if the instance is a FHIR complex datatype; false otherwise
the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)
the JSON value or undefined if the instance is empty
true if the instance is a FHIR complex or primitive datatype; false otherwise
the id property value
Assigns the provided value to the id property.
the id value
this
PrimitiveTypeError for invalid value
true if id exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Determines if the extension property exists.
the url that identifies a specific Extension
an Extension having the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
ParameterDefinition Class
Remarks
ParameterDefinition Type: 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.
FHIR Specification
See
FHIR ParameterDefinition