Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Contract

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

Legal Agreement.

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 alias as list of %String (MAXLEN = 1000000, XMLNAME = "alias", XMLPROJECTION = "ELEMENT");
string

Acronym or short name.

Property methods: aliasBuildValueArray(), aliasCollectionToDisplay(), aliasCollectionToOdbc(), aliasDisplayToCollection(), aliasDisplayToLogical(), aliasGet(), aliasGetObject(), aliasGetObjectId(), aliasGetSwizzled(), aliasIsValid(), aliasLogicalToDisplay(), aliasLogicalToOdbc(), aliasNormalize(), aliasOdbcToCollection(), aliasSet(), aliasSetObject(), aliasSetObjectId()
property applies as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "applies", XMLPROJECTION = "ELEMENT");
Period

Effective time.

Property methods: appliesGet(), appliesGetSwizzled(), appliesIsValid(), appliesNewObject(), appliesSet()
property author as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");
Reference

Source of Contract.

Patient | Practitioner | PractitionerRole | Organization

Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet(), authorityBuildValueArray(), authorityCollectionToDisplay(), authorityCollectionToOdbc(), authorityDisplayToCollection(), authorityGet(), authorityGetObject(), authorityGetObjectId(), authorityGetSwizzled(), authorityIsValid(), authorityOdbcToCollection(), authoritySet(), authoritySetObject(), authoritySetObjectId()
property authority as list of HS.FHIR.DTL.vR4.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 contentDefinition as HS.FHIR.DTL.vR4.Model.Element.Contract.contentDefinition (XMLNAME = "contentDefinition", XMLPROJECTION = "ELEMENT");
BackboneElement

Contract precursor content.

Property methods: contentDefinitionGet(), contentDefinitionGetSwizzled(), contentDefinitionIsValid(), contentDefinitionNewObject(), contentDefinitionSet()
property contentDerivative as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "contentDerivative", XMLPROJECTION = "ELEMENT");
CodeableConcept

Content derived from the basal information.

any FHIR4 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 domain as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "domain", XMLPROJECTION = "ELEMENT");
Reference

A sphere of control governed by an authoritative jurisdiction, organization, or person.

Location

Property methods: domainBuildValueArray(), domainCollectionToDisplay(), domainCollectionToOdbc(), domainDisplayToCollection(), domainGet(), domainGetObject(), domainGetObjectId(), domainGetSwizzled(), domainIsValid(), domainOdbcToCollection(), domainSet(), domainSetObject(), domainSetObjectId()
property expirationType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "expirationType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Contract cessation cause.

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

Property methods: expirationTypeGet(), expirationTypeGetSwizzled(), expirationTypeIsValid(), expirationTypeNewObject(), expirationTypeSet()
property friendly as list of HS.FHIR.DTL.vR4.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 list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Contract number.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property instantiatesCanonical as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "instantiatesCanonical", XMLPROJECTION = "ELEMENT");
Reference

Source Contract Definition.

Contract

Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as %String (MAXLEN = 1000000, XMLNAME = "instantiatesUri", XMLPROJECTION = "ATTRIBUTE");
uri

External Contract Definition.

Property methods: instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriSet()
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()
BackboneElement

Contract Legal Language.

Property methods: legalBuildValueArray(), legalCollectionToDisplay(), legalCollectionToOdbc(), legalDisplayToCollection(), legalGet(), legalGetObject(), legalGetObjectId(), legalGetSwizzled(), legalIsValid(), legalOdbcToCollection(), legalSet(), legalSetObject(), legalSetObjectId(), legalStateGet(), legalStateGetSwizzled(), legalStateIsValid(), legalStateNewObject(), legalStateSet(), legallyBindingAttachmentGet(), legallyBindingAttachmentGetSwizzled(), legallyBindingAttachmentIsValid(), legallyBindingAttachmentNewObject(), legallyBindingAttachmentSet(), legallyBindingReferenceGet(), legallyBindingReferenceGetSwizzled(), legallyBindingReferenceIsValid(), legallyBindingReferenceNewObject(), legallyBindingReferenceSet()
property legalState as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "legalState", XMLPROJECTION = "ELEMENT");
CodeableConcept

Negotiation status.

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

Property methods: legalStateGet(), legalStateGetSwizzled(), legalStateIsValid(), legalStateNewObject(), legalStateSet()
property legallyBindingAttachment as HS.FHIR.DTL.vR4.Model.Datatype.Attachment (XMLNAME = "legallyBindingAttachment", XMLPROJECTION = "ELEMENT");
Attachment

Binding Contract.

Property methods: legallyBindingAttachmentGet(), legallyBindingAttachmentGetSwizzled(), legallyBindingAttachmentIsValid(), legallyBindingAttachmentNewObject(), legallyBindingAttachmentSet()
property legallyBindingReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "legallyBindingReference", XMLPROJECTION = "ELEMENT");
Reference

Binding Contract.

Composition | DocumentReference | QuestionnaireResponse | Contract

Property methods: legallyBindingReferenceGet(), legallyBindingReferenceGetSwizzled(), legallyBindingReferenceIsValid(), legallyBindingReferenceNewObject(), legallyBindingReferenceSet()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Computer friendly designation.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property relevantHistory as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "relevantHistory", XMLPROJECTION = "ELEMENT");
Reference

Key event in Contract History.

Provenance

Property methods: relevantHistoryBuildValueArray(), relevantHistoryCollectionToDisplay(), relevantHistoryCollectionToOdbc(), relevantHistoryDisplayToCollection(), relevantHistoryGet(), relevantHistoryGetObject(), relevantHistoryGetObjectId(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryOdbcToCollection(), relevantHistorySet(), relevantHistorySetObject(), relevantHistorySetObjectId()
property rule as list of HS.FHIR.DTL.vR4.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 scope as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "scope", XMLPROJECTION = "ELEMENT");
CodeableConcept

Range of Legal Concerns.

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

Property methods: scopeGet(), scopeGetSwizzled(), scopeIsValid(), scopeNewObject(), scopeSet()
property signer as list of HS.FHIR.DTL.vR4.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 site as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "site", XMLPROJECTION = "ELEMENT");
Reference

Specific Location.

Location

Property methods: siteBuildValueArray(), siteCollectionToDisplay(), siteCollectionToOdbc(), siteDisplayToCollection(), siteGet(), siteGetObject(), siteGetObjectId(), siteGetSwizzled(), siteIsValid(), siteOdbcToCollection(), siteSet(), siteSetObject(), siteSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");
code

amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated

contract-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend contract-status|4.0.1 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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "subType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Subtype within the context of type.

any FHIR4 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.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

Contract Target Entity.

Any FHIR4 Resource may be indicated by this Reference

Property methods: subjectBuildValueArray(), subjectCollectionToDisplay(), subjectCollectionToOdbc(), subjectDisplayToCollection(), subjectGet(), subjectGetObject(), subjectGetObjectId(), subjectGetSwizzled(), subjectIsValid(), subjectOdbcToCollection(), subjectSet(), subjectSetObject(), subjectSetObjectId()
property subtitle as %String (MAXLEN = 1000000, XMLNAME = "subtitle", XMLPROJECTION = "ATTRIBUTE");
string

Subordinate Friendly name.

Property methods: subtitleDisplayToLogical(), subtitleGet(), subtitleIsValid(), subtitleLogicalToDisplay(), subtitleLogicalToOdbc(), subtitleNormalize(), subtitleSet()
property supportingInfo as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supportingInfo", XMLPROJECTION = "ELEMENT");
Reference

Extra Information.

Any FHIR4 Resource may be indicated by this Reference

Property methods: supportingInfoBuildValueArray(), supportingInfoCollectionToDisplay(), supportingInfoCollectionToOdbc(), supportingInfoDisplayToCollection(), supportingInfoGet(), supportingInfoGetObject(), supportingInfoGetObjectId(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoOdbcToCollection(), supportingInfoSet(), supportingInfoSetObject(), supportingInfoSetObjectId()
property term as list of HS.FHIR.DTL.vR4.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 title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string

Human Friendly name.

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property topicCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "topicCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

Focus of contract interest.

any FHIR4 code from any ValueSet may be used.

Property methods: topicCodeableConceptGet(), topicCodeableConceptGetSwizzled(), topicCodeableConceptIsValid(), topicCodeableConceptNewObject(), topicCodeableConceptSet()
property topicReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "topicReference", XMLPROJECTION = "ELEMENT");
Reference

Focus of contract interest.

Any FHIR4 Resource may be indicated by this Reference.

Property methods: topicReferenceGet(), topicReferenceGetSwizzled(), topicReferenceIsValid(), topicReferenceNewObject(), topicReferenceSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Legal instrument category.

any FHIR4 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 url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Basal definition.

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Business edition.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab