Skip to main content

HS.FHIR.DTL.vR4.Model.Element.ResearchElementDefinition.characteristic

class HS.FHIR.DTL.vR4.Model.Element.ResearchElementDefinition.characteristic extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

What defines the members of the research element.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = ResearchElementDefinition.characteristic;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = ResearchElementDefinition.characteristic;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property definitionCanonical as %String (MAXLEN = 1000000, XMLNAME = "definitionCanonical", XMLPROJECTION = "ATTRIBUTE") [ Required ];
canonical

What code or expression defines members?

TO DO: Unrecognized value type for the FHIR4 model

Property methods: definitionCanonicalDisplayToLogical(), definitionCanonicalGet(), definitionCanonicalIsValid(), definitionCanonicalLogicalToDisplay(), definitionCanonicalLogicalToOdbc(), definitionCanonicalNormalize(), definitionCanonicalSet()
property definitionCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "definitionCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

What code or expression defines members?

any FHIR4 code from any ValueSet may be used.

Property methods: definitionCodeableConceptGet(), definitionCodeableConceptGetSwizzled(), definitionCodeableConceptIsValid(), definitionCodeableConceptNewObject(), definitionCodeableConceptSet()
property definitionDataRequirement as HS.FHIR.DTL.vR4.Model.Datatype.DataRequirement (XMLNAME = "definitionDataRequirement", XMLPROJECTION = "ELEMENT") [ Required ];
DataRequirement

What code or expression defines members?

Property methods: definitionDataRequirementGet(), definitionDataRequirementGetSwizzled(), definitionDataRequirementIsValid(), definitionDataRequirementNewObject(), definitionDataRequirementSet()
property definitionExpression as HS.FHIR.DTL.vR4.Model.Datatype.Expression (XMLNAME = "definitionExpression", XMLPROJECTION = "ELEMENT") [ Required ];
Expression

What code or expression defines members?

Property methods: definitionExpressionGet(), definitionExpressionGetSwizzled(), definitionExpressionIsValid(), definitionExpressionNewObject(), definitionExpressionSet()
property exclude as %Boolean (XMLNAME = "exclude", XMLPROJECTION = "ATTRIBUTE");
boolean

Whether the characteristic includes or excludes members.

Property methods: excludeDisplayToLogical(), excludeGet(), excludeIsValid(), excludeLogicalToDisplay(), excludeLogicalToXSD(), excludeNormalize(), excludeSet(), excludeXSDToLogical()
property participantEffectiveDateTime as %String (MAXLEN = 1000000, XMLNAME = "participantEffectiveDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

What time period do participants cover.

Property methods: participantEffectiveDateTimeDisplayToLogical(), participantEffectiveDateTimeGet(), participantEffectiveDateTimeIsValid(), participantEffectiveDateTimeLogicalToDisplay(), participantEffectiveDateTimeLogicalToOdbc(), participantEffectiveDateTimeNormalize(), participantEffectiveDateTimeSet()
property participantEffectiveDescription as %String (MAXLEN = 1000000, XMLNAME = "participantEffectiveDescription", XMLPROJECTION = "ATTRIBUTE");
string

What time period do participants cover.

Property methods: participantEffectiveDescriptionDisplayToLogical(), participantEffectiveDescriptionGet(), participantEffectiveDescriptionIsValid(), participantEffectiveDescriptionLogicalToDisplay(), participantEffectiveDescriptionLogicalToOdbc(), participantEffectiveDescriptionNormalize(), participantEffectiveDescriptionSet()
property participantEffectiveDuration as HS.FHIR.DTL.vR4.Model.Datatype.Duration (XMLNAME = "participantEffectiveDuration", XMLPROJECTION = "ELEMENT");
Duration

What time period do participants cover.

Property methods: participantEffectiveDurationGet(), participantEffectiveDurationGetSwizzled(), participantEffectiveDurationIsValid(), participantEffectiveDurationNewObject(), participantEffectiveDurationSet()
property participantEffectiveGroupMeasure as %String (MAXLEN = 1000000, XMLNAME = "participantEffectiveGroupMeasure", XMLPROJECTION = "ATTRIBUTE");
code

mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median

group-measure|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend group-measure|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: participantEffectiveGroupMeasureDisplayToLogical(), participantEffectiveGroupMeasureGet(), participantEffectiveGroupMeasureIsValid(), participantEffectiveGroupMeasureLogicalToDisplay(), participantEffectiveGroupMeasureLogicalToOdbc(), participantEffectiveGroupMeasureNormalize(), participantEffectiveGroupMeasureSet()
property participantEffectivePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "participantEffectivePeriod", XMLPROJECTION = "ELEMENT");
Period

What time period do participants cover.

Property methods: participantEffectivePeriodGet(), participantEffectivePeriodGetSwizzled(), participantEffectivePeriodIsValid(), participantEffectivePeriodNewObject(), participantEffectivePeriodSet()
property participantEffectiveTimeFromStart as HS.FHIR.DTL.vR4.Model.Datatype.Duration (XMLNAME = "participantEffectiveTimeFromStart", XMLPROJECTION = "ELEMENT");
Duration

Observation time from study start.

Property methods: participantEffectiveTimeFromStartGet(), participantEffectiveTimeFromStartGetSwizzled(), participantEffectiveTimeFromStartIsValid(), participantEffectiveTimeFromStartNewObject(), participantEffectiveTimeFromStartSet()
property participantEffectiveTiming as HS.FHIR.DTL.vR4.Model.Datatype.Timing (XMLNAME = "participantEffectiveTiming", XMLPROJECTION = "ELEMENT");
Timing

What time period do participants cover.

Property methods: participantEffectiveTimingGet(), participantEffectiveTimingGetSwizzled(), participantEffectiveTimingIsValid(), participantEffectiveTimingNewObject(), participantEffectiveTimingSet()
property studyEffectiveDateTime as %String (MAXLEN = 1000000, XMLNAME = "studyEffectiveDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

What time period does the study cover.

Property methods: studyEffectiveDateTimeDisplayToLogical(), studyEffectiveDateTimeGet(), studyEffectiveDateTimeIsValid(), studyEffectiveDateTimeLogicalToDisplay(), studyEffectiveDateTimeLogicalToOdbc(), studyEffectiveDateTimeNormalize(), studyEffectiveDateTimeSet()
property studyEffectiveDescription as %String (MAXLEN = 1000000, XMLNAME = "studyEffectiveDescription", XMLPROJECTION = "ATTRIBUTE");
string

What time period does the study cover.

Property methods: studyEffectiveDescriptionDisplayToLogical(), studyEffectiveDescriptionGet(), studyEffectiveDescriptionIsValid(), studyEffectiveDescriptionLogicalToDisplay(), studyEffectiveDescriptionLogicalToOdbc(), studyEffectiveDescriptionNormalize(), studyEffectiveDescriptionSet()
property studyEffectiveDuration as HS.FHIR.DTL.vR4.Model.Datatype.Duration (XMLNAME = "studyEffectiveDuration", XMLPROJECTION = "ELEMENT");
Duration

What time period does the study cover.

Property methods: studyEffectiveDurationGet(), studyEffectiveDurationGetSwizzled(), studyEffectiveDurationIsValid(), studyEffectiveDurationNewObject(), studyEffectiveDurationSet()
property studyEffectiveGroupMeasure as %String (MAXLEN = 1000000, XMLNAME = "studyEffectiveGroupMeasure", XMLPROJECTION = "ATTRIBUTE");
code

mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median

group-measure|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend group-measure|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: studyEffectiveGroupMeasureDisplayToLogical(), studyEffectiveGroupMeasureGet(), studyEffectiveGroupMeasureIsValid(), studyEffectiveGroupMeasureLogicalToDisplay(), studyEffectiveGroupMeasureLogicalToOdbc(), studyEffectiveGroupMeasureNormalize(), studyEffectiveGroupMeasureSet()
property studyEffectivePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "studyEffectivePeriod", XMLPROJECTION = "ELEMENT");
Period

What time period does the study cover.

Property methods: studyEffectivePeriodGet(), studyEffectivePeriodGetSwizzled(), studyEffectivePeriodIsValid(), studyEffectivePeriodNewObject(), studyEffectivePeriodSet()
property studyEffectiveTimeFromStart as HS.FHIR.DTL.vR4.Model.Datatype.Duration (XMLNAME = "studyEffectiveTimeFromStart", XMLPROJECTION = "ELEMENT");
Duration

Observation time from study start.

Property methods: studyEffectiveTimeFromStartGet(), studyEffectiveTimeFromStartGetSwizzled(), studyEffectiveTimeFromStartIsValid(), studyEffectiveTimeFromStartNewObject(), studyEffectiveTimeFromStartSet()
property studyEffectiveTiming as HS.FHIR.DTL.vR4.Model.Datatype.Timing (XMLNAME = "studyEffectiveTiming", XMLPROJECTION = "ELEMENT");
Timing

What time period does the study cover.

Property methods: studyEffectiveTimingGet(), studyEffectiveTimingGetSwizzled(), studyEffectiveTimingIsValid(), studyEffectiveTimingNewObject(), studyEffectiveTimingSet()
property unitOfMeasure as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "unitOfMeasure", XMLPROJECTION = "ELEMENT");
CodeableConcept

What unit is the outcome described in?

ucum-units|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend ucum-units|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: unitOfMeasureGet(), unitOfMeasureGetSwizzled(), unitOfMeasureIsValid(), unitOfMeasureNewObject(), unitOfMeasureSet()
property usageContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "usageContext", XMLPROJECTION = "ELEMENT");
UsageContext

What code/value pairs define members?

Property methods: usageContextBuildValueArray(), usageContextCollectionToDisplay(), usageContextCollectionToOdbc(), usageContextDisplayToCollection(), usageContextGet(), usageContextGetObject(), usageContextGetObjectId(), usageContextGetSwizzled(), usageContextIsValid(), usageContextOdbcToCollection(), usageContextSet(), usageContextSetObject(), usageContextSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab