Private OptionalidentifierContract.identifier Element
FHIR Specification
IdentifierPrivate OptionalurlContract.url Element
FHIR Specification
uriPrivate OptionalversionContract.version Element
FHIR Specification
stringPrivate ReadonlycontractFHIR CodeSystem: ContractStatus
Private OptionalstatusContract.status Element
FHIR Specification
codeCodeSystem Enumeration: ContractStatusEnum
Private OptionallegalContract.legalState Element
FHIR Specification
CodeableConceptPrivate OptionalinstantiatesContract.instantiatesCanonical Element
FHIR Specification
Reference
Private OptionalinstantiatesContract.instantiatesUri Element
Private OptionalcontentContract.contentDerivative Element
FHIR Specification
CodeableConceptPrivate OptionalissuedContract.issued Element
Private OptionalappliesContract.applies Element
Private OptionalexpirationContract.expirationType Element
Private OptionalsubjectContract.subject Element
FHIR Specification
Reference
Private OptionalauthorityContract.authority Element
FHIR Specification
Reference
Private OptionaldomainContract.domain Element
FHIR Specification
Reference
Private OptionalsiteContract.site Element
FHIR Specification
Reference
Private OptionalnameContract.name Element
FHIR Specification
stringPrivate OptionaltitleContract.title Element
Private OptionalsubtitleContract.subtitle Element
Private OptionalaliasContract.alias Element
FHIR Specification
stringPrivate OptionalauthorContract.author Element
Private OptionalscopeContract.scope Element
Private OptionaltopicContract.topic[x] Element
FHIR Specification
Private Optionaltype_Contract.type Element
FHIR Specification
CodeableConceptPrivate OptionalsubContract.subType Element
FHIR Specification
CodeableConceptPrivate OptionalcontentContract.contentDefinition Element
FHIR Specification
BackboneElementPrivate OptionaltermContract.term Element
Private OptionalsupportingContract.supportingInfo Element
FHIR Specification
Reference
Private OptionalrelevantContract.relevantHistory Element
FHIR Specification
Reference
Private OptionalsignerContract.signer Element
FHIR Specification
BackboneElementPrivate OptionalfriendlyContract.friendly Element
FHIR Specification
BackboneElementPrivate OptionallegalContract.legal Element
Private OptionalruleContract.rule Element
Private OptionallegallyContract.legallyBinding[x] Element
FHIR Specification
StaticparseParse the provided Contract JSON to instantiate the Contract data model.
JSON representing FHIR Contract
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Contract
Contract data model or undefined for Contract
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the url property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the version property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the version property.
the version value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the version property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the version property.
the version value
this
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: ContractStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: ContractStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else undefined
CodeSystem Enumeration: ContractStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ContractStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: ContractStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ContractStatusEnum
true if the status property exists and has a value; false otherwise
the legalState property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided LegalState object value to the legalState property.
the legalState object value
this
InvalidTypeError for invalid data types
true if the legalState property exists and has a value; false otherwise
the instantiatesCanonical property value as a Reference object; else an empty Reference object
Assigns the provided InstantiatesCanonical object value to the instantiatesCanonical property.
the instantiatesCanonical object value
this
InvalidTypeError for invalid data type or reference value
true if the instantiatesCanonical property exists and has a value; false otherwise
the instantiatesUri property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the instantiatesUri property.
the instantiatesUri value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the instantiatesUri property exists and has a value; false otherwise
the instantiatesUri property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the instantiatesUri property.
the instantiatesUri value
this
PrimitiveTypeError for invalid primitive types
true if the instantiatesUri property exists and has a value; false otherwise
the contentDerivative property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided ContentDerivative object value to the contentDerivative property.
the contentDerivative object value
this
InvalidTypeError for invalid data types
true if the contentDerivative property exists and has a value; false otherwise
the issued property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the issued property.
the issued value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the issued property exists and has a value; false otherwise
the issued property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the issued property.
the issued value
this
PrimitiveTypeError for invalid primitive types
true if the issued property exists and has a value; false otherwise
the applies property value as a Period object if defined; else an empty Period object
Assigns the provided Applies object value to the applies property.
the applies object value
this
InvalidTypeError for invalid data types
true if the applies property exists and has a value; false otherwise
the expirationType property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided ExpirationType object value to the expirationType property.
the expirationType object value
this
InvalidTypeError for invalid data types
true if the expirationType property exists and has a value; false otherwise
the subject property value as a Reference array
Assigns the provided Reference array value to the subject property.
the subject array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the subject array property.
the subject value
this
InvalidTypeError for invalid data type or reference value
true if the subject property exists and has a value; false otherwise
the authority property value as a Reference array
Assigns the provided Reference array value to the authority property.
the authority array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the authority array property.
the authority value
this
InvalidTypeError for invalid data type or reference value
true if the authority property exists and has a value; false otherwise
the domain property value as a Reference array
Assigns the provided Reference array value to the domain property.
the domain array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the domain array property.
the domain value
this
InvalidTypeError for invalid data type or reference value
true if the domain property exists and has a value; false otherwise
the site property value as a Reference array
Assigns the provided Reference array value to the site property.
the site array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the site array property.
the site value
this
InvalidTypeError for invalid data type or reference value
true if the site property exists and has a value; false otherwise
the name property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the name property.
the name value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the name property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the name property.
the name value
this
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the title property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the title property.
the title value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the title property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the title property.
the title value
this
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the subtitle property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the subtitle property.
the subtitle value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the subtitle property exists and has a value; false otherwise
the subtitle property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the subtitle property.
the subtitle value
this
PrimitiveTypeError for invalid primitive types
true if the subtitle property exists and has a value; false otherwise
the alias property value as a StringType array
Assigns the provided StringType array value to the alias property.
the alias array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided StringType value to the alias array property.
the alias value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the alias property exists and has a value; false otherwise
the alias property value as a fhirString array
Assigns the provided primitive value array to the alias property.
the alias value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the alias array property.
the alias value
this
PrimitiveTypeError for invalid primitive types
true if the alias property exists and has a value; false otherwise
the author property value as a Reference object; else an empty Reference object
Assigns the provided Author object value to the author property.
the author object value
this
@ReferenceTargets('Contract.author', ['Patient','Practitioner','PractitionerRole','Organization',])
InvalidTypeError for invalid data type or reference value
true if the author property exists and has a value; false otherwise
the scope property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Scope object value to the scope property.
the scope object value
this
InvalidTypeError for invalid data types
true if the scope property exists and has a value; false otherwise
the topic property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the topic property.
the topic object value
this
InvalidTypeError for invalid data types
true if the topic property exists and has a value; false otherwise
the topic property value as a CodeableConcept object if defined; else undefined
true if the topic property exists as a CodeableConcept and has a value; false otherwise
the topic property value as a Reference object if defined; else undefined
true if the topic property exists as a Reference and has a value; false otherwise
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Type object value to the type_ property.
the type_ object value
this
InvalidTypeError for invalid data types
true if the type_ property exists and has a value; false otherwise
the subType property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the subType property.
the subType array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the subType array property.
the subType value
this
InvalidTypeError for invalid data types
true if the subType property exists and has a value; false otherwise
the contentDefinition property value as a ContractContentDefinitionComponent object if defined; else an empty ContractContentDefinitionComponent object
Assigns the provided ContentDefinition object value to the contentDefinition property.
the contentDefinition object value
this
InvalidTypeError for invalid data types
true if the contentDefinition property exists and has a value; false otherwise
the term property value as a ContractTermComponent array
Assigns the provided ContractTermComponent array value to the term property.
the term array value
this
InvalidTypeError for invalid data types
Add the provided ContractTermComponent value to the term array property.
the term value
this
InvalidTypeError for invalid data types
true if the term property exists and has a value; false otherwise
the supportingInfo property value as a Reference array
Assigns the provided Reference array value to the supportingInfo property.
the supportingInfo array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the supportingInfo array property.
the supportingInfo value
this
InvalidTypeError for invalid data type or reference value
true if the supportingInfo property exists and has a value; false otherwise
the relevantHistory property value as a Reference array
Assigns the provided Reference array value to the relevantHistory property.
the relevantHistory array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the relevantHistory array property.
the relevantHistory value
this
InvalidTypeError for invalid data type or reference value
true if the relevantHistory property exists and has a value; false otherwise
the signer property value as a ContractSignerComponent array
Assigns the provided ContractSignerComponent array value to the signer property.
the signer array value
this
InvalidTypeError for invalid data types
Add the provided ContractSignerComponent value to the signer array property.
the signer value
this
InvalidTypeError for invalid data types
true if the signer property exists and has a value; false otherwise
the friendly property value as a ContractFriendlyComponent array
Assigns the provided ContractFriendlyComponent array value to the friendly property.
the friendly array value
this
InvalidTypeError for invalid data types
Add the provided ContractFriendlyComponent value to the friendly array property.
the friendly value
this
InvalidTypeError for invalid data types
true if the friendly property exists and has a value; false otherwise
the legal property value as a ContractLegalComponent array
Assigns the provided ContractLegalComponent array value to the legal property.
the legal array value
this
InvalidTypeError for invalid data types
Add the provided ContractLegalComponent value to the legal array property.
the legal value
this
InvalidTypeError for invalid data types
true if the legal property exists and has a value; false otherwise
the rule property value as a ContractRuleComponent array
Assigns the provided ContractRuleComponent array value to the rule property.
the rule array value
this
InvalidTypeError for invalid data types
Add the provided ContractRuleComponent value to the rule array property.
the rule value
this
InvalidTypeError for invalid data types
true if the rule property exists and has a value; false otherwise
the legallyBinding property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the legallyBinding property.
the legallyBinding object value
this
InvalidTypeError for invalid data types
true if the legallyBinding property exists and has a value; false otherwise
the legallyBinding property value as a Attachment object if defined; else undefined
true if the legallyBinding property exists as a Attachment and has a value; false otherwise
the legallyBinding property value as a Reference object if defined; else undefined
true if the legallyBinding property exists as a Reference and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
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
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
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
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
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
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the subject property
PrivateinitInitialize the authority property
PrivateinitInitialize the domain property
PrivateinitInitialize the site property
PrivateinitInitialize the alias property
PrivateinitInitialize the subType property
PrivateinitInitialize the term property
PrivateinitInitialize the supportingInfo property
PrivateinitInitialize the relevantHistory property
PrivateinitInitialize the signer property
PrivateinitInitialize the friendly property
PrivateinitInitialize the legal property
PrivateinitInitialize the rule property
Contract Class
Remarks
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
FHIR Specification
See
FHIR Contract