Contract

There are no (further) constraints on this element

Element id

Contract.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Meta

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Contract.implicitRules

Short description

A set of rules under which this content was created

Definition

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.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Contract.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Contract.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

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.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

Contract.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

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.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings

rim: N/A

extension

0..*

Element id

Contract.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContractAdditionalRelationshipExtension

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

additionalRelationship

S C

0..*

Extension(Complex)

Element id

Contract.extension:additionalRelationship

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Extension for Contract to supply information about relationships between contracts.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a
ContractToHVOAvtalLogical: relationAvtal(HVOAvtalLogical)

0..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

2..*

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

additionalRelationship

S C

1..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:additionalRelationship

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:additionalRelationship.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:additionalRelationship.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:additionalRelationship.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

Auto value

additionalRelationship

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:additionalRelationship.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

valueReference

Reference(HVOContract)

There are no (further) constraints on this element

Data type

Reference(HVOContract)

type

S C

1..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type

Short description

Code for the type of relationship between contracts.

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

hvo-contract-additional-relationship-type (required)

Auto value

type

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

valueCoding

There are no (further) constraints on this element

Data type

0..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.value[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.value[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.value[x].system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.value[x].version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.value[x].code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.value[x].display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.extension:type.value[x].userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

url

1..1

uriAuto Value

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Auto value

http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContractAdditionalRelationshipExtension

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Contract.extension:additionalRelationship.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Contract.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

identifier

S Σ

1..*

Element id

Contract.identifier

Short description

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.identifier
rim: FinancialContract id
ContractToHVOAvtalLogical: id

0..1

There are no (further) constraints on this element

Element id

Contract.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Contract.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Contract.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Contract.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Contract.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

url

0..1

There are no (further) constraints on this element

Element id

Contract.url

Short description

Basal definition

Definition

Canonical identifier for this contract, represented as a URI (globally unique).

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.

Comments

Used in a domain that uses a supplied contract repository.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

version

0..1

There are no (further) constraints on this element

Element id

Contract.version

Short description

Business edition

Definition

An edition identifier used for business purposes to label business significant variants.

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.

Comments

Note - This is a business versionId, not a resource version id (see discussion http://build.fhir.org/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].

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

status

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Contract.status

Short description

Definition

The status of the resource instance.

Requirements

This is the Contract Business Workflow Status.

Comments

This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active.

Data type

ContractResourceStatusCodes (required)

Binding

A code specifying the state of the resource instance.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.status
w5: FiveWs.status
rim: Act.status

legalState

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Contract.legalState

Short description

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.

Data type

ContractResourceLegalStateCodes (extensible)

Binding

Detailed codes for the legal state of a contract.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

instantiatesCanonical

0..1

Reference(Contract)

There are no (further) constraints on this element

Element id

Contract.instantiatesCanonical

Short description

Source Contract Definition

Definition

The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.

Data type

Reference(Contract)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

instantiatesUri

0..1

There are no (further) constraints on this element

Element id

Contract.instantiatesUri

Short description

External Contract Definition

Definition

The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

contentDerivative

0..1

There are no (further) constraints on this element

Element id

Contract.contentDerivative

Short description

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.

Data type

ContractContentDerivationCodes (example)

Binding

This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: Maps partially to several v3 codes: ActClass: REG (registration) Description: Represents the act of maintaining information about the registration of its associated registered subject. The subject can be either an Act or a Role, and includes subjects such as lab exam definitions, drug protocol definitions, prescriptions, persons, patients, practitioners, and equipment. The registration may have a unique identifier - separate from the unique identification of the subject - as well as a core set of related participations and act relationships that characterize the registration event and aid in the disposition of the subject information by a receiving system. Observation: VERIF (Verification) Description: An act which describes the process whereby a 'verifying party' validates either the existence of the Role attested to by some Credential or the actual Vetting act and its details. TRFR (transfer) Description: The act of transferring information without the intent of imparting understanding about a topic to the subject that is the recipient or holder of the transferred information where the participation association must be RCV or HLD. _ActDetectedIssueManagementCode [abstract term] Description: Codes dealing with the management of Detected Issue observations. _ActInformationAccessContextCode [abstract term] Description: Concepts conveying the context in which authorization given under jurisdictional law, by organizational policy, or by a patient consent directive permits the collection, access, use or disclosure of specified patient health information. _ActListCode [abstract term]vDescription: Provides codes associated with ActClass value of LIST (working list). RefusalReasonCode [abstract term] Description: Description: Identifies why a request to add (or activate) a record is being refused. Examples include the receiving system not able to match the identifier and find that record in the receiving system, having no permission, or a detected issue exists which precludes the requested action.

issued

0..1

There are no (further) constraints on this element

Element id

Contract.issued

Short description

When this Contract was issued

Definition

When this Contract was issued.

Requirements

The Contract issuance dateTime often precedes the Contract effective dateTime.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.authoredOn
rim: Act.availabilityTime. Definition: A time expression specifying when an Observation, Procedure, or other Act occurs, or, depending on the mood, is supposed to occur, scheduled to occur, etc. The activityTime includes the times of component actions (such as preparation and clean-up). For Procedures and SubstanceAdministrations, the activityTime can provide a needed administrative function by providing a more inclusive time to be anticipated in scheduling. UsageNotes:The activityTime is primarily of administrative rather than clinical use. The clinically relevant time is the effectiveTime. When an observation of a prior symptom is made, the activityTime describes the time the observation is made, as opposed to effectiveTime which is the time the symptom is reported to have occurred. Thus the activityTime may be entirely different from the effectiveTime of the same Act. However, even apart from clinical use cases, designers should first consider effectiveTime as the primary relevant time for an Act. ActivityTime indicates when an Act occurs, not when it is recorded.

applies

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.applies

Short description

Effective time

Definition

Relevant time or time-period when this Contract is applicable.

Requirements

The dateTime upon which the Contract is binding.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.occurrence[x]
rim: Act.effectiveTime Definition: The clinically or operationally relevant time of an act, exclusive of administrative activity.

0..1

There are no (further) constraints on this element

Element id

Contract.applies.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.applies.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

start

S Σ C

1..1

Element id

Contract.applies.start

Short description

The moment the contract becomes valid and has legal force

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: DR.1
rim: ./low
ContractToHVOAvtalLogical: giltigFrom

end

S Σ C

0..1

Element id

Contract.applies.end

Short description

The moment the contract stops being valid. Do not use if not known.

Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: DR.2
rim: ./high
ContractToHVOAvtalLogical: giltigTom

expirationType

0..1

There are no (further) constraints on this element

Element id

Contract.expirationType

Short description

Contract cessation cause

Definition

Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.

Data type

ContractResourceExpirationTypeCodes (example)

Binding

Codes for the Cessation of Contracts.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

subject

S Σ

0..*

Reference(HVOOrganizationAffiliation)

Element id

Contract.subject

Short description

Contract Target Entity

Alternate names

Patient

Definition

The target entity impacted by or of interest to parties to the 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.

Comments

Data type

Reference(HVOOrganizationAffiliation)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.subject
rim: RoleClass, RoleCode
ContractToHVOAvtalLogical: avser(HVOUppdragLogical)

authority

0..*

There are no (further) constraints on this element

Element id

Contract.authority

Short description

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Organization Role. CONCEPT DOMAIN: OrganizationEntityType Description: Further classifies entities of EntityClass ORG.

domain

0..*

There are no (further) constraints on this element

Element id

Contract.domain

Short description

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

Alternate names

scope of governance jurisdiction

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: TERR (territory of authority) Description: Relates a place entity (player) as the region over which the scoper (typically an Organization) has certain authority (jurisdiction). For example, the Calgary Regional Health Authority (scoper) has authority over the territory "Region 4 of Alberta" (player) in matters of health. Entity Class = Place? A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. CONCEPT DOMAIN: TerritoryEntityType Description: A territorial entity that may be cited as the body over which an agency exercises jurisdiction, or which defines a sphere in which a party has a particular responsibility. CONCEPT DOMAIN: OrganizationEntityType Description: Further classifies entities of EntityClass ORG.

site

0..*

There are no (further) constraints on this element

Element id

Contract.site

Short description

Specific Location

Definition

Sites in which the contract is complied with, exercised, or in force.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

name

0..1

There are no (further) constraints on this element

Element id

Contract.name

Short description

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.

Requirements

Support human navigation and code generation.

Comments

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

title

0..1

There are no (further) constraints on this element

Element id

Contract.title

Short description

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

subtitle

0..1

There are no (further) constraints on this element

Element id

Contract.subtitle

Short description

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

alias

0..*

There are no (further) constraints on this element

Element id

Contract.alias

Short description

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

author

0..1

Reference(Patient | Practitioner | PractitionerRole | Organization)

There are no (further) constraints on this element

Element id

Contract.author

Short description

Source of Contract

Definition

The individual or organization that authored the Contract definition, derivative, or instance in any legal state.

Data type

Reference(Patient | Practitioner | PractitionerRole | Organization)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

scope

0..1

There are no (further) constraints on this element

Element id

Contract.scope

Short description

Range of Legal Concerns

Definition

A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.

Data type

ContractResourceScopeCodes (example)

Binding

Codes for the range of legal concerns.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

topic[x]

0..1

There are no (further) constraints on this element

Element id

Contract.topic[x]

Short description

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

topicCodeableConcept

There are no (further) constraints on this element

Data type

topicReference

There are no (further) constraints on this element

Data type

type

S Σ

0..1

CodeableConceptBinding

Element id

Contract.type

Short description

Code for the domain(s) in which the services that the contract applies to have been procured

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.

Data type

hvo-contract-type-with-sub-type-lfu (required)

Binding

List of overall contract codes.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.code
w5: FiveWs.what[x]
rim: Maps to multiple ActClass and ActCode Concept Domains and Code Systems such as the following: In the ActClass Concept Domain: ActClassPolicy. In the ActCode Concept Domain: ActContractType, which generalizes ActFinancialContractType, ActCoverageType, ActBillingArrangementType. ActConsentType, which generalizes ActDataConsentType; ActFinancialParticipationConsentType; ActInformationAccessCode; AdvanceBeneficiaryNoticeType. ActPolicyType, which generalizes: ActPrivacyPolicyType, ActSensitivityPrivacyPolicyType, ActSecurityPolicyType. In the ActClass Code System: CNTRCT (contract) Description: An agreement of obligation between two or more parties that is subject to contractual law and enforcement, lwhich generalizes FCNTRCT (financial contract) and COV (coverage). POLICY (policy) - Description: A mandate, regulation, obligation, requirement, rule, or expectation unilaterally imposed by one party on: The activity of another party; the behavior of another party; or the manner in which an act is executed. LEAF CONCEPTS: JURISPOL (jurisdictional policy) Description:A mandate, regulation, obligation, requirement, rule, or expectation unilaterally imposed by a jurisdiction on: The activity of another party; the behavior of another party; or the manner in which an act is executed.Examples:A jurisdictional mandate regarding the prescribing and dispensing of a particular medication. A jurisdictional privacy or security regulation dictating the manner in which personal health information is disclosed. A jurisdictional requirement that certain services or health conditions are reported to a monitoring program, e.g., immunizations, methadone treatment, or cancer registries.ORGPOL (organizational policy)Examples:A clinical or research protocols imposed by a payer, a malpractice insurer, or an institution to which a provider must adhere. A mandate imposed by a denominational institution for a provider to provide or withhold certain information from the patient about treatment options.SCOPOL (scope of practice policy)Description:An ethical or clinical obligation, requirement, rule, or expectation imposed or strongly encouraged by organizations that oversee particular clinical domains or provider certification which define the boundaries within which a provider may practice and which may have legal basis or ramifications.Examples:An ethical obligation for a provider to fully inform a patient about all treatment options. An ethical obligation for a provider not to disclose personal health information that meets certain criteria, e.g., where disclosure might result in harm to the patient or another person. The set of health care services which a provider is credentialed or privileged to provide. STDPOL (standard of practice policy) Examples:A payer may require a prescribing provider to adhere to formulary guidelines. An institution may adopt clinical guidelines and protocols and implement these within its electronic health record and decision support systems. CONS (consent)Description: The Consent class represents informed consents and all similar medico-legal transactions between the patient (or his legal guardian) and the provider. Examples are informed consent for surgical procedures, informed consent for clinical trials, advanced beneficiary notice, against medical advice decline from service, release of information agreement, etc. The details of consents vary. Often an institution has a number of different consent forms for various purposes, including reminding the physician about the topics to mention. Such forms also include patient education material. In electronic medical record communication, consents thus are information-generating acts on their own and need to be managed similar to medical activities. Thus, Consent is modeled as a special class of Act. The "signatures" to the consent document are represented electronically through Participation instances to the consent object. Typically an informed consent has Participation.typeCode of "performer", the healthcare provider informing the patient, and "consenter", the patient or legal guardian. Some consent may associate a witness or a notary public (e.g., living wills, advanced directives). In consents where a healthcare provider is not required (e.g. living will), the performer may be the patient himself or a notary public.
ContractToHVOAvtalLogical: avtalsomrade

0..1

There are no (further) constraints on this element

Element id

Contract.type.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

coding

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Contract.type.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.type.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.type.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Contract.type.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.type.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Contract.type.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Contract.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Contract.type.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

subType

S Σ

0..1

CodeableConceptBinding

Element id

Contract.subType

Short description

Section of law in which a procurement has been done or an task has been delivered.

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.

Data type

hvo-contract-procurement-regulation (required)

Binding

Detailed codes within the above.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: Examples of Contract or Policy subtypes in ActCodes:_ActCoverageTypeCode Definition: Set of codes indicating the type of insurance policy or program that pays for the cost of benefits provided to covered parties. Generalizes: _ActInsurancePolicyCode; _ActInsuranceTypeCode; ActProgramTypeCode. _ActPolicyType Description:Types of policies that further specify the ActClassPolicy value set. Generalizes: _ActPrivacyPolicy; _ActPrivacyLaw; _InformationSensitivityPolicy; ActTrustPolicyType; SecurityPolicy. _ActInvoiceAdjudicationPaymentGroupCode Description: Codes representing adjustments to a Payment Advice such as retroactive, clawback, garnishee, etc., e.g. RECOV (recovery) Description: Retroactive adjustment such as fee rate adjustment due to contract negotiations.
ContractToHVOAvtalLogical: lagrum

0..1

There are no (further) constraints on this element

Element id

Contract.subType.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.subType.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

coding

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.subType.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Contract.subType.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.subType.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.subType.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Contract.subType.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

Contract.subType.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Contract.subType.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Contract.subType.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Contract.subType.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

contentDefinition

0..1

There are no (further) constraints on this element

Element id

Contract.contentDefinition

Short description

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Contract.contentDefinition.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.contentDefinition.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.contentDefinition.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

type

1..1

There are no (further) constraints on this element

Element id

Contract.contentDefinition.type

Short description

Content structure and use

Definition

Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation.

Data type

ContractResourceDefinitionTypeCodes (example)

Binding

Detailed codes for the definition of contracts.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

subType

0..1

There are no (further) constraints on this element

Element id

Contract.contentDefinition.subType

Short description

Detailed Content Type Definition

Definition

Detailed Precusory content type.

Data type

ContractResourceDefinitionSubtypeCodes (example)

Binding

Detailed codes for the additional definition of contracts.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

publisher

0..1

Reference(Practitioner | PractitionerRole | Organization)

There are no (further) constraints on this element

Element id

Contract.contentDefinition.publisher

Short description

Publisher Entity

Definition

The individual or organization that published the Contract precursor content.

Data type

Reference(Practitioner | PractitionerRole | Organization)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

publicationDate

0..1

There are no (further) constraints on this element

Element id

Contract.contentDefinition.publicationDate

Short description

When published

Definition

The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

publicationStatus

1..1

codeBinding

There are no (further) constraints on this element

Element id

Contract.contentDefinition.publicationStatus

Short description

Definition

Data type

ContractResourcePublicationStatusCodes (required)

Binding

Status of the publication of contract content.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

markdown

There are no (further) constraints on this element

Element id

Contract.contentDefinition.copyright

Short description

Publication Ownership

Definition

A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.

Data type

markdown

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

term

0..1

There are no (further) constraints on this element

Element id

Contract.term

Short description

Contract Term List

Definition

One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: RIM mechanism for grouping or nesting rules, which are likely Acts and Observations.

0..1

There are no (further) constraints on this element

Element id

Contract.term.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

Contract.term.identifier

Short description

Contract Term Number

Definition

Unique identifier for this particular Contract Provision.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.identifier
rim: Act or Observation identifier.

issued

0..1

There are no (further) constraints on this element

Element id

Contract.term.issued

Short description

Contract Term Issue Date Time

Definition

When this Contract Provision was issued.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.authoredOn
w5: FiveWs.recorded
rim: Act availabilityTime

applies

0..1

There are no (further) constraints on this element

Element id

Contract.term.applies

Short description

Contract Term Effective Time

Definition

Relevant time or time-period when this Contract Provision is applicable.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.occurrence[x]
w5: FiveWs.done[x]
rim: Act effectiveTime

topic[x]

0..1

There are no (further) constraints on this element

Element id

Contract.term.topic[x]

Short description

Term Concern

Definition

The entity that the term applies to.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

topicCodeableConcept

There are no (further) constraints on this element

Data type

topicReference

There are no (further) constraints on this element

Data type

type

0..1

There are no (further) constraints on this element

Element id

Contract.term.type

Short description

Contract Term Type or Form

Definition

A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time.

Data type

ContractTermTypeCodes (example)

Binding

Detailed codes for the types of contract provisions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.code
w5: FiveWs.what[x]
rim: See Contract.term mapping.

subType

0..1

There are no (further) constraints on this element

Element id

Contract.term.subType

Short description

Contract Term Type specific classification

Definition

A specialized legal clause or condition based on overarching contract type.

Data type

ContractTermSubtypeCodes (example)

Binding

Detailed codes for the subtypes of contract provisions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: See Contract.topic mapping.

text

S Σ

1..1

Element id

Contract.term.text

Short description

Textual description of relevant contract specific conditions and texts which are not represented elsewhere, for example in organization affiliations and the services they include

Definition

Statement of a provision in a policy or a contract.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

ContractToHVOAvtalLogical: beskrivning

securityLabel

0..*

There are no (further) constraints on this element

Element id

Contract.term.securityLabel

Short description

Protection for the Term

Definition

Security labels that protect the handling of information about the term and its elements, which may be specifically identified..

Requirements

Requirement - Within a Contract, a security label may apply to the one to many nested group of terms or to a term, whether inside a group or a singleton. This security label protects the term and its contained provision elements. The security label on the entire set of term provision elements may be different from the security labels on a contained offer, asset, valuedItem, or data such as sensitive information, and must be the high water mark of all security labels within the term. Rationale is that a labelled term, which may be disaggregated from the Contract, and must persist the label on the term and on contained elements within other contexts. Requirement - If more than one policy dictates a level of confidentiality of the term, then each applicable policy may be represented by a security label specific to its requirements. Comment - A Security Label is comprised of 1..1 confidentiality code and 0..* other security label codes (aka "privacy tags". A Security Label is metadata assigned (aka "tagged") to Resources and Resource elements, which specify the confidentiality and sensitivity of the Resource or element and their related attributes, the purposes for which tagged items may be collected, access, used or disclosed, any limitation on the type of entities authorized to engage in permitted purposes, and handling instructions that obligate or prohibit certain actions on the tagged items.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Contract.term.securityLabel.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.securityLabel.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.securityLabel.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

number

0..*

There are no (further) constraints on this element

Element id

Contract.term.securityLabel.number

Short description

Link to Security Labels

Definition

Number used to link this term or term element to the applicable Security Label.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

classification

1..1

There are no (further) constraints on this element

Element id

Contract.term.securityLabel.classification

Short description

Confidentiality Protection

Definition

Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements.

Data type

ContractResourceScopeCodes (example)

Binding

Codes for confidentiality protection.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

category

0..*

There are no (further) constraints on this element

Element id

Contract.term.securityLabel.category

Short description

Applicable Policy

Definition

Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.

Data type

ContractResourceScopeCodes (example)

Binding

Codes for policy category.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

control

0..*

There are no (further) constraints on this element

Element id

Contract.term.securityLabel.control

Short description

Handling Instructions

Definition

Security label privacy tag that species the manner in which term and/or term elements are to be protected.

Data type

ContractResourceSecurityControlCodes (example)

Binding

Codes for handling instructions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

offer

1..1

There are no (further) constraints on this element

Element id

Contract.term.offer

Short description

Context of the Contract term

Definition

The matter of concern in the context of this provision of the agrement.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Document

0..1

There are no (further) constraints on this element

Element id

Contract.term.offer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.identifier

Short description

Offer business ID

Definition

Unique identifier for this particular Contract Provision.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

party

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.party

Short description

Offer Recipient

Definition

Offer Recipient.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Contract.term.offer.party.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.party.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.party.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

reference

1..*

There are no (further) constraints on this element

Element id

Contract.term.offer.party.reference

Short description

Referenced entity

Definition

Participant in the offer.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

role

1..1

There are no (further) constraints on this element

Element id

Contract.term.offer.party.role

Short description

Participant engagement type

Definition

How the party participates in the offer.

Data type

ContractResourcePartyRoleCodes (example)

Binding

Codes for offer participant roles.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

topic

0..1

There are no (further) constraints on this element

Element id

Contract.term.offer.topic

Short description

Negotiable offer asset

Definition

The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).

Requirements

In the context of a contract, the topic is the matter under consideration in regards to which specific rights, privileges, obligations, restrictions, and prohibitions are binding on any grantor and grantee parties upon the execution of the 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 object of negotiation?” Answer: The Contract.topic, which may be described with more detail in the [0..*]Contract.valuedItem @ [0..1] Contract.valuedItem.entity[x] Definition: Specific type of Contract Valued Item that may be priced. CodeableConcept|Reference(Any) Contract.topic is “the what” that a grantor is exchanging with a grantee in return for some benefit. Contract.topic is “the what” to which any Contract.action is being applied for any stipulated Contract.action.reason. AContract.topic is “the what” governed by the execution of the contract to which any party’s rights, privileges, obligations, restrictions, and prohibitions apply.

Comments

The Contract.topic may be an application for or offer of a policy or service (e.g., uri to a consent directive form or a health insurance policy), which becomes the Contract once accepted by both the grantor and grantee. 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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.context
rim: Includes many ActClass, ActCode, RoleClass, RoleCode, EntityClass, EntityCode, ParticipationType codes from HL7 concept domains and code systems. For example, RoleCode: HLD (held entity) Description: Entity that is currently in the possession of a holder (scoper), who holds, or uses it, usually based on some agreement with the owner. MANU (manufactured product) Description: Scoped by the manufacturer. OWN (owned entity) Description: An Entity (player) for which someone (scoper) is granted by law the right to call the material (player) his own. This entitles the scoper to make decisions about the disposition of that material. WRTE (warranted product) Description: A role a product plays when a guarantee is given to the purchaser by the seller (scoping entity) stating that the product is reliable and free from known defects and that the seller will repair or replace defective parts within a given time limit and under certain conditions.

type

0..1

There are no (further) constraints on this element

Element id

Contract.term.offer.type

Short description

Contract Offer Type or Form

Definition

Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.

Data type

ContractTermTypeCodes (example)

Binding

Detailed codes for the types of contract provisions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: See Contract.term mapping.

decision

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Contract.term.offer.decision

Short description

Accepting party choice

Definition

Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.

Requirements

In some policy or contract contexts, the "offer" is made by an offeror wishing to be the "grantee" of the offer topic by the grantor. From this perspective, the grantor is the "offeree".

Data type

v3.ActConsentDirective (extensible)

Binding

The type of decision made by a grantor with respect to an offer made by a grantee.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: ActCode: _ActConsentDirective [abstract term] Description: Specifies the type of agreement between one or more grantor and grantee in which rights and obligations related to one or more shared items of interest are allocated. Usage Note: Such agreements may be considered "consent directives" or "contracts" depending on the context, and are considered closely related or synonymous from a legal perspective.

decisionMode

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.decisionMode

Short description

How decision is conveyed

Definition

How the decision about a Contract was conveyed.

Data type

ContractResourceDecisionModeCodes (example)

Binding

Codes for conveying a decision.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

answer

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.answer

Short description

Response to offer text

Definition

Response to offer text.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Contract.term.offer.answer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.answer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.answer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Contract.term.offer.answer.value[x]

Short description

The actual answer response

Definition

Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBoolean

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

There are no (further) constraints on this element

Data type

valueTime

time

There are no (further) constraints on this element

Data type

time

valueString

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueReference

There are no (further) constraints on this element

Data type

text

0..1

Element id

Contract.term.offer.text

Short description

Textual description of option to prolong the contracts validity, if possible

Definition

Human readable form of this Contract Offer.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Document.text
ContractToHVOAvtalLogical: optionForlangning

linkId

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.linkId

Short description

Pointer to text

Definition

The id of the clause or question text of the offer in the referenced questionnaire/response.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id

securityLabelNumber

0..*

There are no (further) constraints on this element

Element id

Contract.term.offer.securityLabelNumber

Short description

Offer restriction numbers

Definition

Security labels that protects the offer.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

asset

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset

Short description

Contract Term Asset List

Definition

Contract Term Asset List.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: FinancialContract.paymentTermsCode

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

scope

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.scope

Short description

Range of asset

Definition

Differentiates the kind of the asset .

Data type

ContractResourceAssetScopeCodes (example)

Binding

Codes for scoping an asset.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

type

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.type

Short description

Asset category

Definition

Target entity type about which the term may be concerned.

Data type

ContractResourceAssetTypeCodes (example)

Binding

Condes for the type of an asset.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

typeReference

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.typeReference

Short description

Associated entities

Definition

Associated entities.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

subtype

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.subtype

Short description

Asset sub-category

Definition

May be a subtype or part of an offered asset.

Data type

ContractResourceAssetSub-TypeCodes (example)

Binding

Condes for the sub-type of an asset.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

relationship

0..1

CodingBinding

There are no (further) constraints on this element

Element id

Contract.term.asset.relationship

Short description

Kinship of the asset

Definition

Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree.

Data type

ConsentContentClass (extensible)

Binding

The class (type) of information a consent rule covers.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: FinancialContract.code

context

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.context

Short description

Circumstance of the asset

Definition

Circumstance of the asset.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.context.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.context.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.context.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

reference

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.context.reference

Short description

Creator,custodian or owner

Definition

Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

code

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.context.code

Short description

Codeable asset context

Definition

Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.

Data type

ContractResourceAssetContextCodes (example)

Binding

Codes for the context of the asset.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.context.text

Short description

Context description

Definition

Context description.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

condition

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.condition

Short description

Quality desctiption of asset

Definition

Description of the quality and completeness of the asset that imay be a factor in its valuation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

periodType

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.periodType

Short description

Asset availability types

Definition

Type of Asset availability for use or ownership.

Data type

ContractResourceAssetAvailiabilityCodes (example)

Binding

Codes for asset availability.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: FinancialContract.code

period

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.period

Short description

Time period of the asset

Definition

Asset relevant contractual time period.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: FinancialContract.activityTime

usePeriod

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.usePeriod

Short description

Time period

Definition

Time period of asset use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: FinancialContract.effectiveTime

text

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.text

Short description

Asset clause or question text

Definition

Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

linkId

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.linkId

Short description

Pointer to asset text

Definition

Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

answer

0..*

see (answer)

There are no (further) constraints on this element

Element id

Contract.term.asset.answer

Short description

Response to assets

Definition

Response to assets.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

securityLabelNumber

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.securityLabelNumber

Short description

Asset restriction numbers

Definition

Security labels that protects the asset.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valuedItem

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem

Short description

Contract Valued Item List

Definition

Contract Valued Item List.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: COCT_RM440000UV09 ValuedItem classCode INVE

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

entity[x]

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.entity[x]

Short description

Contract Valued Item Type

Definition

Specific type of Contract Valued Item that may be priced.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: COCT_RM440000UV09 ValuedItem code

entityCodeableConcept

There are no (further) constraints on this element

Data type

entityReference

There are no (further) constraints on this element

Data type

identifier

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.identifier

Short description

Contract Valued Item Number

Definition

Identifies a Contract Valued Item instance.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: COCT_RM440000UV09 ValuedItem id

effectiveTime

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.effectiveTime

Short description

Contract Valued Item Effective Tiem

Definition

Indicates the time during which this Contract ValuedItem information is effective.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.done[x]
rim: COCT_RM440000UV09 ValuedItem effectiveTime

quantity

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.quantity

Short description

Count of Contract Valued Items

Definition

Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.

Data type

SimpleQuantity

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: COCT_RM440000UV09 ValuedItem unitQuantity

unitPrice

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.unitPrice

Short description

Contract Valued Item fee, charge, or cost

Definition

A Contract Valued Item unit valuation measure.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: COCT_RM440000UV09 ValuedItem unitPriceAmt

factor

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.factor

Short description

Contract Valued Item Price Scaling Factor

Definition

A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: COCT_RM440000UV09 ValuedItem factorNumber

points

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.points

Short description

Contract Valued Item Difficulty Scaling Factor

Definition

An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: COCT_RM440000UV09 ValuedItem pointNumber

net

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.net

Short description

Total Contract Valued Item Value

Definition

Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: COCT_RM440000UV09 ValuedItem netAmt

payment

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.payment

Short description

Terms of valuation

Definition

Terms of valuation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

paymentDate

0..1

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.paymentDate

Short description

When payment is due

Definition

When payment is due.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

responsible

0..1

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.responsible

Short description

Who will make payment

Definition

Who will make payment.

Data type

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

recipient

0..1

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.recipient

Short description

Who will receive payment

Definition

Who will receive payment.

Data type

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

linkId

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.linkId

Short description

Pointer to specific item

Definition

Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

securityLabelNumber

0..*

There are no (further) constraints on this element

Element id

Contract.term.asset.valuedItem.securityLabelNumber

Short description

Security Labels that define affected terms

Definition

A set of security labels that define which terms are controlled by this condition.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

action

0..*

There are no (further) constraints on this element

Element id

Contract.term.action

Short description

Entity being ascribed responsibility

Definition

An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

Requirements

An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

Comments

Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. For example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, software, or system process. However, only one user may be the initiator/requestor for the event.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Participation

0..1

There are no (further) constraints on this element

Element id

Contract.term.action.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

doNotPerform

0..1

There are no (further) constraints on this element

Element id

Contract.term.action.doNotPerform

Short description

True if the term prohibits the action

Definition

True if the term prohibits the action.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

type

1..1

There are no (further) constraints on this element

Element id

Contract.term.action.type

Short description

Type or form of the action

Definition

Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.

Data type

Binding

Detailed codes for the contract action.

ContractActionCodes (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.performer
rim: RIM Role, Participation Type classes

subject

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.subject

Short description

Entity of the action

Definition

Entity of the action.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Contract.term.action.subject.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.subject.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.subject.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

reference

1..*

There are no (further) constraints on this element

Element id

Contract.term.action.subject.reference

Short description

Entity of the action

Definition

The entity the action is performed or not performed on or for.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

role

0..1

There are no (further) constraints on this element

Element id

Contract.term.action.subject.role

Short description

Role type of the agent

Definition

Role type of agent assigned roles in this Contract.

Data type

ContractActorRoleCodes (example)

Binding

Detailed codes for the contract actor role.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: RoleClass, RoleCode, ParticipationType, ParticipationFunction codes

intent

1..1

There are no (further) constraints on this element

Element id

Contract.term.action.intent

Short description

Purpose for the Contract Term Action

Definition

Reason or purpose for the action stipulated by this Contract Provision.

Data type

Binding

Detailed codes for the contract action reason.

v3.PurposeOfUse (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.reasonCode
w5: FiveWs.why[x]
rim: Examples from ActReason Concept Domains: ActCoverageReason Description:Codes used to specify reasons or criteria relating to coverage provided under a policy or program. May be used to convey reasons pertaining to coverage contractual provisions, including criteria for eligibility, coverage limitations, coverage maximums, or financial participation required of covered parties. ActInformationPrivacyReason Description: The rationale or purpose for an act relating to the management of personal information, such as disclosing personal tax information for the purpose of complying with a court order. ClinicalResearchObservationReason Definition: Specifies the reason that a test was performed or observation collected in a clinical research study. SafetyInvestigationReportReasonType Description: Possible reasons generating a report providing information developed during the investigation of an adverse event or a product problem. ControlActReason Description: Indicates the motivation, cause or rationale of an Act which results in a trigger event. NonPerformanceReasonCode Description: The reason the action was not performed, e.g. why the medication was not taken. If an action was not performed, it is often clinically important to know why the action was not taken. RefusalReasonCode Description: Identifies why a request to add (or activate) a record is being refused. Examples include the receiving system not able to match the identifier and find that record in the receiving system, having no permission, or a detected issue exists which precludes the requested action. Examples from HL7 ActReason Code System: QUALIMP (quality improvement) Description:Operational activities conducted for the purposes of improving the quality of an activity, product, or service. _PatientProfileQueryReasonCode Description: A collection of concepts identifying why the patient's profile is being queried. _ActInformationManagementReason Description:The rationale or purpose for an act relating to information management, such as archiving information for the purpose of complying with an enterprise data retention policy. _ActInvalidReason (ActInvalidReason) Description: Types of reasons why a substance is invalid for use. _NonPerformanceReasonCode Description: The reason the action wasn't performed, e.g. why the medication was not taken. If an action wasn"t performed, it is often clinically important to know why the action wasn"t taken.

linkId

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.linkId

Short description

Pointer to specific item

Definition

Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

status

1..1

There are no (further) constraints on this element

Element id

Contract.term.action.status

Short description

State of the action

Definition

Current state of the term action.

Data type

ContractResourceActionStatusCodes (example)

Binding

Codes for the status of an term action.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

context

0..1

Reference(Encounter | EpisodeOfCare)

There are no (further) constraints on this element

Element id

Contract.term.action.context

Short description

Episode associated with action

Definition

Encounter or Episode with primary association to specified term activity.

Data type

Reference(Encounter | EpisodeOfCare)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

contextLinkId

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.contextLinkId

Short description

Pointer to specific item

Definition

Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

occurrence[x]

0..1

There are no (further) constraints on this element

Element id

Contract.term.action.occurrence[x]

Short description

When action happens

Definition

When action happens.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

occurrenceDateTime

There are no (further) constraints on this element

Data type

occurrencePeriod

There are no (further) constraints on this element

Data type

occurrenceTiming

Timing

There are no (further) constraints on this element

Data type

Timing

requester

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.requester

Short description

Who asked for action

Definition

Who or what initiated the action and has responsibility for its activation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

requesterLinkId

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.requesterLinkId

Short description

Pointer to specific item

Definition

Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

performerType

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.performerType

Short description

Kind of service performer

Definition

The type of individual that is desired or required to perform or not perform the action.

Data type

ProvenanceParticipantType (example)

Binding

Codes for the types of action perfomer.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

performerRole

0..1

There are no (further) constraints on this element

Element id

Contract.term.action.performerRole

Short description

Competency of the performer

Definition

The type of role or competency of an individual desired or required to perform or not perform the action.

Data type

ProvenanceParticipantRole (example)

Binding

Codes for the role of the action performer.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

performer

0..1

There are no (further) constraints on this element

Element id

Contract.term.action.performer

Short description

Actor that wil execute (or not) the action

Definition

Indicates who or what is being asked to perform (or not perform) the ction.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

performerLinkId

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.performerLinkId

Short description

Pointer to specific item

Definition

Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

reasonCode

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.reasonCode

Short description

Why is action (not) needed?

Definition

Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.

Data type

Binding

Detailed codes for the contract action reason.

v3.PurposeOfUse (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

reasonReference

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.reasonReference

Short description

Why is action (not) needed?

Definition

Indicates another resource whose existence justifies permitting or not permitting this action.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

reason

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.reason

Short description

Why action is to be performed

Definition

Describes why the action is to be performed or not performed in textual form.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

reasonLinkId

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.reasonLinkId

Short description

Pointer to specific item

Definition

Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

note

0..*

Annotation

There are no (further) constraints on this element

Element id

Contract.term.action.note

Short description

Comments about the action

Definition

Comments made about the term action made by the requester, performer, subject or other participants.

Data type

Annotation

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

securityLabelNumber

0..*

There are no (further) constraints on this element

Element id

Contract.term.action.securityLabelNumber

Short description

Action restriction numbers

Definition

Security labels that protects the action.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

group

0..*

see (term)

There are no (further) constraints on this element

Element id

Contract.term.group

Short description

Nested Contract Term Group

Definition

Nested group of Contract Provisions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: RIM Grouping or Nesting mechanisms

supportingInfo

0..*

There are no (further) constraints on this element

Element id

Contract.supportingInfo

Short description

Extra Information

Definition

Information that may be needed by/relevant to the performer in their execution of this term action.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

relevantHistory

0..*

Reference(Provenance)

There are no (further) constraints on this element

Element id

Contract.relevantHistory

Short description

Key event in Contract History

Definition

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.

Data type

Reference(Provenance)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

signer

0..*

There are no (further) constraints on this element

Element id

Contract.signer

Short description

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.

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.

Comments

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Participation

0..1

There are no (further) constraints on this element

Element id

Contract.signer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.signer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.signer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

type

1..1

CodingBinding

There are no (further) constraints on this element

Element id

Contract.signer.type

Short description

Contract Signatory Role

Definition

Role of this Contract signer, e.g. notary, grantee.

Data type

ContractSignerTypeCodes (preferred)

Binding

List of parties who may be signing.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.actor
rim: RoleClass, RoleCode, ParticipationType, ParticipationFunction class codes.

party

1..1

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

There are no (further) constraints on this element

Element id

Contract.signer.party

Short description

Contract Signatory Party

Definition

Party which is a signator to this Contract.

Data type

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Request.requester
w5: FiveWs.author
rim: Role Class

signature

1..*

Signature

There are no (further) constraints on this element

Element id

Contract.signer.signature

Short description

Contract Documentation Signature

Definition

Legally binding Contract DSIG signature contents in Base64.

Data type

Signature

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.author
rim: Participation.signatureCode :: CD (0..1) Definition: Whether the participant has attested participation through a signature, or whether such a signature is needed. Examples: A surgical Procedure act object (representing a procedure report) requires a signature of the performing and responsible surgeon, and possibly other participants; The participant intends to provide a signature. Participation.signatureText :: ED (0..1) Definition: A textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. UsageNotes: The signature can be represented either inline or by reference according to the ED data type. Typical cases are 1) Paper-based signatures: the ED data type may refer to a document or other resource that can be retrieved through an electronic interface to a hardcopy archive. 2) Electronic signature: this attribute can represent virtually any electronic signature scheme. 3) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. Examples: 1) An "author" participant assumes accountability for the truth of the Act statement to the best of his knowledge. 2) An information recipient only attests to the fact that he or she has received the information.

friendly

0..*

There are no (further) constraints on this element

Element id

Contract.friendly

Short description

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: LanguageCommunication

0..1

There are no (further) constraints on this element

Element id

Contract.friendly.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.friendly.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.friendly.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

content[x]

1..1

There are no (further) constraints on this element

Element id

Contract.friendly.content[x]

Short description

Easily comprehended representation of this Contract

Definition

Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: Act.text Definition: A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Act.

contentAttachment

There are no (further) constraints on this element

Data type

contentReference

Reference(Composition | DocumentReference | QuestionnaireResponse)

There are no (further) constraints on this element

Data type

Reference(Composition | DocumentReference | QuestionnaireResponse)

legal

0..1

Element id

Contract.legal

Short description

URL to website containing the contract

Definition

List of Legal expressions or representations of this Contract.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: LanguageCommunication
ContractToHVOAvtalLogical: url

0..1

There are no (further) constraints on this element

Element id

Contract.legal.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.legal.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.legal.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

content[x]

1..1

Element id

Contract.legal.content[x]

Short description

Contract Legal Text

Definition

Contract legal text in human renderable form.

Slicing

Unordered, Open, by $this(Type)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: Example: Act.text of an Act coded as with ActPrivacyLaw, ActPolicy code

contentReference

Reference(Composition | DocumentReference | QuestionnaireResponse)

There are no (further) constraints on this element

Data type

Reference(Composition | DocumentReference | QuestionnaireResponse)

contentAttachment

1..1

Element id

Contract.legal.content[x]:contentAttachment

Short description

Contract Legal Text

Definition

Contract legal text in human renderable form.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: Example: Act.text of an Act coded as with ActPrivacyLaw, ActPolicy code

0..1

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

contentType

0..1

codeBinding

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.contentType

Short description

Mime type of the content, with charset etc.

Definition

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

Requirements

Processors of the data need to be able to know how to interpret the data.

Data type

Binding

The mime type of an attachment. Any valid mime type is allowed.

Mime Types (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

text/plain; charset=UTF-8, image/png

Mappings

v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
rim: ./mediaType, ./charset

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.language

Short description

Human language of the content (BCP-47)

Definition

The human language of the content. The value can be any valid value according to BCP 47.

Requirements

Users need to be able to choose between the languages in a set of attachments.

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

en-AU

Mappings

rim: ./language

data

0..1

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.data

Short description

Data inline, base64ed

Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: ED.5
rim: ./data

url

S Σ

1..1

url

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.url

Short description

Uri where the data can be found

Definition

A location where the data can be accessed.

Requirements

The data needs to be transmitted by reference.

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Data type

url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/logo-small.png

Mappings

v2: RP.1+RP.2 - if they refer to a URL (see v2.6)
rim: ./reference/literal

size

0..1

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.size

Short description

Number of bytes of content (if url provided)

Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A (needs data type R3 proposal)

hash

0..1

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.hash

Short description

Hash of the data (sha-1, base64ed)

Definition

The calculated hash of the data using SHA-1. Represented using base64.

Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]

title

0..1

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.title

Short description

Label to display in place of the data

Definition

A label or set of text to display in place of the data.

Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Official Corporate Logo

Mappings

rim: ./title/data

creation

0..1

There are no (further) constraints on this element

Element id

Contract.legal.content[x]:contentAttachment.creation

Short description

Date attachment was first created

Definition

The date that the attachment was first created.

Requirements

This is often tracked as an integrity issue for use of the attachment.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A (needs data type R3 proposal)

rule

0..*

There are no (further) constraints on this element

Element id

Contract.rule

Short description

Computable Contract Language

Definition

List of Computable Policy Rule Language Representations of this Contract.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: LanguageCommunication

0..1

There are no (further) constraints on this element

Element id

Contract.rule.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Contract.rule.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Contract.rule.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

content[x]

1..1

There are no (further) constraints on this element

Element id

Contract.rule.content[x]

Short description

Computable Contract Rules

Definition

Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: Computable Policy Consent [Observation: templateId 2.16.840.1.113883.3.445.16] This template is used to represent an alternative representation of the Privacy Consent Directive (e.g.,ODRL, XrML, XACML) as a computer-readable set of rules. An implementation may use any appropriate representations of the privacy consent in addition to the "ConsentDirectiveStructuredDefinition" which uses the Clinical Template structure to express the elements of a consent directive in an interoperable way. 1. SHALL contain exactly one [1..1] templateId ( CONF-CD-16 ) such that it a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.3.445.16" 2. SHALL contain exactly one [1..1] @moodCode="DEF" (CodeSystem: 2.16.840.1.113883.5.1001 HL7ActMood) (CONF:14912) 3. SHALL contain exactly one [1..1] code (CONF:9139)/@code="57016-8" Privacy Policy Acknowledgement Document (CodeSystem: 2.16.840.1.113883.6.1 LOINC) (CONF:9138) It specifies the LOINC code corresponding to "Privacy Policy Acknowledgement Document", it is fixed at this value. 4. SHOULD contain zero or more [0..*] value with @xsi:type="ANY" (CONF:9140) The value contains the computable representation of the policy. This may be a standard-based access control or attribute control based policy (See "References"). Computable Policy Consent example  <entryRelationship typeCode="COMP"> <templateId root="2.16.840.1.113883.3.445.16" /> <observationMedia classCode="OBS" moodCode="EVN"> <value mediaType="text/xml" representation="TXT"> ... </value> </observationMedia> </entryRelationship>

contentAttachment

There are no (further) constraints on this element

Data type

Reference(DocumentReference)

contentReference

There are no (further) constraints on this element

Data type

Reference(DocumentReference)

legallyBinding[x]

0..1

There are no (further) constraints on this element

Element id

Contract.legallyBinding[x]

Short description

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: DocumentCompletion code system AU (authenticated) Description: A completion status in which a document has been signed manually or electronically by one or more individuals who attest to its accuracy. No explicit determination is made that the assigned individual has performed the authentication. While the standard allows multiple instances of authentication, it would be typical to have a single instance of authentication, usually by the assigned individual.

legallyBindingAttachment

There are no (further) constraints on this element

Data type