Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (24)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.Contract

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

A formal agreement between parties regarding the conduct of business, exchange of information or other matters.

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 = 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 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 = Contract;

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.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "action", XMLPROJECTION = "ELEMENT");

CodeableConcept

Action stipulated by this Contract.

any FHIR3 code may be used; contract-action shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionSet(), actionSetObject(), actionSetObjectId()

property actionReason as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "actionReason", XMLPROJECTION = "ELEMENT");

CodeableConcept

Rationale for the stiplulated action.

any FHIR3 code may be used; v3-ActReason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: actionReasonBuildValueArray(), actionReasonCollectionToDisplay(), actionReasonCollectionToOdbc(), actionReasonDisplayToCollection(), actionReasonGet(), actionReasonGetObject(), actionReasonGetObjectId(), actionReasonGetSwizzled(), actionReasonIsValid(), actionReasonOdbcToCollection(), actionReasonSet(), actionReasonSetObject(), actionReasonSetObjectId()

property agent as list of HS.FHIR.DTL.vSTU3.Model.Element.Contract.agent (XMLNAME = "agent", XMLPROJECTION = "ELEMENT");

BackboneElement

Entity being ascribed responsibility.

Property methods: agentBuildValueArray(), agentCollectionToDisplay(), agentCollectionToOdbc(), agentDisplayToCollection(), agentGet(), agentGetObject(), agentGetObjectId(), agentGetSwizzled(), agentIsValid(), agentOdbcToCollection(), agentSet(), agentSetObject(), agentSetObjectId()

property applies as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "applies", XMLPROJECTION = "ELEMENT");

Period

Effective time.

Property methods: appliesGet(), appliesGetSwizzled(), appliesIsValid(), appliesNewObject(), appliesSet()

property authority as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "authority", XMLPROJECTION = "ELEMENT");

Reference

Authority under which this Contract has standing.

Organization

Property methods: authorityBuildValueArray(), authorityCollectionToDisplay(), authorityCollectionToOdbc(), authorityDisplayToCollection(), authorityGet(), authorityGetObject(), authorityGetObjectId(), authorityGetSwizzled(), authorityIsValid(), authorityOdbcToCollection(), authoritySet(), authoritySetObject(), authoritySetObjectId()

property bindingAttachment as HS.FHIR.DTL.vSTU3.Model.Datatype.Attachment (XMLNAME = "bindingAttachment", XMLPROJECTION = "ELEMENT");

Attachment

Binding Contract.

Property methods: bindingAttachmentGet(), bindingAttachmentGetSwizzled(), bindingAttachmentIsValid(), bindingAttachmentNewObject(), bindingAttachmentSet()

property bindingReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "bindingReference", XMLPROJECTION = "ELEMENT");

Reference

Binding Contract.

Composition | DocumentReference | QuestionnaireResponse

Property methods: bindingReferenceGet(), bindingReferenceGetSwizzled(), bindingReferenceIsValid(), bindingReferenceNewObject(), bindingReferenceSet()

property contentDerivative as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "contentDerivative", XMLPROJECTION = "ELEMENT");

CodeableConcept

Content derived from the basal information.

any FHIR3 code may be used; contract-content-derivative shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: contentDerivativeGet(), contentDerivativeGetSwizzled(), contentDerivativeIsValid(), contentDerivativeNewObject(), contentDerivativeSet()

property decisionType as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "decisionType", XMLPROJECTION = "ELEMENT");

CodeableConcept

Decision by Grantor.

v3-ActCode is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in v3-ActCode, you may formally EXTEND v3-ActCode to add codes to it.

Property methods: decisionTypeGet(), decisionTypeGetSwizzled(), decisionTypeIsValid(), decisionTypeNewObject(), decisionTypeSet()

property domain as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "domain", XMLPROJECTION = "ELEMENT");

Reference

Domain in which this Contract applies.

Location

Property methods: domainBuildValueArray(), domainCollectionToDisplay(), domainCollectionToOdbc(), domainDisplayToCollection(), domainGet(), domainGetObject(), domainGetObjectId(), domainGetSwizzled(), domainIsValid(), domainOdbcToCollection(), domainSet(), domainSetObject(), domainSetObjectId()

property friendly as list of HS.FHIR.DTL.vSTU3.Model.Element.Contract.friendly (XMLNAME = "friendly", XMLPROJECTION = "ELEMENT");

BackboneElement

Contract Friendly Language.

Property methods: friendlyBuildValueArray(), friendlyCollectionToDisplay(), friendlyCollectionToOdbc(), friendlyDisplayToCollection(), friendlyGet(), friendlyGetObject(), friendlyGetObjectId(), friendlyGetSwizzled(), friendlyIsValid(), friendlyOdbcToCollection(), friendlySet(), friendlySetObject(), friendlySetObjectId()

property identifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier

Contract number.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()

property issued as %String (MAXLEN = 1000000, XMLNAME = "issued", XMLPROJECTION = "ATTRIBUTE");

dateTime

When this Contract was issued.

Property methods: issuedDisplayToLogical(), issuedGet(), issuedIsValid(), issuedLogicalToDisplay(), issuedLogicalToOdbc(), issuedNormalize(), issuedSet()

property legal as list of HS.FHIR.DTL.vSTU3.Model.Element.Contract.legal (XMLNAME = "legal", XMLPROJECTION = "ELEMENT");

BackboneElement

Contract Legal Language.

Property methods: legalBuildValueArray(), legalCollectionToDisplay(), legalCollectionToOdbc(), legalDisplayToCollection(), legalGet(), legalGetObject(), legalGetObjectId(), legalGetSwizzled(), legalIsValid(), legalOdbcToCollection(), legalSet(), legalSetObject(), legalSetObjectId()

property rule as list of HS.FHIR.DTL.vSTU3.Model.Element.Contract.rule (XMLNAME = "rule", XMLPROJECTION = "ELEMENT");

BackboneElement

Computable Contract Language.

Property methods: ruleBuildValueArray(), ruleCollectionToDisplay(), ruleCollectionToOdbc(), ruleDisplayToCollection(), ruleGet(), ruleGetObject(), ruleGetObjectId(), ruleGetSwizzled(), ruleIsValid(), ruleOdbcToCollection(), ruleSet(), ruleSetObject(), ruleSetObjectId()

property securityLabel as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "securityLabel", XMLPROJECTION = "ELEMENT");

Coding

Security Labels that define affected resources.

security-labels is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in security-labels, you may formally EXTEND security-labels to add codes to it.

Property methods: securityLabelBuildValueArray(), securityLabelCollectionToDisplay(), securityLabelCollectionToOdbc(), securityLabelDisplayToCollection(), securityLabelGet(), securityLabelGetObject(), securityLabelGetObjectId(), securityLabelGetSwizzled(), securityLabelIsValid(), securityLabelOdbcToCollection(), securityLabelSet(), securityLabelSetObject(), securityLabelSetObjectId()

property signer as list of HS.FHIR.DTL.vSTU3.Model.Element.Contract.signer (XMLNAME = "signer", XMLPROJECTION = "ELEMENT");

BackboneElement

Contract Signatory.

Property methods: signerBuildValueArray(), signerCollectionToDisplay(), signerCollectionToOdbc(), signerDisplayToCollection(), signerGet(), signerGetObject(), signerGetObjectId(), signerGetSwizzled(), signerIsValid(), signerOdbcToCollection(), signerSet(), signerSetObject(), signerSetObjectId()

property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

code

contract-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend contract-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

property subType as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "subType", XMLPROJECTION = "ELEMENT");

CodeableConcept

Subtype within the context of type.

any FHIR3 code may be used; contract-subtype shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: subTypeBuildValueArray(), subTypeCollectionToDisplay(), subTypeCollectionToOdbc(), subTypeDisplayToCollection(), subTypeGet(), subTypeGetObject(), subTypeGetObjectId(), subTypeGetSwizzled(), subTypeIsValid(), subTypeOdbcToCollection(), subTypeSet(), subTypeSetObject(), subTypeSetObjectId()

property subject as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Reference

Contract Target Entity.

Any FHIR3 Resource may be indicated by this Reference

Property methods: subjectBuildValueArray(), subjectCollectionToDisplay(), subjectCollectionToOdbc(), subjectDisplayToCollection(), subjectGet(), subjectGetObject(), subjectGetObjectId(), subjectGetSwizzled(), subjectIsValid(), subjectOdbcToCollection(), subjectSet(), subjectSetObject(), subjectSetObjectId()

property term as list of HS.FHIR.DTL.vSTU3.Model.Element.Contract.term (XMLNAME = "term", XMLPROJECTION = "ELEMENT");

BackboneElement

Contract Term List.

Property methods: termBuildValueArray(), termCollectionToDisplay(), termCollectionToOdbc(), termDisplayToCollection(), termGet(), termGetObject(), termGetObjectId(), termGetSwizzled(), termIsValid(), termOdbcToCollection(), termSet(), termSetObject(), termSetObjectId()

property topic as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");

Reference

Context of the Contract.

Any FHIR3 Resource may be indicated by this Reference

Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()

property type as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

CodeableConcept

Type or form.

any FHIR3 code may be used; contract-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

property valuedItem as list of HS.FHIR.DTL.vSTU3.Model.Element.Contract.valuedItem (XMLNAME = "valuedItem", XMLPROJECTION = "ELEMENT");

BackboneElement

Contract Valued Item List.

Property methods: valuedItemBuildValueArray(), valuedItemCollectionToDisplay(), valuedItemCollectionToOdbc(), valuedItemDisplayToCollection(), valuedItemGet(), valuedItemGetObject(), valuedItemGetObjectId(), valuedItemGetSwizzled(), valuedItemIsValid(), valuedItemOdbcToCollection(), valuedItemSet(), valuedItemSetObject(), valuedItemSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

Feedback