Skip to main content

HS.FHIRModel.R4.ElementDefinitionX.Constraint

class HS.FHIRModel.R4.ElementDefinitionX.Constraint extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ElementDefinitionX.Constraint generated class schema
*****************************************
Captures constraints on each element within the resource, profile, or extension.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_ELEMENTDEFINITIONX_CONSTRAINT;
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 _expression as HS.FHIRModel.R4.Element;
Extensions for expression
Property methods: _expressionGet(), _expressionGetSwizzled(), _expressionIsValid(), _expressionNewObject(), _expressionSet()
property _human as HS.FHIRModel.R4.Element;
Extensions for human
Property methods: _humanGet(), _humanGetSwizzled(), _humanIsValid(), _humanNewObject(), _humanSet()
property _key as HS.FHIRModel.R4.Element;
Extensions for key
Property methods: _keyGet(), _keyGetSwizzled(), _keyIsValid(), _keyNewObject(), _keySet()
property _requirements as HS.FHIRModel.R4.Element;
Extensions for requirements
Property methods: _requirementsGet(), _requirementsGetSwizzled(), _requirementsIsValid(), _requirementsNewObject(), _requirementsSet()
property _severity as HS.FHIRModel.R4.Element;
Extensions for severity
Property methods: _severityGet(), _severityGetSwizzled(), _severityIsValid(), _severityNewObject(), _severitySet()
property _xpath as HS.FHIRModel.R4.Element;
Extensions for xpath
Property methods: _xpathGet(), _xpathGetSwizzled(), _xpathIsValid(), _xpathNewObject(), _xpathSet()
property expression as %String;
A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.
Property methods: expressionDisplayToLogical(), expressionGet(), expressionIsValid(), expressionLogicalToDisplay(), expressionLogicalToOdbc(), expressionNormalize(), expressionSet()
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 human as %String;
Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
Property methods: humanDisplayToLogical(), humanGet(), humanIsValid(), humanLogicalToDisplay(), humanLogicalToOdbc(), humanNormalize(), humanSet()
property key as %String;
Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
Property methods: keyDisplayToLogical(), keyGet(), keyIsValid(), keyLogicalToDisplay(), keyLogicalToOdbc(), keyNormalize(), keySet()
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()
property requirements as %String;
Description of why this constraint is necessary or appropriate.
Property methods: requirementsDisplayToLogical(), requirementsGet(), requirementsIsValid(), requirementsLogicalToDisplay(), requirementsLogicalToOdbc(), requirementsNormalize(), requirementsSet()
property severity as %String (VALUELIST = ",error,warning");
Identifies the impact constraint violation has on the conformance of the instance.
Property methods: severityDisplayToLogical(), severityGet(), severityIsValid(), severityLogicalToDisplay(), severityLogicalToOdbc(), severityNormalize(), severitySet()
property source as %String;
A reference to the original source of the constraint, for traceability purposes.
Property methods: sourceDisplayToLogical(), sourceGet(), sourceIsValid(), sourceLogicalToDisplay(), sourceLogicalToOdbc(), sourceNormalize(), sourceSet()
property xpath as %String;
An XPath expression of constraint that can be executed to see if this constraint is met.
Property methods: xpathDisplayToLogical(), xpathGet(), xpathIsValid(), xpathLogicalToDisplay(), xpathLogicalToOdbc(), xpathNormalize(), xpathSet()

Methods

method IncludeExtension()
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