Skip to main content

HS.FHIRModel.R4.ResearchElementDefinitionX.Characteristic

class HS.FHIRModel.R4.ResearchElementDefinitionX.Characteristic extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ResearchElementDefinitionX.Characteristic generated class schema
*****************************************
The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_RESEARCHELEMENTDEFINITIONX_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 HS.FHIRModel.R4.Element;
Extensions for definitionCanonical
Property methods: _definitionCanonicalGet(), _definitionCanonicalGetSwizzled(), _definitionCanonicalIsValid(), _definitionCanonicalNewObject(), _definitionCanonicalSet()
property _exclude as HS.FHIRModel.R4.Element;
Extensions for exclude
Property methods: _excludeGet(), _excludeGetSwizzled(), _excludeIsValid(), _excludeNewObject(), _excludeSet()
property _participantEffectiveDateTime as HS.FHIRModel.R4.Element;
Extensions for participantEffectiveDateTime
Property methods: _participantEffectiveDateTimeGet(), _participantEffectiveDateTimeGetSwizzled(), _participantEffectiveDateTimeIsValid(), _participantEffectiveDateTimeNewObject(), _participantEffectiveDateTimeSet()
property _participantEffectiveDescription as HS.FHIRModel.R4.Element;
Extensions for participantEffectiveDescription
Property methods: _participantEffectiveDescriptionGet(), _participantEffectiveDescriptionGetSwizzled(), _participantEffectiveDescriptionIsValid(), _participantEffectiveDescriptionNewObject(), _participantEffectiveDescriptionSet()
property _participantEffectiveGroupMeasure as HS.FHIRModel.R4.Element;
Extensions for participantEffectiveGroupMeasure
Property methods: _participantEffectiveGroupMeasureGet(), _participantEffectiveGroupMeasureGetSwizzled(), _participantEffectiveGroupMeasureIsValid(), _participantEffectiveGroupMeasureNewObject(), _participantEffectiveGroupMeasureSet()
property _studyEffectiveDateTime as HS.FHIRModel.R4.Element;
Extensions for studyEffectiveDateTime
Property methods: _studyEffectiveDateTimeGet(), _studyEffectiveDateTimeGetSwizzled(), _studyEffectiveDateTimeIsValid(), _studyEffectiveDateTimeNewObject(), _studyEffectiveDateTimeSet()
property _studyEffectiveDescription as HS.FHIRModel.R4.Element;
Extensions for studyEffectiveDescription
Property methods: _studyEffectiveDescriptionGet(), _studyEffectiveDescriptionGetSwizzled(), _studyEffectiveDescriptionIsValid(), _studyEffectiveDescriptionNewObject(), _studyEffectiveDescriptionSet()
property _studyEffectiveGroupMeasure as HS.FHIRModel.R4.Element;
Extensions for studyEffectiveGroupMeasure
Property methods: _studyEffectiveGroupMeasureGet(), _studyEffectiveGroupMeasureGetSwizzled(), _studyEffectiveGroupMeasureIsValid(), _studyEffectiveGroupMeasureNewObject(), _studyEffectiveGroupMeasureSet()
property definitionCanonical as %String;
Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
Property methods: definitionCanonicalDisplayToLogical(), definitionCanonicalGet(), definitionCanonicalIsValid(), definitionCanonicalLogicalToDisplay(), definitionCanonicalLogicalToOdbc(), definitionCanonicalNormalize(), definitionCanonicalSet()
property definitionCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
Property methods: definitionCodeableConceptGet(), definitionCodeableConceptGetSwizzled(), definitionCodeableConceptIsValid(), definitionCodeableConceptNewObject(), definitionCodeableConceptSet()
property definitionDataRequirement as HS.FHIRModel.R4.DataRequirement;
Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
Property methods: definitionDataRequirementGet(), definitionDataRequirementGetSwizzled(), definitionDataRequirementIsValid(), definitionDataRequirementNewObject(), definitionDataRequirementSet()
property definitionExpression as HS.FHIRModel.R4.Expression;
Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
Property methods: definitionExpressionGet(), definitionExpressionGetSwizzled(), definitionExpressionIsValid(), definitionExpressionNewObject(), definitionExpressionSet()
property exclude as %Boolean;
When true, members with this characteristic are excluded from the element.
Property methods: excludeDisplayToLogical(), excludeGet(), excludeIsValid(), excludeLogicalToDisplay(), excludeLogicalToXSD(), excludeNormalize(), excludeSet(), excludeXSDToLogical()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property participantEffectiveDateTime as %String;
Indicates what effective period the study covers.
Property methods: participantEffectiveDateTimeDisplayToLogical(), participantEffectiveDateTimeGet(), participantEffectiveDateTimeIsValid(), participantEffectiveDateTimeLogicalToDisplay(), participantEffectiveDateTimeLogicalToOdbc(), participantEffectiveDateTimeNormalize(), participantEffectiveDateTimeSet()
property participantEffectiveDescription as %String;
A narrative description of the time period the study covers.
Property methods: participantEffectiveDescriptionDisplayToLogical(), participantEffectiveDescriptionGet(), participantEffectiveDescriptionIsValid(), participantEffectiveDescriptionLogicalToDisplay(), participantEffectiveDescriptionLogicalToOdbc(), participantEffectiveDescriptionNormalize(), participantEffectiveDescriptionSet()
property participantEffectiveDuration as HS.FHIRModel.R4.Duration;
Indicates what effective period the study covers.
Property methods: participantEffectiveDurationGet(), participantEffectiveDurationGetSwizzled(), participantEffectiveDurationIsValid(), participantEffectiveDurationNewObject(), participantEffectiveDurationSet()
property participantEffectiveGroupMeasure as %String (VALUELIST = ",mean,median,mean-of-mean,mean-of-median,median-of-mean,median-of-median");
Indicates how elements are aggregated within the study effective period.
Property methods: participantEffectiveGroupMeasureDisplayToLogical(), participantEffectiveGroupMeasureGet(), participantEffectiveGroupMeasureIsValid(), participantEffectiveGroupMeasureLogicalToDisplay(), participantEffectiveGroupMeasureLogicalToOdbc(), participantEffectiveGroupMeasureNormalize(), participantEffectiveGroupMeasureSet()
property participantEffectivePeriod as HS.FHIRModel.R4.Period;
Indicates what effective period the study covers.
Property methods: participantEffectivePeriodGet(), participantEffectivePeriodGetSwizzled(), participantEffectivePeriodIsValid(), participantEffectivePeriodNewObject(), participantEffectivePeriodSet()
property participantEffectiveTimeFromStart as HS.FHIRModel.R4.Duration;
Indicates duration from the participant's study entry.
Property methods: participantEffectiveTimeFromStartGet(), participantEffectiveTimeFromStartGetSwizzled(), participantEffectiveTimeFromStartIsValid(), participantEffectiveTimeFromStartNewObject(), participantEffectiveTimeFromStartSet()
property participantEffectiveTiming as HS.FHIRModel.R4.Timing;
Indicates what effective period the study covers.
Property methods: participantEffectiveTimingGet(), participantEffectiveTimingGetSwizzled(), participantEffectiveTimingIsValid(), participantEffectiveTimingNewObject(), participantEffectiveTimingSet()
property studyEffectiveDateTime as %String;
Indicates what effective period the study covers.
Property methods: studyEffectiveDateTimeDisplayToLogical(), studyEffectiveDateTimeGet(), studyEffectiveDateTimeIsValid(), studyEffectiveDateTimeLogicalToDisplay(), studyEffectiveDateTimeLogicalToOdbc(), studyEffectiveDateTimeNormalize(), studyEffectiveDateTimeSet()
property studyEffectiveDescription as %String;
A narrative description of the time period the study covers.
Property methods: studyEffectiveDescriptionDisplayToLogical(), studyEffectiveDescriptionGet(), studyEffectiveDescriptionIsValid(), studyEffectiveDescriptionLogicalToDisplay(), studyEffectiveDescriptionLogicalToOdbc(), studyEffectiveDescriptionNormalize(), studyEffectiveDescriptionSet()
property studyEffectiveDuration as HS.FHIRModel.R4.Duration;
Indicates what effective period the study covers.
Property methods: studyEffectiveDurationGet(), studyEffectiveDurationGetSwizzled(), studyEffectiveDurationIsValid(), studyEffectiveDurationNewObject(), studyEffectiveDurationSet()
property studyEffectiveGroupMeasure as %String (VALUELIST = ",mean,median,mean-of-mean,mean-of-median,median-of-mean,median-of-median");
Indicates how elements are aggregated within the study effective period.
Property methods: studyEffectiveGroupMeasureDisplayToLogical(), studyEffectiveGroupMeasureGet(), studyEffectiveGroupMeasureIsValid(), studyEffectiveGroupMeasureLogicalToDisplay(), studyEffectiveGroupMeasureLogicalToOdbc(), studyEffectiveGroupMeasureNormalize(), studyEffectiveGroupMeasureSet()
property studyEffectivePeriod as HS.FHIRModel.R4.Period;
Indicates what effective period the study covers.
Property methods: studyEffectivePeriodGet(), studyEffectivePeriodGetSwizzled(), studyEffectivePeriodIsValid(), studyEffectivePeriodNewObject(), studyEffectivePeriodSet()
property studyEffectiveTimeFromStart as HS.FHIRModel.R4.Duration;
Indicates duration from the study initiation.
Property methods: studyEffectiveTimeFromStartGet(), studyEffectiveTimeFromStartGetSwizzled(), studyEffectiveTimeFromStartIsValid(), studyEffectiveTimeFromStartNewObject(), studyEffectiveTimeFromStartSet()
property studyEffectiveTiming as HS.FHIRModel.R4.Timing;
Indicates what effective period the study covers.
Property methods: studyEffectiveTimingGet(), studyEffectiveTimingGetSwizzled(), studyEffectiveTimingIsValid(), studyEffectiveTimingNewObject(), studyEffectiveTimingSet()
property unitOfMeasure as HS.FHIRModel.R4.CodeableConcept;
Specifies the UCUM unit for the outcome.
Property methods: unitOfMeasureGet(), unitOfMeasureGetSwizzled(), unitOfMeasureIsValid(), unitOfMeasureNewObject(), unitOfMeasureSet()
property usageContext as HS.FHIRModel.R4.SeqOfUsageContext;
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.
Property methods: usageContextGet(), usageContextGetSwizzled(), usageContextIsValid(), usageContextNewObject(), usageContextSet()

Methods

method IncludeDefinitionCodeableConcept()
method IncludeDefinitionDataRequirement()
method IncludeDefinitionExpression()
method IncludeExtension()
method IncludeModifierExtension()
method IncludeParticipantEffectiveDuration()
method IncludeParticipantEffectivePeriod()
method IncludeParticipantEffectiveTimeFromStart()
method IncludeParticipantEffectiveTiming()
method IncludeStudyEffectiveDuration()
method IncludeStudyEffectivePeriod()
method IncludeStudyEffectiveTimeFromStart()
method IncludeStudyEffectiveTiming()
method IncludeUnitOfMeasure()
method IncludeUsageContext()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab