PrivatenameFHIR Specification
codePrivate ReadonlyoperationFHIR CodeSystem: OperationParameterUse
PrivateuseOperationDefinition.parameter.use Element
FHIR Specification
codeCodeSystem Enumeration: OperationParameterUseEnum
Private ReadonlyoperationFHIR CodeSystem: OperationParameterScope
Private OptionalscopeOperationDefinition.parameter.scope Element
FHIR Specification
codeCodeSystem Enumeration: OperationParameterScopeEnum
PrivateminOperationDefinition.parameter.min Element
PrivatemaxOperationDefinition.parameter.max Element
Private OptionaldocumentationOperationDefinition.parameter.documentation Element
Private ReadonlyfhirFHIR CodeSystem: FhirTypes
Private Optionaltype_OperationDefinition.parameter.type Element
FHIR Specification
codeCodeSystem Enumeration: FhirTypesEnum
Private OptionalallowedOperationDefinition.parameter.allowedType Element
FHIR Specification
codeCodeSystem Enumeration: FhirTypesEnum
Private OptionaltargetOperationDefinition.parameter.targetProfile Element
FHIR Specification
canonical
Private ReadonlysearchFHIR CodeSystem: SearchParamType
Private OptionalsearchOperationDefinition.parameter.searchType Element
FHIR Specification
codeCodeSystem Enumeration: SearchParamTypeEnum
Private OptionalbindingOperationDefinition.parameter.binding Element
Private OptionalreferencedOperationDefinition.parameter.referencedFrom Element
FHIR Specification
BackboneElementPrivate OptionalpartOperationDefinition.parameter.part Element
FHIR Specification
BackboneElementStaticparseParse the provided OperationDefinitionParameterComponent JSON to instantiate the OperationDefinitionParameterComponent data model.
JSON representing FHIR OperationDefinitionParameterComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to OperationDefinitionParameterComponent
OperationDefinitionParameterComponent data model or undefined for OperationDefinitionParameterComponent
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 null
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 scope property value as a EnumCodeType array
CodeSystem Enumeration: OperationParameterScopeEnum
Assigns the provided EnumCodeType array value to the scope property.
the scope array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: OperationParameterScopeEnum
Add the provided EnumCodeType value to the scope array property.
the scope value
this
InvalidCodeError for invalid code value
CodeSystem Enumeration: OperationParameterScopeEnum
true if the scope property exists and has a value; false otherwise
the scope property value as a CodeType array
CodeSystem Enumeration: OperationParameterScopeEnum
Assigns the provided PrimitiveType array value to the scope property.
the scope array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: OperationParameterScopeEnum
Add the provided PrimitiveType value to the scope array property.
the scope value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: OperationParameterScopeEnum
true if the scope property exists and has a value; false otherwise
the scope property value as a fhirCode array
CodeSystem Enumeration: OperationParameterScopeEnum
Assigns the provided primitive value array to the scope property.
the scope value array
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: OperationParameterScopeEnum
Add the provided primitive value to the scope array property.
the scope value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: OperationParameterScopeEnum
true if the scope 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 null
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 null
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 MarkdownType object if defined; else an empty MarkdownType 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 fhirMarkdown 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 undefined
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided EnumCodeType value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code values
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 undefined
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 undefined
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 allowedType property value as a EnumCodeType array
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided EnumCodeType array value to the allowedType property.
the allowedType array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirTypesEnum
Add the provided EnumCodeType value to the allowedType array property.
the allowedType value
this
InvalidCodeError for invalid code value
CodeSystem Enumeration: FhirTypesEnum
true if the allowedType property exists and has a value; false otherwise
the allowedType property value as a CodeType array
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided PrimitiveType array value to the allowedType property.
the allowedType array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirTypesEnum
Add the provided PrimitiveType value to the allowedType array property.
the allowedType value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirTypesEnum
true if the allowedType property exists and has a value; false otherwise
the allowedType property value as a fhirCode array
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided primitive value array to the allowedType property.
the allowedType value array
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: FhirTypesEnum
Add the provided primitive value to the allowedType array property.
the allowedType value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: FhirTypesEnum
true if the allowedType property exists and has a value; false otherwise
the targetProfile property value as a CanonicalType array
Assigns the provided CanonicalType array value to the targetProfile property.
the targetProfile array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the targetProfile array property.
the targetProfile value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the targetProfile property exists and has a value; false otherwise
the targetProfile property value as a fhirCanonical array
Assigns the provided primitive value array to the targetProfile property.
the targetProfile value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the targetProfile array property.
the targetProfile value
this
PrimitiveTypeError for invalid primitive types
true if the targetProfile property exists and has a value; false otherwise
the searchType property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: SearchParamTypeEnum
Assigns the provided EnumCodeType value to the searchType property.
the searchType value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: SearchParamTypeEnum
true if the searchType property exists and has a value; false otherwise
the searchType property value as a CodeType if defined; else undefined
CodeSystem Enumeration: SearchParamTypeEnum
Assigns the provided PrimitiveType value to the searchType property.
the searchType value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: SearchParamTypeEnum
true if the searchType property exists and has a value; false otherwise
the searchType property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: SearchParamTypeEnum
Assigns the provided primitive value to the searchType property.
the searchType value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: SearchParamTypeEnum
true if the searchType property exists and has a value; false otherwise
the binding property value as a OperationDefinitionParameterBindingComponent object if defined; else an empty OperationDefinitionParameterBindingComponent object
Assigns the provided Binding object value to the binding property.
the binding object value
this
InvalidTypeError for invalid data types
true if the binding property exists and has a value; false otherwise
the referencedFrom property value as a OperationDefinitionParameterReferencedFromComponent array
Assigns the provided OperationDefinitionParameterReferencedFromComponent array value to the referencedFrom property.
the referencedFrom array value
this
InvalidTypeError for invalid data types
Add the provided OperationDefinitionParameterReferencedFromComponent value to the referencedFrom array property.
the referencedFrom value
this
InvalidTypeError for invalid data types
true if the referencedFrom property exists and has a value; false otherwise
the part property value as a OperationDefinitionParameterComponent array
Assigns the provided OperationDefinitionParameterComponent array value to the part property.
the part array value
this
InvalidTypeError for invalid data types
Add the provided OperationDefinitionParameterComponent value to the part array property.
the part value
this
InvalidTypeError for invalid data types
true if the part 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
the JSON value or undefined if the instance is empty
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension 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 modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
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 complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; 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
PrivateinitInitialize the scope property
PrivateinitInitialize the allowedType property
PrivateinitInitialize the targetProfile property
PrivateinitInitialize the referencedFrom property
PrivateinitInitialize the part property
OperationDefinitionParameterComponent Class
Remarks
FHIR Specification
See
FHIR OperationDefinition