Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.ValueSet

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

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

Property 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 XMLPROJECTION = ELEMENT;
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.

Properties

property compose as HS.FHIR.DTL.vR4.Model.Element.ValueSet.compose (XMLNAME = "compose", XMLPROJECTION = "ELEMENT");
BackboneElement

Content logical definition of the value set (CLD)

Property methods: composeGet(), composeGetSwizzled(), composeIsValid(), composeNewObject(), composeSet()
property contact as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
ContactDetail

Contact details for the publisher.

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

Use and/or publishing restrictions.

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

Date last changed.

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

Natural language description of the value set.

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

Used when the value set is \"expanded\"

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

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Additional identifier for the value set (business identifier)

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property immutable as %Boolean (XMLNAME = "immutable", XMLPROJECTION = "ATTRIBUTE");
boolean

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

Property methods: immutableDisplayToLogical(), immutableGet(), immutableIsValid(), immutableLogicalToDisplay(), immutableLogicalToXSD(), immutableNormalize(), immutableSet(), immutableXSDToLogical()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for value set (if applicable)

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

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Name for this value set (computer friendly)

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

Name of the publisher (organization or individual)

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

Why this value set is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired | unknown

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

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

Name for this value set (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Canonical identifier for this value set, represented as a URI (globally unique)

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

The context that the content is intended to support.

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");
string

Business 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