Skip to main content

HS.FHIR.vSTU3.Model.Resource.Contract

deprecated class HS.FHIR.vSTU3.Model.Resource.Contract extends HS.FHIR.vSTU3.Model.Base.DomainResource

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.
If the element is present, it must have either a @value, an @id, or extensions

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 = Contract;
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 action as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "action", XMLPROJECTION = "ELEMENT");
Action stipulated by this Contract.
Property methods: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionReasonBuildValueArray(), actionReasonCollectionToDisplay(), actionReasonCollectionToOdbc(), actionReasonDisplayToCollection(), actionReasonGet(), actionReasonGetObject(), actionReasonGetObjectId(), actionReasonGetSwizzled(), actionReasonIsValid(), actionReasonOdbcToCollection(), actionReasonSet(), actionReasonSetObject(), actionReasonSetObjectId(), actionSet(), actionSetObject(), actionSetObjectId()
property actionReason as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "actionReason", XMLPROJECTION = "ELEMENT");
Reason for action stipulated by this Contract.
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.Agent (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 is applicable.
Property methods: appliesGet(), appliesGetSwizzled(), appliesIsValid(), appliesNewObject(), appliesSet()
property authority as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "authority", XMLPROJECTION = "ELEMENT");
A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.
Property methods: authorityBuildValueArray(), authorityCollectionToDisplay(), authorityCollectionToOdbc(), authorityDisplayToCollection(), authorityGet(), authorityGetObject(), authorityGetObjectId(), authorityGetSwizzled(), authorityIsValid(), authorityOdbcToCollection(), authoritySet(), authoritySetObject(), authoritySetObjectId()
property bindingAttachment as HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "bindingAttachment", XMLPROJECTION = "ELEMENT");
Property methods: bindingAttachmentGet(), bindingAttachmentGetSwizzled(), bindingAttachmentIsValid(), bindingAttachmentNewObject(), bindingAttachmentSet()
property bindingReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "bindingReference", XMLPROJECTION = "ELEMENT");
Property methods: bindingReferenceGet(), bindingReferenceGetSwizzled(), bindingReferenceIsValid(), bindingReferenceNewObject(), bindingReferenceSet()
property contentDerivative as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "contentDerivative", XMLPROJECTION = "ELEMENT");
The minimal content derived from the basal information source at a specific stage in its lifecycle.
Property methods: contentDerivativeGet(), contentDerivativeGetSwizzled(), contentDerivativeIsValid(), contentDerivativeNewObject(), contentDerivativeSet()
property decisionType as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "decisionType", XMLPROJECTION = "ELEMENT");
The type of decision made by a grantor with respect to an offer made by a grantee.
Property methods: decisionTypeGet(), decisionTypeGetSwizzled(), decisionTypeIsValid(), decisionTypeNewObject(), decisionTypeSet()
property domain as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "domain", XMLPROJECTION = "ELEMENT");
Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
Property methods: domainBuildValueArray(), domainCollectionToDisplay(), domainCollectionToOdbc(), domainDisplayToCollection(), domainGet(), domainGetObject(), domainGetObjectId(), domainGetSwizzled(), domainIsValid(), domainOdbcToCollection(), domainSet(), domainSetObject(), domainSetObjectId()
property friendly as list of HS.FHIR.vSTU3.Model.Resource.Contract.Friendly (XMLNAME = "friendly", XMLPROJECTION = "ELEMENT");
The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
Property methods: friendlyBuildValueArray(), friendlyCollectionToDisplay(), friendlyCollectionToOdbc(), friendlyDisplayToCollection(), friendlyGet(), friendlyGetObject(), friendlyGetObjectId(), friendlyGetSwizzled(), friendlyIsValid(), friendlyOdbcToCollection(), friendlySet(), friendlySetObject(), friendlySetObjectId()
property identifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Unique identifier for this Contract.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property issued as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "issued", XMLPROJECTION = "ELEMENT");
When this Contract was issued.
Property methods: issuedGet(), issuedGetSwizzled(), issuedIsValid(), issuedNewObject(), issuedSet()
List of Legal expressions or representations of this Contract.
Property methods: legalBuildValueArray(), legalCollectionToDisplay(), legalCollectionToOdbc(), legalDisplayToCollection(), legalGet(), legalGetObject(), legalGetObjectId(), legalGetSwizzled(), legalIsValid(), legalOdbcToCollection(), legalSet(), legalSetObject(), legalSetObjectId()
property rule as list of HS.FHIR.vSTU3.Model.Resource.Contract.Rule (XMLNAME = "rule", XMLPROJECTION = "ELEMENT");
List of Computable Policy Rule Language Representations of this Contract.
Property methods: ruleBuildValueArray(), ruleCollectionToDisplay(), ruleCollectionToOdbc(), ruleDisplayToCollection(), ruleGet(), ruleGetObject(), ruleGetObjectId(), ruleGetSwizzled(), ruleIsValid(), ruleOdbcToCollection(), ruleSet(), ruleSetObject(), ruleSetObjectId()
property securityLabel as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "securityLabel", XMLPROJECTION = "ELEMENT");
A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
Property methods: securityLabelBuildValueArray(), securityLabelCollectionToDisplay(), securityLabelCollectionToOdbc(), securityLabelDisplayToCollection(), securityLabelGet(), securityLabelGetObject(), securityLabelGetObjectId(), securityLabelGetSwizzled(), securityLabelIsValid(), securityLabelOdbcToCollection(), securityLabelSet(), securityLabelSetObject(), securityLabelSetObjectId()
property signer as list of HS.FHIR.vSTU3.Model.Resource.Contract.Signer (XMLNAME = "signer", XMLPROJECTION = "ELEMENT");
Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
Property methods: signerBuildValueArray(), signerCollectionToDisplay(), signerCollectionToOdbc(), signerDisplayToCollection(), signerGet(), signerGetObject(), signerGetObjectId(), signerGetSwizzled(), signerIsValid(), signerOdbcToCollection(), signerSet(), signerSetObject(), signerSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.ContractResourceStatusCodes (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
The status of the resource instance.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subType as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "subType", XMLPROJECTION = "ELEMENT");
More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.
Property methods: subTypeBuildValueArray(), subTypeCollectionToDisplay(), subTypeCollectionToOdbc(), subTypeDisplayToCollection(), subTypeGet(), subTypeGetObject(), subTypeGetObjectId(), subTypeGetSwizzled(), subTypeIsValid(), subTypeOdbcToCollection(), subTypeSet(), subTypeSetObject(), subTypeSetObjectId()
property subject as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
The target entity impacted by or of interest to parties to the agreement.
Property methods: subjectBuildValueArray(), subjectCollectionToDisplay(), subjectCollectionToOdbc(), subjectDisplayToCollection(), subjectGet(), subjectGetObject(), subjectGetObjectId(), subjectGetSwizzled(), subjectIsValid(), subjectOdbcToCollection(), subjectSet(), subjectSetObject(), subjectSetObjectId()
property term as list of HS.FHIR.vSTU3.Model.Resource.Contract.Term (XMLNAME = "term", XMLPROJECTION = "ELEMENT");
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
Property methods: termBuildValueArray(), termCollectionToDisplay(), termCollectionToOdbc(), termDisplayToCollection(), termGet(), termGetObject(), termGetObjectId(), termGetSwizzled(), termIsValid(), termOdbcToCollection(), termSet(), termSetObject(), termSetObjectId()
property topic as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");
The matter of concern in the context of this agreement.
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 such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property valuedItem as list of HS.FHIR.vSTU3.Model.Resource.Contract.ValuedItem (XMLNAME = "valuedItem", XMLPROJECTION = "ELEMENT");
Contract 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 SetAuthority(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 "authority" property.
deprecated method SetBindingAttachment(pContentType As %String = "", pLanguage As %String = "", pData As %String = "", pUrl As %String = "", pSize As %String = "", pHash As %String = "", pTitle As %String = "", pCreation 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 "bindingAttachment" property.
deprecated method SetBindingReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "bindingReference" property.
deprecated method SetContentDerivative(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 "contentDerivative" property.
deprecated method SetDecisionType(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 "decisionType" property.
deprecated method SetDomain(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 "domain" 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 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 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.
Insert method for the "subType" property.
deprecated method SetSubject(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 "subject" 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