Skip to main content

HS.FHIR.vSTU3.Model.Base.DataRequirement.CodeFilter

deprecated class HS.FHIR.vSTU3.Model.Base.DataRequirement.CodeFilter extends HS.FHIR.vSTU3.Model.Base.Element

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Property Inventory

Method 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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = DataRequirement.CodeFilter;
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.CodeFilter;
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 path as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "path", XMLPROJECTION = "ELEMENT") [ Required ];
The code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Property methods: pathGet(), pathGetSwizzled(), pathIsValid(), pathNewObject(), pathSet()
property valueCode as list of HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "valueCode", XMLPROJECTION = "ELEMENT");
The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes.
Property methods: valueCodeBuildValueArray(), valueCodeCollectionToDisplay(), valueCodeCollectionToOdbc(), valueCodeDisplayToCollection(), valueCodeGet(), valueCodeGetObject(), valueCodeGetObjectId(), valueCodeGetSwizzled(), valueCodeIsValid(), valueCodeOdbcToCollection(), valueCodeSet(), valueCodeSetObject(), valueCodeSetObjectId()
property valueCodeableConcept as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "valueCodeableConcept", XMLPROJECTION = "ELEMENT");
The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified CodeableConcepts.
Property methods: valueCodeableConceptBuildValueArray(), valueCodeableConceptCollectionToDisplay(), valueCodeableConceptCollectionToOdbc(), valueCodeableConceptDisplayToCollection(), valueCodeableConceptGet(), valueCodeableConceptGetObject(), valueCodeableConceptGetObjectId(), valueCodeableConceptGetSwizzled(), valueCodeableConceptIsValid(), valueCodeableConceptOdbcToCollection(), valueCodeableConceptSet(), valueCodeableConceptSetObject(), valueCodeableConceptSetObjectId()
property valueCoding as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "valueCoding", XMLPROJECTION = "ELEMENT");
The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified Codings.
Property methods: valueCodingBuildValueArray(), valueCodingCollectionToDisplay(), valueCodingCollectionToOdbc(), valueCodingDisplayToCollection(), valueCodingGet(), valueCodingGetObject(), valueCodingGetObjectId(), valueCodingGetSwizzled(), valueCodingIsValid(), valueCodingOdbcToCollection(), valueCodingSet(), valueCodingSetObject(), valueCodingSetObjectId()
property valueSetReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "valueSetReference", XMLPROJECTION = "ELEMENT");
Property methods: valueSetReferenceGet(), valueSetReferenceGetSwizzled(), valueSetReferenceIsValid(), valueSetReferenceNewObject(), valueSetReferenceSet()
property valueSetString as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "valueSetString", XMLPROJECTION = "ELEMENT");
Property methods: valueSetStringGet(), valueSetStringGetSwizzled(), valueSetStringIsValid(), valueSetStringNewObject(), valueSetStringSet()

Methods

deprecated method SetPath(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "path" property.
deprecated method SetValueCode(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "valueCode" property.
deprecated method SetValueCodeableConcept(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "valueCodeableConcept" property.
deprecated method SetValueCoding(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "valueCoding" property.
deprecated method SetValueSetReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueSetReference" property.
deprecated method SetValueSetString(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueSetString" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab