Skip to main content

HS.FHIR.vSTU3.Model.Resource.Contract.Term

deprecated class HS.FHIR.vSTU3.Model.Resource.Contract.Term extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A formal agreement between parties regarding the conduct of business, exchange of information or other matters.

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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Contract.Term;
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 = Contract.Term;
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 action as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "action", XMLPROJECTION = "ELEMENT");
Action stipulated by this Contract Provision.
Property methods: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionSet(), actionSetObject(), actionSetObjectId()
property actionReason as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "actionReason", XMLPROJECTION = "ELEMENT");
Reason or purpose for the action stipulated by this Contract Provision.
Property methods: actionReasonBuildValueArray(), actionReasonCollectionToDisplay(), actionReasonCollectionToOdbc(), actionReasonDisplayToCollection(), actionReasonGet(), actionReasonGetObject(), actionReasonGetObjectId(), actionReasonGetSwizzled(), actionReasonIsValid(), actionReasonOdbcToCollection(), actionReasonSet(), actionReasonSetObject(), actionReasonSetObjectId()
property agent as list of HS.FHIR.vSTU3.Model.Resource.Contract.Agent1 (XMLNAME = "agent", XMLPROJECTION = "ELEMENT");
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
Property methods: agentBuildValueArray(), agentCollectionToDisplay(), agentCollectionToOdbc(), agentDisplayToCollection(), agentGet(), agentGetObject(), agentGetObjectId(), agentGetSwizzled(), agentIsValid(), agentOdbcToCollection(), agentSet(), agentSetObject(), agentSetObjectId()
property applies as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "applies", XMLPROJECTION = "ELEMENT");
Relevant time or time-period when this Contract Provision is applicable.
Property methods: appliesGet(), appliesGetSwizzled(), appliesIsValid(), appliesNewObject(), appliesSet()
property group as list of HS.FHIR.vSTU3.Model.Resource.Contract.Term (XMLNAME = "group", XMLPROJECTION = "ELEMENT");
Nested group of Contract Provisions.
Property methods: groupBuildValueArray(), groupCollectionToDisplay(), groupCollectionToOdbc(), groupDisplayToCollection(), groupGet(), groupGetObject(), groupGetObjectId(), groupGetSwizzled(), groupIsValid(), groupOdbcToCollection(), groupSet(), groupSetObject(), groupSetObjectId()
property identifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Unique identifier for this particular Contract Provision.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property issued as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "issued", XMLPROJECTION = "ELEMENT");
When this Contract Provision was issued.
Property methods: issuedGet(), issuedGetSwizzled(), issuedIsValid(), issuedNewObject(), issuedSet()
property securityLabel as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "securityLabel", XMLPROJECTION = "ELEMENT");
A set of security labels that define which terms are controlled by this condition.
Property methods: securityLabelBuildValueArray(), securityLabelCollectionToDisplay(), securityLabelCollectionToOdbc(), securityLabelDisplayToCollection(), securityLabelGet(), securityLabelGetObject(), securityLabelGetObjectId(), securityLabelGetSwizzled(), securityLabelIsValid(), securityLabelOdbcToCollection(), securityLabelSet(), securityLabelSetObject(), securityLabelSetObjectId()
property subType as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "subType", XMLPROJECTION = "ELEMENT");
Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.
Property methods: subTypeGet(), subTypeGetSwizzled(), subTypeIsValid(), subTypeNewObject(), subTypeSet()
property text as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "text", XMLPROJECTION = "ELEMENT");
Human readable form of this Contract Provision.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property topic as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");
The matter of concern in the context of this provision of the agrement.
Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property valuedItem as list of HS.FHIR.vSTU3.Model.Resource.Contract.ValuedItem1 (XMLNAME = "valuedItem", XMLPROJECTION = "ELEMENT");
Contract Provision Valued Item List.
Property methods: valuedItemBuildValueArray(), valuedItemCollectionToDisplay(), valuedItemCollectionToOdbc(), valuedItemDisplayToCollection(), valuedItemGet(), valuedItemGetObject(), valuedItemGetObjectId(), valuedItemGetSwizzled(), valuedItemIsValid(), valuedItemOdbcToCollection(), valuedItemSet(), valuedItemSetObject(), valuedItemSetObjectId()

Methods

deprecated method SetAction(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 "action" property.
deprecated method SetActionReason(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 "actionReason" property.
deprecated method SetApplies(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "applies" 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 SetIssued(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 "issued" property.
deprecated method SetSecurityLabel(pCode As %String = "", pDisplay As %String = "", pSystem 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 "securityLabel" property.
deprecated method SetSubType(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.
Set method for the "subType" property.
deprecated method SetText(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 "text" property.
deprecated method SetTopic(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "topic" property.
deprecated method SetType(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.
Set method for the "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab