Skip to main content


class HS.FHIR.DTL.vR4.Model.Datatype.DataRequirement extends HS.FHIR.DTL.vR4.Model.Base.Element

Describes a required data item.

Property Inventory


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 = DataRequirement;
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 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 = 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.


property codeFilter as list of HS.FHIR.DTL.vR4.Model.Element.DataRequirement.codeFilter (XMLNAME = "codeFilter", XMLPROJECTION = "ELEMENT");

What codes are expected.

Property methods: codeFilterBuildValueArray(), codeFilterCollectionToDisplay(), codeFilterCollectionToOdbc(), codeFilterDisplayToCollection(), codeFilterGet(), codeFilterGetObject(), codeFilterGetObjectId(), codeFilterGetSwizzled(), codeFilterIsValid(), codeFilterOdbcToCollection(), codeFilterSet(), codeFilterSetObject(), codeFilterSetObjectId()
property dateFilter as list of HS.FHIR.DTL.vR4.Model.Element.DataRequirement.dateFilter (XMLNAME = "dateFilter", XMLPROJECTION = "ELEMENT");

What dates/date ranges are expected.

Property methods: dateFilterBuildValueArray(), dateFilterCollectionToDisplay(), dateFilterCollectionToOdbc(), dateFilterDisplayToCollection(), dateFilterGet(), dateFilterGetObject(), dateFilterGetObjectId(), dateFilterGetSwizzled(), dateFilterIsValid(), dateFilterOdbcToCollection(), dateFilterSet(), dateFilterSetObject(), dateFilterSetObjectId()
property limit as %Integer (XMLNAME = "limit", XMLPROJECTION = "ATTRIBUTE");

Number of results.

Property methods: limitDisplayToLogical(), limitGet(), limitIsValid(), limitLogicalToDisplay(), limitNormalize(), limitSet(), limitXSDToLogical()
property mustSupport as list of %String (MAXLEN = 1000000, XMLNAME = "mustSupport", XMLPROJECTION = "ELEMENT");

Indicates specific structure elements that are referenced by the knowledge module.

Property methods: mustSupportBuildValueArray(), mustSupportCollectionToDisplay(), mustSupportCollectionToOdbc(), mustSupportDisplayToCollection(), mustSupportDisplayToLogical(), mustSupportGet(), mustSupportGetObject(), mustSupportGetObjectId(), mustSupportGetSwizzled(), mustSupportIsValid(), mustSupportLogicalToDisplay(), mustSupportLogicalToOdbc(), mustSupportNormalize(), mustSupportOdbcToCollection(), mustSupportSet(), mustSupportSetObject(), mustSupportSetObjectId()
property profile as list of %String (MAXLEN = 1000000, XMLNAME = "profile", XMLPROJECTION = "ELEMENT");

The profile of the required data.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: profileBuildValueArray(), profileCollectionToDisplay(), profileCollectionToOdbc(), profileDisplayToCollection(), profileDisplayToLogical(), profileGet(), profileGetObject(), profileGetObjectId(), profileGetSwizzled(), profileIsValid(), profileLogicalToDisplay(), profileLogicalToOdbc(), profileNormalize(), profileOdbcToCollection(), profileSet(), profileSetObject(), profileSetObjectId()
property sort as list of HS.FHIR.DTL.vR4.Model.Element.DataRequirement.sort (XMLNAME = "sort", XMLPROJECTION = "ELEMENT");

Order of the results.

Property methods: sortBuildValueArray(), sortCollectionToDisplay(), sortCollectionToOdbc(), sortDisplayToCollection(), sortGet(), sortGetObject(), sortGetObjectId(), sortGetSwizzled(), sortIsValid(), sortOdbcToCollection(), sortSet(), sortSetObject(), sortSetObjectId()
property subjectCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "subjectCodeableConcept", XMLPROJECTION = "ELEMENT");

E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device.

subject-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in subject-type, you may formally EXTEND subject-type to add codes to it.

Property methods: subjectCodeableConceptGet(), subjectCodeableConceptGetSwizzled(), subjectCodeableConceptIsValid(), subjectCodeableConceptNewObject(), subjectCodeableConceptSet()
property subjectReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subjectReference", XMLPROJECTION = "ELEMENT");

E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device.


Property methods: subjectReferenceGet(), subjectReferenceGetSwizzled(), subjectReferenceIsValid(), subjectReferenceNewObject(), subjectReferenceSet()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];

The type of the required data.

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

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab