PrivatenameFHIR Specification
stringPrivate OptionaldefinitionCapabilityStatement.rest.resource.searchParam.definition Element
FHIR Specification
canonical
Private ReadonlysearchFHIR CodeSystem: SearchParamType
Privatetype_CapabilityStatement.rest.resource.searchParam.type Element
FHIR Specification
codeCodeSystem Enumeration: SearchParamTypeEnum
Private OptionaldocumentationCapabilityStatement.rest.resource.searchParam.documentation Element
StaticparseParse the provided CapabilityStatementRestResourceSearchParamComponent JSON to instantiate the CapabilityStatementRestResourceSearchParamComponent data model.
JSON representing FHIR CapabilityStatementRestResourceSearchParamComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CapabilityStatementRestResourceSearchParamComponent
CapabilityStatementRestResourceSearchParamComponent data model or undefined for CapabilityStatementRestResourceSearchParamComponent
JsonError if the provided JSON is not a valid JSON object
the name property value as a StringType object if defined; else an empty StringType 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 fhirString 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 definition property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the definition property.
the definition value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the definition property exists and has a value; false otherwise
the definition property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the definition property.
the definition value
this
PrimitiveTypeError for invalid primitive types
true if the definition property exists and has a value; false otherwise
the type_ property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: SearchParamTypeEnum
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: SearchParamTypeEnum
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: SearchParamTypeEnum
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: SearchParamTypeEnum
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: SearchParamTypeEnum
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: SearchParamTypeEnum
true if the type_ 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 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
CapabilityStatementRestResourceSearchParamComponent Class
Remarks
FHIR Specification
See
FHIR CapabilityStatement