Skip to main content


class HS.FHIR.DTL.vDSTU2.Model.Resource.ValueSet extends HS.FHIR.DTL.vDSTU2.Model.Base.DomainResource

A set of codes drawn from one or more code systems.

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 = ValueSet;
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 = ValueSet;
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 codeSystem as HS.FHIR.DTL.vDSTU2.Model.Element.ValueSet.codeSystem (XMLNAME = "codeSystem", XMLPROJECTION = "ELEMENT");

An inline code system, which is part of this value set.

Property methods: codeSystemGet(), codeSystemGetSwizzled(), codeSystemIsValid(), codeSystemNewObject(), codeSystemSet()
property compose as HS.FHIR.DTL.vDSTU2.Model.Element.ValueSet.compose (XMLNAME = "compose", XMLPROJECTION = "ELEMENT");

When value set includes codes from elsewhere.

Property methods: composeGet(), composeGetSwizzled(), composeIsValid(), composeNewObject(), composeSet()
property contact as list of (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

Contact details of the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()

Use and/or publishing restrictions.

Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");

Date for given status.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Human language description of the value set.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property expansion as HS.FHIR.DTL.vDSTU2.Model.Element.ValueSet.expansion (XMLNAME = "expansion", XMLPROJECTION = "ELEMENT");

Used when the value set is "expanded"

Property methods: expansionGet(), expansionGetSwizzled(), expansionIsValid(), expansionNewObject(), expansionSet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");

If for testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property extensible as %Boolean (XMLNAME = "extensible", XMLPROJECTION = "ATTRIBUTE");

Whether this is intended to be used with an extensible binding.

Property methods: extensibleDisplayToLogical(), extensibleGet(), extensibleIsValid(), extensibleLogicalToDisplay(), extensibleLogicalToXSD(), extensibleNormalize(), extensibleSet(), extensibleXSDToLogical()
property identifier as HS.FHIR.DTL.vDSTU2.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Additional identifier for the value set (e.g. HL7 v2 / CDA)

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property immutable as %Boolean (XMLNAME = "immutable", XMLPROJECTION = "ATTRIBUTE");

Indicates whether or not any change to the content logical definition may occur.

Property methods: immutableDisplayToLogical(), immutableGet(), immutableIsValid(), immutableLogicalToDisplay(), immutableLogicalToXSD(), immutableNormalize(), immutableSet(), immutableXSDToLogical()
property lockedDate as %String (MAXLEN = 1000000, XMLNAME = "lockedDate", XMLPROJECTION = "ATTRIBUTE");

Fixed date for all referenced code systems and value sets.

Property methods: lockedDateDisplayToLogical(), lockedDateGet(), lockedDateIsValid(), lockedDateLogicalToDisplay(), lockedDateLogicalToOdbc(), lockedDateNormalize(), lockedDateSet()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");

Informal name for this value set.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property requirements as %String (MAXLEN = 1000000, XMLNAME = "requirements", XMLPROJECTION = "ATTRIBUTE");

Why needed.

Property methods: requirementsDisplayToLogical(), requirementsGet(), requirementsIsValid(), requirementsLogicalToDisplay(), requirementsLogicalToOdbc(), requirementsNormalize(), requirementsSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

draft | active | retired

conformance-resource-status is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend conformance-resource-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");

Globally unique logical identifier for value set.

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");

Content intends to support these contexts.

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

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");

Logical identifier for this version of the value set.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab