Contract

@POJOBoilerplate
class Contract(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val site: LitSeq[Reference], val name: Option[String], `type`: Option[CodeableConcept], val title: Option[String], val alias: LitSeq[String], val scope: Option[CodeableConcept], val status: Option[CONTRACT_STATUS], val issued: Option[FHIRDateTime], val domain: LitSeq[Reference], val author: Option[Reference], val version: Option[String], val applies: Option[Period], val subject: LitSeq[Reference], val subType: LitSeq[CodeableConcept], val language: Option[LANGUAGES], val subtitle: Option[String], val topic: Option[TopicChoice], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val authority: LitSeq[Reference], val identifier: LitSeq[Identifier], val legalState: Option[CodeableConcept], val implicitRules: Option[UriStr], val expirationType: Option[CodeableConcept], val supportingInfo: LitSeq[Reference], val instantiatesUri: Option[UriStr], val relevantHistory: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val contentDerivative: Option[CodeableConcept], val legallyBinding: Option[LegallyBindingChoice], val instantiatesCanonical: Option[Reference], val rule: LitSeq[Rule], val legal: LitSeq[Legal], val signer: LitSeq[Signer], val friendly: LitSeq[Friendly], val contentDefinition: Option[ContentDefinition], val term: LitSeq[Term], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

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

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • 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.
alias
  • 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.
applies
  • Relevant time or time-period when this Contract is applicable.
author
  • The individual or organization that authored the Contract definition, derivative, or instance in any legal state.
authority
  • 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.
contained
  • 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.
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.
contentDerivative
  • The minimal content derived from the basal information source at a specific stage in its lifecycle.
domain
  • 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.
expirationType
  • Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.
extension
  • 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.
friendly
  • 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.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique identifier for this Contract or a derivative that references a Source Contract.
implicitRules
  • 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.
instantiatesCanonical
  • The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.
instantiatesUri
  • The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
issued
  • When this Contract was issued.
language
  • The base language in which the resource is written.
legal
  • List of Legal expressions or representations of this Contract.
legalState
  • 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.
legallyBinding
  • 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.
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.
modifierExtension
  • 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).
name
  • 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.
relevantHistory
  • 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.
rule
  • List of Computable Policy Rule Language Representations of this Contract.
scope
  • A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.
signer
  • 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.
site
  • Sites in which the contract is complied with, exercised, or in force.
status
  • The status of the resource instance.
subType
  • 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.
subject
  • The target entity impacted by or of interest to parties to the agreement.
subtitle
  • 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.
supportingInfo
  • Information that may be needed by/relevant to the performer in their execution of this term action.
term
  • One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
text
  • 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.
title
  • A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
topic
  • Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.
url
  • Canonical identifier for this contract, represented as a URI (globally unique).
version
  • An edition identifier used for business purposes to label business significant variants.
Constructor:

Introduces the fields url, site, name, type, title, alias, scope, status, issued, domain, author, version, applies, subject, subType, subtitle, topic, authority, identifier, legalState, expirationType, supportingInfo, instantiatesUri, relevantHistory, contentDerivative, legallyBinding, instantiatesCanonical, rule, legal, signer, friendly, contentDefinition, term.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): Contract

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[Contract]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: Contract <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: Contract <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): Contract

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: Contract <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: Contract <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): Contract
Inherited from:
FHIRObject
def withField[T : LTag, Up >: Contract <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: Contract <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: Contract <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): Contract
Inherited from:
FHIRObject

Concrete fields

val `type`: Option[CodeableConcept]
val alias: LitSeq[String]
val applies: Option[Period]
val author: Option[Reference]
val authority: LitSeq[Reference]
override val contained: LitSeq[Resource]
val contentDerivative: Option[CodeableConcept]
val domain: LitSeq[Reference]
val expirationType: Option[CodeableConcept]
override val extension: LitSeq[Extension]
val friendly: LitSeq[Friendly]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
val instantiatesCanonical: Option[Reference]
val instantiatesUri: Option[UriStr]
val issued: Option[FHIRDateTime]
override val language: Option[LANGUAGES]
val legalState: Option[CodeableConcept]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
val name: Option[String]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val relevantHistory: LitSeq[Reference]
val rule: LitSeq[Rule]
val scope: Option[CodeableConcept]
val signer: LitSeq[Signer]
val site: LitSeq[Reference]
val status: Option[CONTRACT_STATUS]
val subType: LitSeq[CodeableConcept]
val subject: LitSeq[Reference]
val subtitle: Option[String]
val supportingInfo: LitSeq[Reference]
val term: LitSeq[Term]
override val text: Option[Narrative]
override val thisTypeName: String
val title: Option[String]
val topic: Option[TopicChoice]
val url: Option[UriStr]
val version: Option[String]

Inherited fields

val companion: CompanionFor[Contract]
Inherited from:
FHIRObject