Data Model Libraries
    Preparing search index...

    Contract Class

    Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

    FHIR Specification

    • Short: Legal Agreement
    • Definition: Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getLegalState setLegalState hasLegalState getInstantiatesCanonical setInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri hasInstantiatesUri getContentDerivative setContentDerivative hasContentDerivative getIssuedElement setIssuedElement hasIssuedElement getIssued setIssued hasIssued getApplies setApplies hasApplies getExpirationType setExpirationType hasExpirationType getSubject setSubject addSubject hasSubject getAuthority setAuthority addAuthority hasAuthority getDomain setDomain addDomain hasDomain getSite setSite addSite hasSite getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getSubtitleElement setSubtitleElement hasSubtitleElement getSubtitle setSubtitle hasSubtitle getAliasElement setAliasElement addAliasElement hasAliasElement getAlias setAlias addAlias hasAlias getAuthor setAuthor hasAuthor getScope setScope hasScope getTopic setTopic hasTopic getTopicCodeableConcept hasTopicCodeableConcept getTopicReference hasTopicReference getType setType hasType getSubType setSubType addSubType hasSubType getContentDefinition setContentDefinition hasContentDefinition getTerm setTerm addTerm hasTerm getSupportingInfo setSupportingInfo addSupportingInfo hasSupportingInfo getRelevantHistory setRelevantHistory addRelevantHistory hasRelevantHistory getSigner setSigner addSigner hasSigner getFriendly setFriendly addFriendly hasFriendly getLegal setLegal addLegal hasLegal getRule setRule addRule hasRule getLegallyBinding setLegallyBinding hasLegallyBinding getLegallyBindingAttachment hasLegallyBindingAttachment getLegallyBindingReference hasLegallyBindingReference fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initSubject initAuthority initDomain initSite initAlias initSubType initTerm initSupportingInfo initRelevantHistory initSigner initFriendly initLegal initRule

    Constructors

    Properties

    identifier?: Identifier[]

    Contract.identifier Element

    FHIR Specification

    • Short: Contract number
    • Definition: Unique identifier for this Contract or a derivative that references a Source Contract.
    • Requirements: This is the business identifier of the contract content conveyed. It may be a derivative of the legally binding contract, in which case, the identifier of the basal contract is contained in the Contract.binding referenced Contract.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    url?: UriType

    Contract.url Element

    FHIR Specification

    • Short: Basal definition
    • Definition: Canonical identifier for this contract, represented as a URI (globally unique).
    • Comment: Used in a domain that uses a supplied contract repository.
    • Requirements: An absolute URI that is used to identify this contract when it is referenced in a specification, model, design, instance or a contract derivative; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which this plan definition is (or will be) published.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    version?: StringType

    Contract.version Element

    FHIR Specification

    • Short: Business edition
    • Definition: An edition identifier used for business purposes to label business significant variants.
    • Comment: Note - This is a business versionId, not a resource version id (see discussion http://build.fhir.org/https://hl7.org/fhir/resource.html#versions) Comments - There may be different contract instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].
    • Requirements: The identifier that is used to identify this version of the contract when it is referenced in a specification, model, design, instance, or contract derivative. This is an arbitrary value managed by the contract author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contractStatusEnum: ContractStatusEnum

    FHIR CodeSystem: ContractStatus

    status?: EnumCodeType

    Contract.status Element

    FHIR Specification

    • Short: amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
    • Definition: The status of the resource instance.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active.
    • Requirements: This is the Contract Business Workflow Status.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: ContractStatusEnum

    legalState?: CodeableConcept

    Contract.legalState Element

    FHIR Specification

    • Short: Negotiation status
    • Definition: 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.
    • Requirements: The legal state of a contract follows a prescribed flow as defined by the legal community and these state may be indepenedent of the workflow state.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    instantiatesCanonical?: Reference

    Contract.instantiatesCanonical Element

    FHIR Specification

    • Short: Source Contract Definition
    • Definition: The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    instantiatesUri?: UriType

    Contract.instantiatesUri Element

    FHIR Specification

    • Short: External Contract Definition
    • Definition: The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    contentDerivative?: CodeableConcept

    Contract.contentDerivative Element

    FHIR Specification

    • Short: Content derived from the basal information
    • Definition: The minimal content derived from the basal information source at a specific stage in its lifecycle.
    • Requirements: In the context of a contract, the information source of the content derivative shall be the information referenced by the contract.binding. The Contract Resource may function simply as the computable representation of the executed contract, which may be the attached to the Contract Resource as the "binding" or as the "friendly" electronic form. For example, a Contract Resource may be automatically populated with the values expressed in a related QuestionnaireResponse. However, the Contract Resource may be considered the legally binding contract if it is the only "executed" form of this contract, and includes the signatures as *The Contract Resource may function as the computable representation of an application or offer in a pre-executed Contract if the grantor has not entered any values. In this case, it is populated with values in a "legal" form of the application or offer or by the values in an associated Questionnaire. If the grantor has filled in the legal form or the associated Questionnaire Response, then these values are used to populate a pre-executed Contract Resource. If the Contract.topic is considered an application or offer, then the policy is often required to be attached as the "legal" basis for the application to ensure "informed consent" to the contract, and that any discrepancy between the application and the policy are interpreted against the policy. Implementers should check organizational and jurisdictional policies to determine the relationship among multiple representations of a contract pre- and post-execution.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    issued?: DateTimeType

    Contract.issued Element

    FHIR Specification

    • Short: When this Contract was issued
    • Definition: When this Contract was issued.
    • Requirements: The Contract issuance dateTime often precedes the Contract effective dateTime.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    applies?: Period

    Contract.applies Element

    FHIR Specification

    • Short: Effective time
    • Definition: Relevant time or time-period when this Contract is applicable.
    • Requirements: The dateTime upon which the Contract is binding.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    expirationType?: CodeableConcept

    Contract.expirationType Element

    FHIR Specification

    • Short: Contract cessation cause
    • Definition: Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    subject?: Reference[]

    Contract.subject Element

    FHIR Specification

    • Short: Contract Target Entity
    • Definition: The target entity impacted by or of interest to parties to the agreement.
    • Comment: The Contract.subject is an entity that has some role with respect to the Contract.topic and Contract.topic.term, which is of focal interest to the parties to the contract and likely impacted in a significant way by the Contract.action/Contract.action.reason and the Contract.term.action/Contract.action.reason. In many cases, the Contract.subject is a Contract.signer if the subject is an adult; has a legal interest in the contract; and incompetent to participate in the contract agreement.
    • Requirements: The Contract.subject is an entity that has some role with respect to the Contract.topic and Contract.topic.term, which is of focal interest to the parties to the contract and likely impacted in a significant way by the Contract.action/Contract.action.reason and the Contract.term.action/Contract.action.reason. In many cases, the Contract.subject is a Contract.signer if the subject is an adult; has a legal interest in the contract; and incompetent to participate in the contract agreement.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    authority?: Reference[]

    Contract.authority Element

    FHIR Specification

    • Short: Authority under which this Contract has standing
    • Definition: 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.
    • Requirements: The governance framework responsible for ensuring compliance with or enforcement of the contract or policy.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    domain?: Reference[]

    Contract.domain Element

    FHIR Specification

    • Short: A sphere of control governed by an authoritative jurisdiction, organization, or person
    • Definition: 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.
    • Requirements: The entities bound by governance to comply with the enforcement of contracts or policies by a recognized authority.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    site?: Reference[]

    Contract.site Element

    FHIR Specification

    • Short: Specific Location
    • Definition: Sites in which the contract is complied with, exercised, or in force.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    name?: StringType

    Contract.name Element

    FHIR Specification

    • Short: Computer friendly designation
    • Definition: 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.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    Contract.title Element

    FHIR Specification

    • Short: Human Friendly name
    • Definition: A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subtitle?: StringType

    Contract.subtitle Element

    FHIR Specification

    • Short: Subordinate Friendly name
    • Definition: 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    alias?: StringType[]

    Contract.alias Element

    FHIR Specification

    • Short: Acronym or short name
    • Definition: 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.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    author?: Reference

    Contract.author Element

    FHIR Specification

    Contract.scope Element

    FHIR Specification

    • Short: Range of Legal Concerns
    • Definition: A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    topic?: IDataType

    Contract.topic[x] Element

    @ChoiceDataTypesMeta('Contract.topic[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: Focus of contract interest
    • Definition: Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.
    • Requirements: Requirement: May be used to focus the topic of a Contract definition, derivative, or instance in any legal state. Comment: Contractual areas of concern are very broad. This element supports narrowing the area of concern to more specific term topics within this Contract. Given the wide range of contract topics, implementers need to be cognizant of the business use case for which they are designing a FHIR Contract, and narrowly specify the topic being represented with respect to the Contract.type and any specializing Contract.subtype. The same topic, e.g., an asset such as a good or service, such as a real property, medical supply, insurance, information, a procedure or employment, or a manner of conduct, such adherence to a privacy, trust, or security policy, may be the topic of multiple types of contracts. One way to determine the Contract.topic is to answer the question: "What is the overall objective of this legal instrument. The Contract.topic is described with more detail by the terms of the Contract.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Contract.type Element

    FHIR Specification

    • Short: Legal instrument category
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subType?: CodeableConcept[]

    Contract.subType Element

    FHIR Specification

    • Short: Subtype within the context of type
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Contract.contentDefinition Element

    FHIR Specification

    • Short: Contract precursor content
    • Definition: 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Contract.term Element

    FHIR Specification

    • Short: Contract Term List
    • Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    supportingInfo?: Reference[]

    Contract.supportingInfo Element

    FHIR Specification

    • Short: Extra Information
    • Definition: Information that may be needed by/relevant to the performer in their execution of this term action.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relevantHistory?: Reference[]

    Contract.relevantHistory Element

    FHIR Specification

    Contract.signer Element

    FHIR Specification

    • Short: Contract Signatory
    • Definition: 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.
    • Comment: Signers who are principal parties to the contract are bound by the Contract.activity related to the Contract.topic, and the Contract.term(s), which either extend or restrict the overall action on the topic by, for example, stipulating specific policies or obligations constraining actions, action reason, or agents with respect to some or all of the topic. For example, specifying how policies or obligations shall constrain actions and action reasons permitted or denied on all or a subset of the Contract.topic (e.g., all or a portion of property being transferred by the contract), agents (e.g., who can resell, assign interests, or alter the property being transferred by the contract), actions, and action reasons; or with respect to Contract.terms, stipulating, extending, or limiting the Contract.period of applicability or valuation of items under consideration.
    • Requirements: The Contract.signer applies a signature to the Contract.binding referenced resource, which is the documentation that is the legal "source of truth". The Contract.signer may delegate, such as a legally recognized personal representative, or have a delegate assigned e.g., by a court of law, to actually sign the Contract, such as a trustee in the case of incompetence.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Contract.friendly Element

    FHIR Specification

    • Short: Contract Friendly Language
    • Definition: 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Contract.legal Element

    FHIR Specification

    • Short: Contract Legal Language
    • Definition: List of Legal expressions or representations of this Contract.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Contract.rule Element

    FHIR Specification

    • Short: Computable Contract Language
    • Definition: List of Computable Policy Rule Language Representations of this Contract.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    legallyBinding?: IDataType

    Contract.legallyBinding[x] Element

    @ChoiceDataTypesMeta('Contract.legallyBinding[x]', ['Attachment','Reference',]

    FHIR Specification

    • Short: Binding Contract
    • Definition: 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.
    • FHIR Types: 'Attachment', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Contract JSON to instantiate the Contract data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Contract

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Contract

      Returns undefined | Contract

      Contract data model or undefined for Contract

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided InstantiatesCanonical object value to the instantiatesCanonical property.

      Parameters

      • value: undefined | Reference

        the instantiatesCanonical object value

      Returns this

      this

      @ReferenceTargets('Contract.instantiatesCanonical', ['Contract',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise