HS.FHIRModel.R4.Contract
class HS.FHIRModel.R4.Contract extends HS.FHIRModel.FHIRClassSuper
******************************************* Contract generated class schema
*****************************************
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Property Inventory
- _alias
- _implicitRules
- _instantiatesUri
- _issued
- _language
- _name
- _status
- _subtitle
- _title
- _url
- _version
- alias
- applies
- author
- authority
- contained
- contentDefinition
- contentDerivative
- domain
- expirationType
- extension
- fhirID
- friendly
- identifier
- implicitRules
- instantiatesCanonical
- instantiatesUri
- issued
- language
- legal
- legalState
- legallyBindingAttachment
- legallyBindingReference
- meta
- modifierExtension
- name
- relevantHistory
- resourceType
- rule
- scope
- signer
- site
- status
- subType
- subject
- subtitle
- supportingInfo
- term
- text
- title
- topicCodeableConcept
- topicReference
- type
- url
- version
Method Inventory
- IncludeAlias()
- IncludeApplies()
- IncludeAuthor()
- IncludeAuthority()
- IncludeContained()
- IncludeContentDefinition()
- IncludeContentDerivative()
- IncludeDomain()
- IncludeExpirationType()
- IncludeExtension()
- IncludeFriendly()
- IncludeIdentifier()
- IncludeInstantiatesCanonical()
- IncludeLegal()
- IncludeLegalState()
- IncludeLegallyBindingAttachment()
- IncludeLegallyBindingReference()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeRelevantHistory()
- IncludeRule()
- IncludeScope()
- IncludeSigner()
- IncludeSite()
- IncludeSubType()
- IncludeSubject()
- IncludeSupportingInfo()
- IncludeTerm()
- IncludeText()
- IncludeTopicCodeableConcept()
- IncludeTopicReference()
- IncludeType()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_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 HS.FHIRModel.R4.SeqOfElement;
Extensions for alias
Property methods: _aliasGet(), _aliasGetSwizzled(), _aliasIsValid(), _aliasNewObject(), _aliasSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiatesUri as HS.FHIRModel.R4.Element;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _issued as HS.FHIRModel.R4.Element;
Extensions for issued
Property methods: _issuedGet(), _issuedGetSwizzled(), _issuedIsValid(), _issuedNewObject(), _issuedSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _subtitle as HS.FHIRModel.R4.Element;
Extensions for subtitle
Property methods: _subtitleGet(), _subtitleGetSwizzled(), _subtitleIsValid(), _subtitleNewObject(), _subtitleSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
property alias as HS.FHIRModel.R4.SeqOfString;
Alternative representation of the title for this Contract definition,
derivative, or instance in any legal state., e.g., a domain specific
contract number related to legislation.
Property methods: aliasGet(), aliasGetSwizzled(), aliasIsValid(), aliasNewObject(), aliasSet()
property applies as HS.FHIRModel.R4.Period;
Relevant time or time-period when this Contract is applicable.
Property methods: appliesGet(), appliesGetSwizzled(), appliesIsValid(), appliesNewObject(), appliesSet()
property author as HS.FHIRModel.R4.Reference;
The individual or organization that authored the Contract definition,
derivative, or instance in any legal state.
Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property authority as HS.FHIRModel.R4.SeqOfReference;
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: authorityGet(), authorityGetSwizzled(), authorityIsValid(), authorityNewObject(), authoritySet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property contentDefinition as HS.FHIRModel.R4.ContractX.ContentDefinition;
Precusory content developed with a focus and intent of supporting
the formation a Contract instance, which may be associated with
and transformable into a Contract.
Property methods: contentDefinitionGet(), contentDefinitionGetSwizzled(), contentDefinitionIsValid(), contentDefinitionNewObject(), contentDefinitionSet()
property contentDerivative as HS.FHIRModel.R4.CodeableConcept;
The minimal content derived from the basal information source at
a specific stage in its lifecycle.
Property methods: contentDerivativeGet(), contentDerivativeGetSwizzled(), contentDerivativeIsValid(), contentDerivativeNewObject(), contentDerivativeSet()
property domain as HS.FHIRModel.R4.SeqOfReference;
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: domainGet(), domainGetSwizzled(), domainIsValid(), domainNewObject(), domainSet()
property expirationType as HS.FHIRModel.R4.CodeableConcept;
Event resulting in discontinuation or termination of this Contract
instance by one or more parties to the contract.
Property methods: expirationTypeGet(), expirationTypeGetSwizzled(), expirationTypeIsValid(), expirationTypeNewObject(), expirationTypeSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. 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;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property friendly as HS.FHIRModel.R4.ContractX.SeqOfContractXFriendly;
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: friendlyGet(), friendlyGetSwizzled(), friendlyIsValid(), friendlyNewObject(), friendlySet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Unique identifier for this Contract or a derivative that references
a Source Contract.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property instantiatesCanonical as HS.FHIRModel.R4.Reference;
The URL pointing to a FHIR-defined Contract Definition that is adhered
to in whole or part by this Contract.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as %String;
The URL pointing to an externally maintained definition that is adhered
to in whole or in part by this Contract.
Property methods: instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriSet()
property issued as %String;
When this Contract was issued.
Property methods: issuedDisplayToLogical(), issuedGet(), issuedIsValid(), issuedLogicalToDisplay(), issuedLogicalToOdbc(), issuedNormalize(), issuedSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property legal as HS.FHIRModel.R4.ContractX.SeqOfContractXLegal;
List of Legal expressions or representations of this Contract.
Property methods: legalGet(), legalGetSwizzled(), legalIsValid(), legalNewObject(), legalSet()
property legalState as HS.FHIRModel.R4.CodeableConcept;
Legal states of the formation of a legal instrument, which is a formally
executed written document that can be formally attributed to its
author, records and formally expresses a legally enforceable act,
process, or contractual duty, obligation, or right, and therefore
evidences that act, process, or agreement.
Property methods: legalStateGet(), legalStateGetSwizzled(), legalStateIsValid(), legalStateNewObject(), legalStateSet()
property legallyBindingAttachment as HS.FHIRModel.R4.Attachment;
Legally binding Contract: This is the signed and legally recognized
representation of the Contract, which is considered the "source
of truth" and which would be the basis for legal action related
to enforcement of this Contract.
Property methods: legallyBindingAttachmentGet(), legallyBindingAttachmentGetSwizzled(), legallyBindingAttachmentIsValid(), legallyBindingAttachmentNewObject(), legallyBindingAttachmentSet()
property legallyBindingReference as HS.FHIRModel.R4.Reference;
Legally binding Contract: This is the signed and legally recognized
representation of the Contract, which is considered the "source
of truth" and which would be the basis for legal action related
to enforcement of this Contract.
Property methods: legallyBindingReferenceGet(), legallyBindingReferenceGetSwizzled(), legallyBindingReferenceIsValid(), legallyBindingReferenceNewObject(), legallyBindingReferenceSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it 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 is allowed to 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 name as %String;
A natural language name identifying this Contract definition, derivative,
or instance in any legal state. Provides additional information
about its content. This name should be usable as an identifier for
the module by machine processing applications such as code generation.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property relevantHistory as HS.FHIRModel.R4.SeqOfReference;
Links to Provenance records for past versions of this Contract definition,
derivative, or instance, which identify key state transitions or
updates that are likely to be relevant to a user looking at the
current version of the Contract. The Provence.entity indicates
the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.
Property methods: relevantHistoryGet(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryNewObject(), relevantHistorySet()
property resourceType as %String [ InitialExpression = "Contract" , Required ];
This is a Contract resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property rule as HS.FHIRModel.R4.ContractX.SeqOfContractXRule;
List of Computable Policy Rule Language Representations of this Contract.
Property methods: ruleGet(), ruleGetSwizzled(), ruleIsValid(), ruleNewObject(), ruleSet()
property scope as HS.FHIRModel.R4.CodeableConcept;
A selector of legal concerns for this Contract definition, derivative,
or instance in any legal state.
Property methods: scopeGet(), scopeGetSwizzled(), scopeIsValid(), scopeNewObject(), scopeSet()
property signer as HS.FHIRModel.R4.ContractX.SeqOfContractXSigner;
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: signerGet(), signerGetSwizzled(), signerIsValid(), signerNewObject(), signerSet()
property site as HS.FHIRModel.R4.SeqOfReference;
Sites in which the contract is complied with, exercised, or in force.
Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property status as %String;
The status of the resource instance.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subType as HS.FHIRModel.R4.SeqOfCodeableConcept;
Sub-category for the Contract that distinguishes the kinds of systems
that would be interested in the Contract within the context of the
Contract's scope.
Property methods: subTypeGet(), subTypeGetSwizzled(), subTypeIsValid(), subTypeNewObject(), subTypeSet()
property subject as HS.FHIRModel.R4.SeqOfReference;
The target entity impacted by or of interest to parties to the agreement.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property subtitle as %String;
An explanatory or alternate user-friendly title for this Contract
definition, derivative, or instance in any legal state.t giving
additional information about its content.
Property methods: subtitleDisplayToLogical(), subtitleGet(), subtitleIsValid(), subtitleLogicalToDisplay(), subtitleLogicalToOdbc(), subtitleNormalize(), subtitleSet()
property supportingInfo as HS.FHIRModel.R4.SeqOfReference;
Information that may be needed by/relevant to the performer in their
execution of this term action.
Property methods: supportingInfoGet(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoNewObject(), supportingInfoSet()
property term as HS.FHIRModel.R4.ContractX.SeqOfContractXTerm;
One or more Contract Provisions, which may be related and conveyed
as a group, and may contain nested groups.
Property methods: termGet(), termGetSwizzled(), termIsValid(), termNewObject(), termSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as %String;
A short, descriptive, user-friendly title for this Contract definition,
derivative, or instance in any legal state.t giving additional information
about its content.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property topicCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Narrows the range of legal concerns to focus on the achievement of
specific contractual objectives.
Property methods: topicCodeableConceptGet(), topicCodeableConceptGetSwizzled(), topicCodeableConceptIsValid(), topicCodeableConceptNewObject(), topicCodeableConceptSet()
property topicReference as HS.FHIRModel.R4.Reference;
Narrows the range of legal concerns to focus on the achievement of
specific contractual objectives.
Property methods: topicReferenceGet(), topicReferenceGetSwizzled(), topicReferenceIsValid(), topicReferenceNewObject(), topicReferenceSet()
property type as HS.FHIRModel.R4.CodeableConcept;
A high-level category for the legal instrument, whether constructed
as a Contract definition, derivative, or instance in any legal state.
Provides additional information about its content within the context
of the Contract's scope to distinguish the kinds of systems that
would be interested in the contract.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property url as %String;
Canonical identifier for this contract, represented as a URI (globally
unique).
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property version as %String;
An edition identifier used for business purposes to label business
significant variants.
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()
Methods
method IncludeAlias()
method IncludeApplies()
method IncludeAuthor()
method IncludeAuthority()
method IncludeContained()
method IncludeContentDefinition()
method IncludeContentDerivative()
method IncludeDomain()
method IncludeExpirationType()
method IncludeExtension()
method IncludeFriendly()
method IncludeIdentifier()
method IncludeInstantiatesCanonical()
method IncludeLegal()
method IncludeLegalState()
method IncludeLegallyBindingAttachment()
method IncludeLegallyBindingReference()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeRelevantHistory()
method IncludeRule()
method IncludeScope()
method IncludeSigner()
method IncludeSite()
method IncludeSubType()
method IncludeSubject()
method IncludeSupportingInfo()
method IncludeTerm()
method IncludeText()
method IncludeTopicCodeableConcept()
method IncludeTopicReference()
method IncludeType()
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
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Contract
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()