Private ReadonlyfhirFHIR CodeSystem: FhirTypes
PrivatecodeCompartmentDefinition.resource.code Element
FHIR Specification
codeCodeSystem Enumeration: FhirTypesEnum
Private OptionalparamCompartmentDefinition.resource.param Element
FHIR Specification
stringPrivate OptionaldocumentationCompartmentDefinition.resource.documentation Element
Private OptionalstartCompartmentDefinition.resource.startParam Element
FHIR Specification
uriPrivate OptionalendCompartmentDefinition.resource.endParam Element
FHIR Specification
uriStaticparseParse the provided CompartmentDefinitionResourceComponent JSON to instantiate the CompartmentDefinitionResourceComponent data model.
JSON representing FHIR CompartmentDefinitionResourceComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CompartmentDefinitionResourceComponent
CompartmentDefinitionResourceComponent data model or undefined for CompartmentDefinitionResourceComponent
JsonError if the provided JSON is not a valid JSON object
the code property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided EnumCodeType value to the code property.
the code value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirTypesEnum
true if the code property exists and has a value; false otherwise
the code property value as a CodeType if defined; else null
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided PrimitiveType value to the code property.
the code value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirTypesEnum
true if the code property exists and has a value; false otherwise
the code property value as a fhirCode if defined; else null
CodeSystem Enumeration: FhirTypesEnum
Assigns the provided primitive value to the code property.
the code value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: FhirTypesEnum
true if the code property exists and has a value; false otherwise
the param property value as a StringType array
Assigns the provided StringType array value to the param property.
the param array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided StringType value to the param array property.
the param value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the param property exists and has a value; false otherwise
the param property value as a fhirString array
Assigns the provided primitive value array to the param property.
the param value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the param array property.
the param value
this
PrimitiveTypeError for invalid primitive types
true if the param 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 startParam property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the startParam property.
the startParam value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the startParam property exists and has a value; false otherwise
the startParam property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the startParam property.
the startParam value
this
PrimitiveTypeError for invalid primitive types
true if the startParam property exists and has a value; false otherwise
the endParam property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the endParam property.
the endParam value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the endParam property exists and has a value; false otherwise
the endParam property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the endParam property.
the endParam value
this
PrimitiveTypeError for invalid primitive types
true if the endParam 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 param property
CompartmentDefinitionResourceComponent Class
Remarks
FHIR Specification
See
FHIR CompartmentDefinition