Skip to main content

HS.FHIR.vSTU3.Model.Resource.Questionnaire.Item

deprecated class HS.FHIR.vSTU3.Model.Resource.Questionnaire.Item extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

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 = Questionnaire.Item;
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 = Questionnaire.Item;
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 code as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property definition as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
A reference to an [[[ElementDefinition]]] that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition: * code (ElementDefinition.code)* type (ElementDefinition.type)* required (ElementDefinition.min)* repeats (ElementDefinition.max)* maxLength (ElementDefinition.maxLength)* options (ElementDefinition.binding)Any information provided in these elements on a Questionnaire Item overrides the information from the definition.
Property methods: definitionGet(), definitionGetSwizzled(), definitionIsValid(), definitionNewObject(), definitionSet()
property enableWhen as list of HS.FHIR.vSTU3.Model.Resource.Questionnaire.EnableWhen (XMLNAME = "enableWhen", XMLPROJECTION = "ELEMENT");
A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
Property methods: enableWhenBuildValueArray(), enableWhenCollectionToDisplay(), enableWhenCollectionToOdbc(), enableWhenDisplayToCollection(), enableWhenGet(), enableWhenGetObject(), enableWhenGetObjectId(), enableWhenGetSwizzled(), enableWhenIsValid(), enableWhenOdbcToCollection(), enableWhenSet(), enableWhenSetObject(), enableWhenSetObjectId()
property initialAttachment as HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "initialAttachment", XMLPROJECTION = "ELEMENT");
Property methods: initialAttachmentGet(), initialAttachmentGetSwizzled(), initialAttachmentIsValid(), initialAttachmentNewObject(), initialAttachmentSet()
property initialBoolean as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "initialBoolean", XMLPROJECTION = "ELEMENT");
Property methods: initialBooleanGet(), initialBooleanGetSwizzled(), initialBooleanIsValid(), initialBooleanNewObject(), initialBooleanSet()
property initialCoding as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "initialCoding", XMLPROJECTION = "ELEMENT");
Property methods: initialCodingGet(), initialCodingGetSwizzled(), initialCodingIsValid(), initialCodingNewObject(), initialCodingSet()
property initialDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "initialDate", XMLPROJECTION = "ELEMENT");
Property methods: initialDateGet(), initialDateGetSwizzled(), initialDateIsValid(), initialDateNewObject(), initialDateSet(), initialDateTimeGet(), initialDateTimeGetSwizzled(), initialDateTimeIsValid(), initialDateTimeNewObject(), initialDateTimeSet()
property initialDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "initialDateTime", XMLPROJECTION = "ELEMENT");
Property methods: initialDateTimeGet(), initialDateTimeGetSwizzled(), initialDateTimeIsValid(), initialDateTimeNewObject(), initialDateTimeSet()
property initialDecimal as HS.FHIR.vSTU3.Model.Datatype.Decimal (XMLNAME = "initialDecimal", XMLPROJECTION = "ELEMENT");
Property methods: initialDecimalGet(), initialDecimalGetSwizzled(), initialDecimalIsValid(), initialDecimalNewObject(), initialDecimalSet()
property initialInteger as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "initialInteger", XMLPROJECTION = "ELEMENT");
Property methods: initialIntegerGet(), initialIntegerGetSwizzled(), initialIntegerIsValid(), initialIntegerNewObject(), initialIntegerSet()
property initialQuantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "initialQuantity", XMLPROJECTION = "ELEMENT");
Property methods: initialQuantityGet(), initialQuantityGetSwizzled(), initialQuantityIsValid(), initialQuantityNewObject(), initialQuantitySet()
property initialReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "initialReference", XMLPROJECTION = "ELEMENT");
Property methods: initialReferenceGet(), initialReferenceGetSwizzled(), initialReferenceIsValid(), initialReferenceNewObject(), initialReferenceSet()
property initialString as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "initialString", XMLPROJECTION = "ELEMENT");
Property methods: initialStringGet(), initialStringGetSwizzled(), initialStringIsValid(), initialStringNewObject(), initialStringSet()
property initialTime as HS.FHIR.vSTU3.Model.Datatype.Time (XMLNAME = "initialTime", XMLPROJECTION = "ELEMENT");
Property methods: initialTimeGet(), initialTimeGetSwizzled(), initialTimeIsValid(), initialTimeNewObject(), initialTimeSet()
property initialUri as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "initialUri", XMLPROJECTION = "ELEMENT");
Property methods: initialUriGet(), initialUriGetSwizzled(), initialUriIsValid(), initialUriNewObject(), initialUriSet()
property item as list of HS.FHIR.vSTU3.Model.Resource.Questionnaire.Item (XMLNAME = "item", XMLPROJECTION = "ELEMENT");
Text, questions and other groups to be nested beneath a question or group.
Property methods: itemBuildValueArray(), itemCollectionToDisplay(), itemCollectionToOdbc(), itemDisplayToCollection(), itemGet(), itemGetObject(), itemGetObjectId(), itemGetSwizzled(), itemIsValid(), itemOdbcToCollection(), itemSet(), itemSetObject(), itemSetObjectId()
property linkId as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "linkId", XMLPROJECTION = "ELEMENT") [ Required ];
An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
Property methods: linkIdGet(), linkIdGetSwizzled(), linkIdIsValid(), linkIdNewObject(), linkIdSet()
property maxLength as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "maxLength", XMLPROJECTION = "ELEMENT");
The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.
Property methods: maxLengthGet(), maxLengthGetSwizzled(), maxLengthIsValid(), maxLengthNewObject(), maxLengthSet()
property option as list of HS.FHIR.vSTU3.Model.Resource.Questionnaire.Option (XMLNAME = "option", XMLPROJECTION = "ELEMENT");
One of the permitted answers for a "choice" or "open-choice" question.
Property methods: optionBuildValueArray(), optionCollectionToDisplay(), optionCollectionToOdbc(), optionDisplayToCollection(), optionGet(), optionGetObject(), optionGetObjectId(), optionGetSwizzled(), optionIsValid(), optionOdbcToCollection(), optionSet(), optionSetObject(), optionSetObjectId(), optionsGet(), optionsGetSwizzled(), optionsIsValid(), optionsNewObject(), optionsSet()
property options as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "options", XMLPROJECTION = "ELEMENT");
A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.
Property methods: optionsGet(), optionsGetSwizzled(), optionsIsValid(), optionsNewObject(), optionsSet()
property prefix as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "prefix", XMLPROJECTION = "ELEMENT");
A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
Property methods: prefixGet(), prefixGetSwizzled(), prefixIsValid(), prefixNewObject(), prefixSet()
property readOnly as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "readOnly", XMLPROJECTION = "ELEMENT");
An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
Property methods: readOnlyGet(), readOnlyGetSwizzled(), readOnlyIsValid(), readOnlyNewObject(), readOnlySet()
property repeats as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "repeats", XMLPROJECTION = "ELEMENT");
An indication, if true, that the item may occur multiple times in the response, collecting multiple answers answers for questions or multiple sets of answers for groups.
Property methods: repeatsGet(), repeatsGetSwizzled(), repeatsIsValid(), repeatsNewObject(), repeatsSet()
property required as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "required", XMLPROJECTION = "ELEMENT");
An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.
Property methods: requiredGet(), requiredGetSwizzled(), requiredIsValid(), requiredNewObject(), requiredSet()
property text as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "text", XMLPROJECTION = "ELEMENT");
The name of a section, the text of a question or text content for a display item.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property type as HS.FHIR.vSTU3.Model.Base.QuestionnaireItemType (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

deprecated method SetCode(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 "code" property.
deprecated method SetDefinition(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 "definition" property.
deprecated method SetInitialAttachment(pContentType As %String = "", pLanguage As %String = "", pData As %String = "", pUrl As %String = "", pSize As %String = "", pHash As %String = "", pTitle As %String = "", pCreation As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "initialAttachment" property.
deprecated method SetInitialBoolean(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 "initialBoolean" property.
deprecated method SetInitialCoding(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.
Set method for the "initialCoding" property.
deprecated method SetInitialDate(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 "initialDate" property.
deprecated method SetInitialDateTime(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 "initialDateTime" property.
deprecated method SetInitialDecimal(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 "initialDecimal" property.
deprecated method SetInitialInteger(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 "initialInteger" property.
deprecated method SetInitialQuantity(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "initialQuantity" property.
deprecated method SetInitialReference(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 "initialReference" property.
deprecated method SetInitialString(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 "initialString" property.
deprecated method SetInitialTime(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 "initialTime" property.
deprecated method SetInitialUri(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 "initialUri" property.
deprecated method SetLinkId(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 "linkId" property.
deprecated method SetMaxLength(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 "maxLength" property.
deprecated method SetOptions(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 "options" property.
deprecated method SetPrefix(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 "prefix" property.
deprecated method SetReadOnly(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 "readOnly" property.
deprecated method SetRepeats(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 "repeats" property.
deprecated method SetRequired(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 "required" property.
deprecated method SetText(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 "text" property.
deprecated method SetType(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 "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab