Skip to main content

HS.FHIRModel.R4.DataRequirement

class HS.FHIRModel.R4.DataRequirement extends HS.FHIRModel.FHIRClassSuper

*****************************************
** DataRequirement generated class schema
*****************************************
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_DATAREQUIREMENT;
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 _limit as HS.FHIRModel.R4.Element;
Extensions for limit
Property methods: _limitGet(), _limitGetSwizzled(), _limitIsValid(), _limitNewObject(), _limitSet()
property _mustSupport as HS.FHIRModel.R4.SeqOfElement;
Extensions for mustSupport
Property methods: _mustSupportGet(), _mustSupportGetSwizzled(), _mustSupportIsValid(), _mustSupportNewObject(), _mustSupportSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Property methods: codeFilterGet(), codeFilterGetSwizzled(), codeFilterIsValid(), codeFilterNewObject(), codeFilterSet()
Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Property methods: dateFilterGet(), dateFilterGetSwizzled(), dateFilterIsValid(), dateFilterNewObject(), dateFilterSet()
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 limit as %Integer;
Specifies a maximum number of results that are required (uses the _count search parameter).
Property methods: limitDisplayToLogical(), limitGet(), limitIsValid(), limitLogicalToDisplay(), limitNormalize(), limitSet(), limitXSDToLogical()
property mustSupport as HS.FHIRModel.R4.SeqOfString;
Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
Property methods: mustSupportGet(), mustSupportGetSwizzled(), mustSupportIsValid(), mustSupportNewObject(), mustSupportSet()
property profile as HS.FHIRModel.R4.SeqOfString;
The profile of the required data, specified as the uri of the profile definition.
Property methods: profileGet(), profileGetSwizzled(), profileIsValid(), profileNewObject(), profileSet()
Specifies the order of the results to be returned.
Property methods: sortGet(), sortGetSwizzled(), sortIsValid(), sortNewObject(), sortSet()
property subjectCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Property methods: subjectCodeableConceptGet(), subjectCodeableConceptGetSwizzled(), subjectCodeableConceptIsValid(), subjectCodeableConceptNewObject(), subjectCodeableConceptSet()
property subjectReference as HS.FHIRModel.R4.Reference;
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Property methods: subjectReferenceGet(), subjectReferenceGetSwizzled(), subjectReferenceIsValid(), subjectReferenceNewObject(), subjectReferenceSet()
property type as %String;
The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

Methods

method IncludeCodeFilter()
method IncludeDateFilter()
method IncludeExtension()
method IncludeMustSupport()
method IncludeProfile()
method IncludeSort()
method IncludeSubjectCodeableConcept()
method IncludeSubjectReference()
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