PrivatedefinitionResearchElementDefinition.characteristic.definition[x] Element
@ChoiceDataTypesMeta('ResearchElementDefinition.characteristic.definition[x]', ['CodeableConcept','canonical','Expression','DataRequirement',]
FHIR Specification
Private OptionalusageResearchElementDefinition.characteristic.usageContext Element
FHIR Specification
UsageContextPrivate OptionalexcludeResearchElementDefinition.characteristic.exclude Element
Private OptionalunitResearchElementDefinition.characteristic.unitOfMeasure Element
Private OptionalstudyResearchElementDefinition.characteristic.studyEffectiveDescription Element
Private OptionalstudyResearchElementDefinition.characteristic.studyEffective[x] Element
Private OptionalstudyResearchElementDefinition.characteristic.studyEffectiveTimeFromStart Element
Private ReadonlygroupFHIR CodeSystem: GroupMeasure
Private OptionalstudyResearchElementDefinition.characteristic.studyEffectiveGroupMeasure Element
FHIR Specification
codeCodeSystem Enumeration: GroupMeasureEnum
Private OptionalparticipantResearchElementDefinition.characteristic.participantEffectiveDescription Element
Private OptionalparticipantResearchElementDefinition.characteristic.participantEffective[x] Element
Private OptionalparticipantResearchElementDefinition.characteristic.participantEffectiveTimeFromStart Element
Private OptionalparticipantResearchElementDefinition.characteristic.participantEffectiveGroupMeasure Element
FHIR Specification
codeCodeSystem Enumeration: GroupMeasureEnum
StaticparseParse the provided ResearchElementDefinitionCharacteristicComponent JSON to instantiate the ResearchElementDefinitionCharacteristicComponent data model.
JSON representing FHIR ResearchElementDefinitionCharacteristicComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ResearchElementDefinitionCharacteristicComponent
ResearchElementDefinitionCharacteristicComponent data model or undefined for ResearchElementDefinitionCharacteristicComponent
JsonError if the provided JSON is not a valid JSON object
the definition property value as a DataType object; else null
Assigns the provided DataType object value to the definition property.
the definition object value
this
InvalidTypeError for invalid data types
true if the definition property exists and has a value; false otherwise
the definition property value as a CodeableConcept object if defined; else null
true if the `` property exists as a CodeableConcept and has a value; false otherwise
the definition property value as a CanonicalType object if defined; else null
true if the `` property exists as a CanonicalType and has a value; false otherwise
the definition property value as a Expression object if defined; else null
true if the `` property exists as a Expression and has a value; false otherwise
the definition property value as a DataRequirement object if defined; else null
true if the `` property exists as a DataRequirement and has a value; false otherwise
the usageContext property value as a UsageContext array
Assigns the provided UsageContext array value to the usageContext property.
the usageContext array value
this
InvalidTypeError for invalid data types
Add the provided UsageContext value to the usageContext array property.
the usageContext value
this
InvalidTypeError for invalid data types
true if the usageContext property exists and has a value; false otherwise
the exclude property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the exclude property.
the exclude value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the exclude property exists and has a value; false otherwise
the exclude property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the exclude property.
the exclude value
this
PrimitiveTypeError for invalid primitive types
true if the exclude property exists and has a value; false otherwise
the unitOfMeasure property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided UnitOfMeasure object value to the unitOfMeasure property.
the unitOfMeasure object value
this
InvalidTypeError for invalid data types
true if the unitOfMeasure property exists and has a value; false otherwise
the studyEffectiveDescription property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the studyEffectiveDescription property.
the studyEffectiveDescription value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the studyEffectiveDescription property exists and has a value; false otherwise
the studyEffectiveDescription property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the studyEffectiveDescription property.
the studyEffectiveDescription value
this
PrimitiveTypeError for invalid primitive types
true if the studyEffectiveDescription property exists and has a value; false otherwise
the studyEffective property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the studyEffective property.
the studyEffective object value
this
InvalidTypeError for invalid data types
true if the studyEffective property exists and has a value; false otherwise
the studyEffective property value as a DateTimeType object if defined; else undefined
true if the studyEffective property exists as a DateTimeType and has a value; false otherwise
the studyEffective property value as a Period object if defined; else undefined
true if the studyEffective property exists as a Period and has a value; false otherwise
the studyEffective property value as a Duration object if defined; else undefined
true if the studyEffective property exists as a Duration and has a value; false otherwise
the studyEffective property value as a Timing object if defined; else undefined
true if the studyEffective property exists as a Timing and has a value; false otherwise
the studyEffectiveTimeFromStart property value as a Duration object if defined; else an empty Duration object
Assigns the provided StudyEffectiveTimeFromStart object value to the studyEffectiveTimeFromStart property.
the studyEffectiveTimeFromStart object value
this
InvalidTypeError for invalid data types
true if the studyEffectiveTimeFromStart property exists and has a value; false otherwise
the studyEffectiveGroupMeasure property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: GroupMeasureEnum
Assigns the provided EnumCodeType value to the studyEffectiveGroupMeasure property.
the studyEffectiveGroupMeasure value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: GroupMeasureEnum
true if the studyEffectiveGroupMeasure property exists and has a value; false otherwise
the studyEffectiveGroupMeasure property value as a CodeType if defined; else undefined
CodeSystem Enumeration: GroupMeasureEnum
Assigns the provided PrimitiveType value to the studyEffectiveGroupMeasure property.
the studyEffectiveGroupMeasure value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: GroupMeasureEnum
true if the studyEffectiveGroupMeasure property exists and has a value; false otherwise
the studyEffectiveGroupMeasure property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: GroupMeasureEnum
Assigns the provided primitive value to the studyEffectiveGroupMeasure property.
the studyEffectiveGroupMeasure value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: GroupMeasureEnum
true if the studyEffectiveGroupMeasure property exists and has a value; false otherwise
the participantEffectiveDescription property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the participantEffectiveDescription property.
the participantEffectiveDescription value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the participantEffectiveDescription property exists and has a value; false otherwise
the participantEffectiveDescription property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the participantEffectiveDescription property.
the participantEffectiveDescription value
this
PrimitiveTypeError for invalid primitive types
true if the participantEffectiveDescription property exists and has a value; false otherwise
the participantEffective property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the participantEffective property.
the participantEffective object value
this
InvalidTypeError for invalid data types
true if the participantEffective property exists and has a value; false otherwise
the participantEffective property value as a DateTimeType object if defined; else undefined
true if the participantEffective property exists as a DateTimeType and has a value; false otherwise
the participantEffective property value as a Period object if defined; else undefined
true if the participantEffective property exists as a Period and has a value; false otherwise
the participantEffective property value as a Duration object if defined; else undefined
true if the participantEffective property exists as a Duration and has a value; false otherwise
the participantEffective property value as a Timing object if defined; else undefined
true if the participantEffective property exists as a Timing and has a value; false otherwise
the participantEffectiveTimeFromStart property value as a Duration object if defined; else an empty Duration object
Assigns the provided ParticipantEffectiveTimeFromStart object value to the participantEffectiveTimeFromStart property.
the participantEffectiveTimeFromStart object value
this
InvalidTypeError for invalid data types
true if the participantEffectiveTimeFromStart property exists and has a value; false otherwise
the participantEffectiveGroupMeasure property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: GroupMeasureEnum
Assigns the provided EnumCodeType value to the participantEffectiveGroupMeasure property.
the participantEffectiveGroupMeasure value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: GroupMeasureEnum
true if the participantEffectiveGroupMeasure property exists and has a value; false otherwise
the participantEffectiveGroupMeasure property value as a CodeType if defined; else undefined
CodeSystem Enumeration: GroupMeasureEnum
Assigns the provided PrimitiveType value to the participantEffectiveGroupMeasure property.
the participantEffectiveGroupMeasure value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: GroupMeasureEnum
true if the participantEffectiveGroupMeasure property exists and has a value; false otherwise
the participantEffectiveGroupMeasure property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: GroupMeasureEnum
Assigns the provided primitive value to the participantEffectiveGroupMeasure property.
the participantEffectiveGroupMeasure value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: GroupMeasureEnum
true if the participantEffectiveGroupMeasure 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 usageContext property
ResearchElementDefinitionCharacteristicComponent Class
Remarks
FHIR Specification
See
FHIR ResearchElementDefinition