Skip to main content

HS.FHIR.vDSTU2.Model.Resource.ValueSet

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 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.

Properties

property codeSystem as HS.FHIR.vDSTU2.Model.Resource.ValueSet.CodeSystem (XMLNAME = "codeSystem");
A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to it's (codeSystem.system) directly.
Property methods: codeSystemGet(), codeSystemGetSwizzled(), codeSystemIsValid(), codeSystemNewObject(), codeSystemSet()
property compose as HS.FHIR.vDSTU2.Model.Resource.ValueSet.Compose (XMLNAME = "compose");
A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.
Property methods: composeGet(), composeGetSwizzled(), composeIsValid(), composeNewObject(), composeSet()
property contact as list of HS.FHIR.vDSTU2.Model.Resource.ValueSet.Contact (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contacts to assist a user in finding and communicating with the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
Property methods: copyrightGet(), copyrightGetSwizzled(), copyrightIsValid(), copyrightNewObject(), copyrightSet()
property date as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "date") [ SqlFieldName = _date ];
The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition').
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property description as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "description");
A free text natural language description of the use of the value set - reason for definition,"the semantic space" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property expansion as HS.FHIR.vDSTU2.Model.Resource.ValueSet.Expansion (XMLNAME = "expansion");
A value set can also be"expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
Property methods: expansionGet(), expansionGetSwizzled(), expansionIsValid(), expansionNewObject(), expansionSet()
property experimental as HS.FHIR.vDSTU2.Model.Datatype.Boolean (XMLNAME = "experimental");
This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Property methods: experimentalGet(), experimentalGetSwizzled(), experimentalIsValid(), experimentalNewObject(), experimentalSet()
property extensible as HS.FHIR.vDSTU2.Model.Datatype.Boolean (XMLNAME = "extensible");
Whether this is intended to be used with an extensible binding or not.
Property methods: extensibleGet(), extensibleGetSwizzled(), extensibleIsValid(), extensibleNewObject(), extensibleSet()
property identifier as HS.FHIR.vDSTU2.Model.Base.Identifier (XMLNAME = "identifier");
Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property immutable as HS.FHIR.vDSTU2.Model.Datatype.Boolean (XMLNAME = "immutable");
If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
Property methods: immutableGet(), immutableGetSwizzled(), immutableIsValid(), immutableNewObject(), immutableSet()
property lockedDate as HS.FHIR.vDSTU2.Model.Datatype.Date (XMLNAME = "lockedDate");
If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date.
Property methods: lockedDateGet(), lockedDateGetSwizzled(), lockedDateIsValid(), lockedDateNewObject(), lockedDateSet()
property name as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "name");
A free text natural language name describing the value set.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property publisher as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "publisher");
The name of the individual or organization that published the value set.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property requirements as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "requirements");
Explains why this value set is needed and why it has been constrained as it has.
Property methods: requirementsGet(), requirementsGetSwizzled(), requirementsIsValid(), requirementsNewObject(), requirementsSet()
property status as HS.FHIR.vDSTU2.Model.Datatype.Code (XMLNAME = "status") [ Required ];
The status of the value set.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property url as HS.FHIR.vDSTU2.Model.Datatype.Uri (XMLNAME = "url");
An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published.
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property useContext as list of HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "version");
Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
Property methods: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()

Methods

deprecated method SetCopyright(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 "copyright" property.
deprecated method SetDate(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 "date" property.
deprecated method SetDescription(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 "description" property.
deprecated method SetExperimental(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 "experimental" property.
deprecated method SetExtensible(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 "extensible" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "identifier" property.
deprecated method SetImmutable(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 "immutable" property.
deprecated method SetLockedDate(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 "lockedDate" property.
deprecated method SetName(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 "name" property.
deprecated method SetPublisher(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 "publisher" property.
deprecated method SetRequirements(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 "requirements" property.
deprecated method SetStatus(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 "status" property.
deprecated method SetUrl(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 "url" property.
deprecated method SetUseContext(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 "useContext" property.
deprecated method SetVersion(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 "version" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab