Skip to main content

HS.FHIRModel.R4.ValueSetX.Compose

class HS.FHIRModel.R4.ValueSetX.Compose extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ValueSetX.Compose generated class schema
*****************************************
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_VALUESETX_COMPOSE;
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 _inactive as HS.FHIRModel.R4.Element;
Extensions for inactive
Property methods: _inactiveGet(), _inactiveGetSwizzled(), _inactiveIsValid(), _inactiveNewObject(), _inactiveSet()
property _lockedDate as HS.FHIRModel.R4.Element;
Extensions for lockedDate
Property methods: _lockedDateGet(), _lockedDateGetSwizzled(), _lockedDateIsValid(), _lockedDateNewObject(), _lockedDateSet()
Exclude one or more codes from the value set based on code system filters and/or other value sets.
Property methods: excludeGet(), excludeGetSwizzled(), excludeIsValid(), excludeNewObject(), excludeSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property inactive as %Boolean;
Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
Property methods: inactiveDisplayToLogical(), inactiveGet(), inactiveIsValid(), inactiveLogicalToDisplay(), inactiveLogicalToXSD(), inactiveNormalize(), inactiveSet(), inactiveXSDToLogical()
property include as HS.FHIRModel.R4.ValueSetX.SeqOfValueSetXInclude [ Required ];
Include one or more codes from a code system or other value set(s).
Property methods: includeGet(), includeGetSwizzled(), includeIsValid(), includeNewObject(), includeSet()
property lockedDate as %String;
The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
Property methods: lockedDateDisplayToLogical(), lockedDateGet(), lockedDateIsValid(), lockedDateLogicalToDisplay(), lockedDateLogicalToOdbc(), lockedDateNormalize(), lockedDateSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()

Methods

method IncludeExclude()
method IncludeExtension()
method IncludeInclude()
method IncludeModifierExtension()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab