Page Status: draft 2024-12-02
Contract
Page index
Introduction
Regarding information about how the "must support"-property is used in the Swedish National Catalog of Organization, Offerings and Contracts, please refer to the page Resources.
Overview
HVOContract (Contract) | I | Contract | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
additionalRelationship | S I | 0..* | Extension(Complex) |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ | 1..* | Identifier |
url | 0..1 | uri | |
version | Σ | 0..1 | string |
status | Σ ?! | 0..1 | codeBinding |
legalState | 0..1 | CodeableConceptBinding | |
instantiatesCanonical | I | 0..1 | Reference(Contract) |
instantiatesUri | 0..1 | uri | |
contentDerivative | 0..1 | CodeableConcept | |
issued | Σ | 0..1 | dateTime |
applies | S Σ I | 1..1 | Period |
id | 0..1 | string | |
extension | I | 0..* | Extension |
start | S Σ I | 1..1 | dateTime |
end | S Σ I | 0..1 | dateTime |
expirationType | 0..1 | CodeableConcept | |
subject | S Σ I | 0..* | Reference(HVOOrganizationAffiliation) |
authority | I | 0..* | Reference(Organization) |
domain | I | 0..* | Reference(Location) |
site | I | 0..* | Reference(Location) |
name | Σ | 0..1 | string |
title | Σ | 0..1 | string |
subtitle | 0..1 | string | |
alias | 0..* | string | |
author | I | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Organization) |
scope | 0..1 | CodeableConcept | |
topic[x] | 0..1 | ||
topicCodeableConcept | CodeableConcept | ||
topicReference | Reference(Resource) | ||
type | S Σ | 0..1 | CodeableConceptBinding |
subType | S Σ | 0..1 | CodeableConceptBinding |
contentDefinition | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | 1..1 | CodeableConcept | |
subType | 0..1 | CodeableConcept | |
publisher | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) |
publicationDate | 0..1 | dateTime | |
publicationStatus | 1..1 | codeBinding | |
copyright | 0..1 | markdown | |
term | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
identifier | Σ | 0..1 | Identifier |
issued | Σ | 0..1 | dateTime |
applies | Σ I | 0..1 | Period |
topic[x] | 0..1 | ||
topicCodeableConcept | CodeableConcept | ||
topicReference | Reference(Resource) | ||
type | 0..1 | CodeableConcept | |
subType | 0..1 | CodeableConcept | |
text | S Σ | 1..1 | string |
securityLabel | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
number | 0..* | unsignedInt | |
classification | 1..1 | Coding | |
category | 0..* | Coding | |
control | 0..* | Coding | |
offer | S | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
identifier | 0..* | Identifier | |
party | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
reference | I | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) |
role | 1..1 | CodeableConcept | |
topic | Σ I | 0..1 | Reference(Resource) |
type | 0..1 | CodeableConcept | |
decision | 0..1 | CodeableConceptBinding | |
decisionMode | 0..* | CodeableConcept | |
answer | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
value[x] | 1..1 | ||
valueBoolean | boolean | ||
valueDecimal | decimal | ||
valueInteger | integer | ||
valueDate | date | ||
valueDateTime | dateTime | ||
valueTime | time | ||
valueString | string | ||
valueUri | uri | ||
valueAttachment | Attachment | ||
valueCoding | Coding | ||
valueQuantity | Quantity | ||
valueReference | Reference(Resource) | ||
text | S | 0..1 | string |
linkId | 0..* | string | |
securityLabelNumber | 0..* | unsignedInt | |
asset | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
scope | 0..1 | CodeableConcept | |
type | 0..* | CodeableConcept | |
typeReference | I | 0..* | Reference(Resource) |
subtype | 0..* | CodeableConcept | |
relationship | 0..1 | CodingBinding | |
context | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
reference | I | 0..1 | Reference(Resource) |
code | 0..* | CodeableConcept | |
text | 0..1 | string | |
condition | 0..1 | string | |
periodType | 0..* | CodeableConcept | |
period | I | 0..* | Period |
usePeriod | I | 0..* | Period |
text | 0..1 | string | |
linkId | 0..* | string | |
answer | 0..* | see (answer) | |
securityLabelNumber | 0..* | unsignedInt | |
valuedItem | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
entity[x] | 0..1 | ||
entityCodeableConcept | CodeableConcept | ||
entityReference | Reference(Resource) | ||
identifier | 0..1 | Identifier | |
effectiveTime | 0..1 | dateTime | |
quantity | I | 0..1 | SimpleQuantity |
unitPrice | 0..1 | Money | |
factor | 0..1 | decimal | |
points | 0..1 | decimal | |
net | 0..1 | Money | |
payment | 0..1 | string | |
paymentDate | 0..1 | dateTime | |
responsible | I | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
recipient | I | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
linkId | 0..* | string | |
securityLabelNumber | 0..* | unsignedInt | |
action | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
doNotPerform | ?! | 0..1 | boolean |
type | 1..1 | CodeableConcept | |
subject | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
reference | I | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) |
role | 0..1 | CodeableConcept | |
intent | 1..1 | CodeableConcept | |
linkId | 0..* | string | |
status | 1..1 | CodeableConcept | |
context | I | 0..1 | Reference(Encounter | EpisodeOfCare) |
contextLinkId | 0..* | string | |
occurrence[x] | 0..1 | ||
occurrenceDateTime | dateTime | ||
occurrencePeriod | Period | ||
occurrenceTiming | Timing | ||
requester | I | 0..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) |
requesterLinkId | 0..* | string | |
performerType | 0..* | CodeableConcept | |
performerRole | 0..1 | CodeableConcept | |
performer | I | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) |
performerLinkId | 0..* | string | |
reasonCode | 0..* | CodeableConcept | |
reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) |
reason | 0..* | string | |
reasonLinkId | 0..* | string | |
note | 0..* | Annotation | |
securityLabelNumber | 0..* | unsignedInt | |
group | 0..* | see (term) | |
supportingInfo | I | 0..* | Reference(Resource) |
relevantHistory | I | 0..* | Reference(Provenance) |
signer | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | 1..1 | CodingBinding | |
party | I | 1..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
signature | 1..* | Signature | |
friendly | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
content[x] | 1..1 | ||
contentAttachment | Attachment | ||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | ||
legal | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
content[x] | 1..1 | ||
(All Slices) | |||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | ||
contentAttachment | S | 1..1 | Attachment |
rule | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
content[x] | 1..1 | ||
contentAttachment | Attachment | ||
contentReference | Reference(DocumentReference) | ||
legallyBinding[x] | 0..1 | ||
legallyBindingAttachment | Attachment | ||
legallyBindingReference | Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) |
Contract | |
Definition | Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Contract.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Contract.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Contract.implicitRules | |
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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Contract.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
Mappings |
|
Contract.text | |
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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
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. |
Invariants |
|
Mappings |
|
Contract.contained | |
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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
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. |
Mappings |
|
Contract.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.extension:additionalRelationship | |
Definition | Extension for Contract to supply information about relationships between contracts. |
Cardinality | 0...* |
Type | Extension(Complex) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Contract.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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 | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.identifier | |
Definition | Unique identifier for this Contract or a derivative that references a Source Contract. |
Cardinality | 1...* |
Type | Identifier |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Contract.url | |
Definition | Canonical identifier for this contract, represented as a URI (globally unique). |
Cardinality | 0...1 |
Type | uri |
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. |
Invariants |
|
Mappings |
|
Contract.version | |
Definition | An edition identifier used for business purposes to label business significant variants. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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]. |
Invariants |
|
Mappings |
|
Contract.status | |
Definition | The status of the resource instance. |
Cardinality | 0...1 |
Type | code |
Binding | A code specifying the state of the resource instance. |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Contract.legalState | |
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. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Detailed codes for the legal state of a contract. |
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. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.instantiatesCanonical | |
Definition | The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. |
Cardinality | 0...1 |
Type | Reference(Contract) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.instantiatesUri | |
Definition | The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. |
Cardinality | 0...1 |
Type | uri |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Contract.contentDerivative | |
Definition | The minimal content derived from the basal information source at a specific stage in its lifecycle. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source. |
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. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.issued | |
Definition | When this Contract was issued. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Requirements | The Contract issuance dateTime often precedes the Contract effective dateTime. |
Invariants |
|
Mappings |
|
Contract.applies | |
Definition | Relevant time or time-period when this Contract is applicable. |
Cardinality | 1...1 |
Type | Period |
Must Support | True |
Summary | True |
Requirements | The dateTime upon which the Contract is binding. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Contract.applies.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.applies.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.applies.start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
Contract.applies.end | |
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. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Contract.expirationType | |
Definition | Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes for the Cessation of Contracts. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.subject | |
Definition | The target entity impacted by or of interest to parties to the agreement. |
Cardinality | 0...* |
Type | Reference(HVOOrganizationAffiliation) |
Must Support | True |
Summary | True |
Alias | Patient |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.authority | |
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. |
Cardinality | 0...* |
Type | Reference(Organization) |
Requirements | The governance framework responsible for ensuring compliance with or enforcement of the contract or policy. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.domain | |
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. |
Cardinality | 0...* |
Type | Reference(Location) |
Alias | scope of governance jurisdiction |
Requirements | The entities bound by governance to comply with the enforcement of contracts or policies by a recognized authority. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.site | |
Definition | Sites in which the contract is complied with, exercised, or in force. |
Cardinality | 0...* |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.name | |
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Contract.title | |
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.subtitle | |
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. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.alias | |
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. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.author | |
Definition | The individual or organization that authored the Contract definition, derivative, or instance in any legal state. |
Cardinality | 0...1 |
Type | Reference(Patient | Practitioner | PractitionerRole | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.scope | |
Definition | A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes for the range of legal concerns. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.topic[x] | |
Definition | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. |
Cardinality | 0...1 |
Type | CodeableConcept |
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. |
Invariants |
|
Mappings |
|
Contract.type | |
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. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | List of overall contract codes. |
Must Support | True |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.subType | |
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. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Detailed codes within the above. |
Must Support | True |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.contentDefinition | |
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. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.contentDefinition.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.contentDefinition.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.contentDefinition.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.contentDefinition.type | |
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. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Detailed codes for the definition of contracts. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.contentDefinition.subType | |
Definition | Detailed Precusory content type. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Detailed codes for the additional definition of contracts. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.contentDefinition.publisher | |
Definition | The individual or organization that published the Contract precursor content. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.contentDefinition.publicationDate | |
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. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Contract.contentDefinition.publicationStatus | |
Definition | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated. |
Cardinality | 1...1 |
Type | code |
Binding | Status of the publication of contract content. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.contentDefinition.copyright | |
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. |
Cardinality | 0...1 |
Type | markdown |
Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ |
Invariants |
|
Mappings |
|
Contract.term | |
Definition | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Mappings |
|
Contract.term.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.identifier | |
Definition | Unique identifier for this particular Contract Provision. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Invariants |
|
Mappings |
|
Contract.term.issued | |
Definition | When this Contract Provision was issued. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
Contract.term.applies | |
Definition | Relevant time or time-period when this Contract Provision is applicable. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Contract.term.topic[x] | |
Definition | The entity that the term applies to. |
Cardinality | 0...1 |
Type | CodeableConcept |
Invariants |
|
Mappings |
|
Contract.term.type | |
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. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Detailed codes for the types of contract provisions. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.subType | |
Definition | A specialized legal clause or condition based on overarching contract type. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Detailed codes for the subtypes of contract provisions. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.text | |
Definition | Statement of a provision in a policy or a contract. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.securityLabel | |
Definition | Security labels that protect the handling of information about the term and its elements, which may be specifically identified.. |
Cardinality | 0...* |
Type | BackboneElement |
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. |
Invariants |
|
Mappings |
|
Contract.term.securityLabel.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.securityLabel.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.securityLabel.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.securityLabel.number | |
Definition | Number used to link this term or term element to the applicable Security Label. |
Cardinality | 0...* |
Type | unsignedInt |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Contract.term.securityLabel.classification | |
Definition | Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements. |
Cardinality | 1...1 |
Type | Coding |
Binding | Codes for confidentiality protection. |
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. |
Invariants |
|
Mappings |
|
Contract.term.securityLabel.category | |
Definition | Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes for policy category. |
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. |
Invariants |
|
Mappings |
|
Contract.term.securityLabel.control | |
Definition | Security label privacy tag that species the manner in which term and/or term elements are to be protected. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes for handling instructions. |
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. |
Invariants |
|
Mappings |
|
Contract.term.offer | |
Definition | The matter of concern in the context of this provision of the agrement. |
Cardinality | 1...1 |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Mappings |
|
Contract.term.offer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.offer.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.offer.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.offer.identifier | |
Definition | Unique identifier for this particular Contract Provision. |
Cardinality | 0...* |
Type | Identifier |
Invariants |
|
Mappings |
|
Contract.term.offer.party | |
Definition | Offer Recipient. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.term.offer.party.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.offer.party.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.offer.party.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.offer.party.reference | |
Definition | Participant in the offer. |
Cardinality | 1...* |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.offer.party.role | |
Definition | How the party participates in the offer. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes for offer participant roles. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.offer.topic | |
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). |
Cardinality | 0...1 |
Type | Reference(Resource) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Contract.term.offer.type | |
Definition | Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Detailed codes for the types of contract provisions. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.offer.decision | |
Definition | Type of choice made by accepting party with respect to an offer made by an offeror/ grantee. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The type of decision made by a grantor with respect to an offer made by a 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". |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.offer.decisionMode | |
Definition | How the decision about a Contract was conveyed. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes for conveying a decision. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.offer.answer | |
Definition | Response to offer text. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.term.offer.answer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.offer.answer.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.offer.answer.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.offer.answer.value[x] | |
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. |
Cardinality | 1...1 |
Type | boolean |
Invariants |
|
Mappings |
|
Contract.term.offer.text | |
Definition | Human readable form of this Contract Offer. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.offer.linkId | |
Definition | The id of the clause or question text of the offer in the referenced questionnaire/response. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.offer.securityLabelNumber | |
Definition | Security labels that protects the offer. |
Cardinality | 0...* |
Type | unsignedInt |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Contract.term.asset | |
Definition | Contract Term Asset List. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.term.asset.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.asset.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.asset.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.asset.scope | |
Definition | Differentiates the kind of the asset . |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes for scoping an asset. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.asset.type | |
Definition | Target entity type about which the term may be concerned. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Condes for the type of an asset. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.asset.typeReference | |
Definition | Associated entities. |
Cardinality | 0...* |
Type | Reference(Resource) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.asset.subtype | |
Definition | May be a subtype or part of an offered asset. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Condes for the sub-type of an asset. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.asset.relationship | |
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. |
Cardinality | 0...1 |
Type | Coding |
Binding | The class (type) of information a consent rule covers. |
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. |
Invariants |
|
Mappings |
|
Contract.term.asset.context | |
Definition | Circumstance of the asset. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.term.asset.context.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.asset.context.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.asset.context.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.asset.context.reference | |
Definition | Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. |
Cardinality | 0...1 |
Type | Reference(Resource) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.asset.context.code | |
Definition | Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes for the context of the asset. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.asset.context.text | |
Definition | Context description. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.asset.condition | |
Definition | Description of the quality and completeness of the asset that imay be a factor in its valuation. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.asset.periodType | |
Definition | Type of Asset availability for use or ownership. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes for asset availability. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.asset.period | |
Definition | Asset relevant contractual time period. |
Cardinality | 0...* |
Type | Period |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Contract.term.asset.usePeriod | |
Definition | Time period of asset use. |
Cardinality | 0...* |
Type | Period |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Contract.term.asset.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. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.asset.linkId | |
Definition | Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.asset.answer | |
Definition | Response to assets. |
Cardinality | 0...* |
Type | see (answer) |
Contract.term.asset.securityLabelNumber | |
Definition | Security labels that protects the asset. |
Cardinality | 0...* |
Type | unsignedInt |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem | |
Definition | Contract Valued Item List. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.asset.valuedItem.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.entity[x] | |
Definition | Specific type of Contract Valued Item that may be priced. |
Cardinality | 0...1 |
Type | CodeableConcept |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.identifier | |
Definition | Identifies a Contract Valued Item instance. |
Cardinality | 0...1 |
Type | Identifier |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.effectiveTime | |
Definition | Indicates the time during which this Contract ValuedItem information is effective. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.quantity | |
Definition | Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.unitPrice | |
Definition | A Contract Valued Item unit valuation measure. |
Cardinality | 0...1 |
Type | Money |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.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. |
Cardinality | 0...1 |
Type | decimal |
Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.points | |
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. |
Cardinality | 0...1 |
Type | decimal |
Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.net | |
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. |
Cardinality | 0...1 |
Type | Money |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.payment | |
Definition | Terms of valuation. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.paymentDate | |
Definition | When payment is due. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.responsible | |
Definition | Who will make payment. |
Cardinality | 0...1 |
Type | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.recipient | |
Definition | Who will receive payment. |
Cardinality | 0...1 |
Type | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.linkId | |
Definition | Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.asset.valuedItem.securityLabelNumber | |
Definition | A set of security labels that define which terms are controlled by this condition. |
Cardinality | 0...* |
Type | unsignedInt |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Contract.term.action | |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Cardinality | 0...* |
Type | BackboneElement |
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. |
Invariants |
|
Mappings |
|
Contract.term.action.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.action.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.action.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.action.doNotPerform | |
Definition | True if the term prohibits the action. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Invariants |
|
Mappings |
|
Contract.term.action.type | |
Definition | Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Detailed codes for the contract action. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.action.subject | |
Definition | Entity of the action. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.term.action.subject.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.term.action.subject.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.term.action.subject.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.term.action.subject.reference | |
Definition | The entity the action is performed or not performed on or for. |
Cardinality | 1...* |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.action.subject.role | |
Definition | Role type of agent assigned roles in this Contract. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Detailed codes for the contract actor role. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.action.intent | |
Definition | Reason or purpose for the action stipulated by this Contract Provision. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Detailed codes for the contract action reason. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.action.linkId | |
Definition | Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.action.status | |
Definition | Current state of the term action. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes for the status of an term action. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.action.context | |
Definition | Encounter or Episode with primary association to specified term activity. |
Cardinality | 0...1 |
Type | Reference(Encounter | EpisodeOfCare) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.action.contextLinkId | |
Definition | Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.action.occurrence[x] | |
Definition | When action happens. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Contract.term.action.requester | |
Definition | Who or what initiated the action and has responsibility for its activation. |
Cardinality | 0...* |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.action.requesterLinkId | |
Definition | Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.action.performerType | |
Definition | The type of individual that is desired or required to perform or not perform the action. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes for the types of action perfomer. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.action.performerRole | |
Definition | The type of role or competency of an individual desired or required to perform or not perform the action. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes for the role of the action performer. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.action.performer | |
Definition | Indicates who or what is being asked to perform (or not perform) the ction. |
Cardinality | 0...1 |
Type | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.action.performerLinkId | |
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. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.action.reasonCode | |
Definition | Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Detailed codes for the contract action reason. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Contract.term.action.reasonReference | |
Definition | Indicates another resource whose existence justifies permitting or not permitting this action. |
Cardinality | 0...* |
Type | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.term.action.reason | |
Definition | Describes why the action is to be performed or not performed in textual form. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.action.reasonLinkId | |
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. |
Cardinality | 0...* |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Contract.term.action.note | |
Definition | Comments made about the term action made by the requester, performer, subject or other participants. |
Cardinality | 0...* |
Type | Annotation |
Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
Invariants |
|
Mappings |
|
Contract.term.action.securityLabelNumber | |
Definition | Security labels that protects the action. |
Cardinality | 0...* |
Type | unsignedInt |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Contract.term.group | |
Definition | Nested group of Contract Provisions. |
Cardinality | 0...* |
Type | see (term) |
Mappings |
|
Contract.supportingInfo | |
Definition | Information that may be needed by/relevant to the performer in their execution of this term action. |
Cardinality | 0...* |
Type | Reference(Resource) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.relevantHistory | |
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. |
Cardinality | 0...* |
Type | Reference(Provenance) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.signer | |
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. |
Cardinality | 0...* |
Type | BackboneElement |
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. |
Invariants |
|
Mappings |
|
Contract.signer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.signer.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.signer.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.signer.type | |
Definition | Role of this Contract signer, e.g. notary, grantee. |
Cardinality | 1...1 |
Type | Coding |
Binding | List of parties who may be signing. |
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. |
Invariants |
|
Mappings |
|
Contract.signer.party | |
Definition | Party which is a signator to this Contract. |
Cardinality | 1...1 |
Type | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Contract.signer.signature | |
Definition | Legally binding Contract DSIG signature contents in Base64. |
Cardinality | 1...* |
Type | Signature |
Comments | The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form. |
Invariants |
|
Mappings |
|
Contract.friendly | |
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. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.friendly.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.friendly.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.friendly.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.friendly.content[x] | |
Definition | Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability. |
Cardinality | 1...1 |
Type | Attachment |
Invariants |
|
Mappings |
|
Contract.legal | |
Definition | List of Legal expressions or representations of this Contract. |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Mappings |
|
Contract.legal.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.legal.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.legal.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.legal.content[x] | |
Definition | Contract legal text in human renderable form. |
Cardinality | 1...1 |
Type | Attachment |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Contract.legal.content[x]:contentAttachment | |
Definition | Contract legal text in human renderable form. |
Cardinality | 1...1 |
Type | Attachment |
Must Support | True |
Invariants |
|
Mappings |
|
Contract.rule | |
Definition | List of Computable Policy Rule Language Representations of this Contract. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Contract.rule.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Contract.rule.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Contract.rule.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | 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. |
Invariants |
|
Mappings |
|
Contract.rule.content[x] | |
Definition | Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal). |
Cardinality | 1...1 |
Type | Attachment |
Invariants |
|
Mappings |
|
Contract.legallyBinding[x] | |
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. |
Cardinality | 0...1 |
Type | Attachment |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="HVOContract" /> <url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContract" /> <name value="HVOContract" /> <title value="Contract" /> <status value="draft" /> <description value="HVOContract contains information about an agreement that entails rights and obligations for the parties involved" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Contract" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Contract" /> <derivation value="constraint" /> <differential> <element id="Contract.extension:additionalRelationship"> <path value="Contract.extension" /> <sliceName value="additionalRelationship" /> <min value="0" /> <max value="*" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContractAdditionalRelationshipExtension" /> </type> <mustSupport value="true" /> </element> <element id="Contract.identifier"> <path value="Contract.identifier" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Contract.applies"> <path value="Contract.applies" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Contract.applies.start"> <path value="Contract.applies.start" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Contract.applies.end"> <path value="Contract.applies.end" /> <mustSupport value="true" /> </element> <element id="Contract.subject"> <path value="Contract.subject" /> <type> <code value="Reference" /> <targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" /> </type> <mustSupport value="true" /> </element> <element id="Contract.type"> <path value="Contract.type" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-contract-type-lfu" /> </binding> </element> <element id="Contract.subType"> <path value="Contract.subType" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-contract-procurement-regulation" /> </binding> </element> <element id="Contract.term"> <path value="Contract.term" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Contract.term.text"> <path value="Contract.term.text" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Contract.term.offer"> <path value="Contract.term.offer" /> <mustSupport value="true" /> </element> <element id="Contract.term.offer.text"> <path value="Contract.term.offer.text" /> <mustSupport value="true" /> </element> <element id="Contract.legal"> <path value="Contract.legal" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Contract.legal.content[x]"> <path value="Contract.legal.content[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> </element> <element id="Contract.legal.content[x]:contentAttachment"> <path value="Contract.legal.content[x]" /> <sliceName value="contentAttachment" /> <min value="1" /> <max value="1" /> <type> <code value="Attachment" /> </type> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "HVOContract", "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContract", "name": "HVOContract", "title": "Contract", "status": "draft", "description": "HVOContract contains information about an agreement that entails rights and obligations for the parties involved", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Contract", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Contract", "derivation": "constraint", "differential": { "element": [ { "id": "Contract.extension:additionalRelationship", "path": "Contract.extension", "sliceName": "additionalRelationship", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContractAdditionalRelationshipExtension" ] } ], "mustSupport": true }, { "id": "Contract.identifier", "path": "Contract.identifier", "min": 1, "mustSupport": true }, { "id": "Contract.applies", "path": "Contract.applies", "min": 1, "mustSupport": true }, { "id": "Contract.applies.start", "path": "Contract.applies.start", "min": 1, "mustSupport": true }, { "id": "Contract.applies.end", "path": "Contract.applies.end", "mustSupport": true }, { "id": "Contract.subject", "path": "Contract.subject", "type": [ { "code": "Reference", "targetProfile": [ "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" ] } ], "mustSupport": true }, { "id": "Contract.type", "path": "Contract.type", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-contract-type-lfu" } }, { "id": "Contract.subType", "path": "Contract.subType", "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-contract-procurement-regulation" } }, { "id": "Contract.term", "path": "Contract.term", "max": "1", "mustSupport": true }, { "id": "Contract.term.text", "path": "Contract.term.text", "min": 1, "mustSupport": true }, { "id": "Contract.term.offer", "path": "Contract.term.offer", "mustSupport": true }, { "id": "Contract.term.offer.text", "path": "Contract.term.offer.text", "mustSupport": true }, { "id": "Contract.legal", "path": "Contract.legal", "max": "1", "mustSupport": true }, { "id": "Contract.legal.content[x]", "path": "Contract.legal.content[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" } }, { "id": "Contract.legal.content[x]:contentAttachment", "path": "Contract.legal.content[x]", "sliceName": "contentAttachment", "min": 1, "max": "1", "type": [ { "code": "Attachment" } ], "mustSupport": true } ] } }
Details
Supported operations
HTTP methods
Operation | Supported | Comment |
---|---|---|
Search (GET, POST) | yes | Kommentar |
Insert (POST) | yes/no | Kommentar |
Update (PUT) | yes/no | Kommentar |
Delete (DEL) | yes/no | Kommentar |
Operation (GET, POST) | yes/no | Kommentar |
Query operations
Supported Queries
.../Contract/[id]
.../Contract?_id=[LogicalId]
.../Contract/_search?_id=[LogicalId]
Include & reverse includes
Supported usage of include and revinclude. This kind of search returns a bundle of both the base resource and the related resources specified in the parameter.
.../Contract?[parameters]&_include=Contract:subject
returns a Contract and its OrganizationAffiliation subjects.../Contract?[parameters]&_include=Contract:subject&_include:iterate=OrganizationAffiliation:organization
returns a Contract, its OrganizationAffiliation subjects and the subjects' related HVOOrganizations.../Contract?[parameters]&_include=Contract:subject&_include:iterate=OrganizationAffiliation:healthcareService&_include:iterate=HealthcareService:providedBy
returns a Contract, its OrganizationAffiliation subjects and the HVOServices the subjects refer to as well as the HVOOrganizationalUnits which provide those Services.
Search parameters
Parameter | Description | Comment |
---|---|---|
Contract/[LogicalId] | A read based on the logical ID (UUID) of a Contract. | |
_id | Logical ID (UUID) of a Contract. | |
_include | Subject resource to include in the response. | See HL7 Include other resources for more information. |
_revinclude | Related resources of the specified type to include in the response. | See HL7 Include other resources for more information. |
Other operations
Operation name | HTTP verbs | Comment |
---|---|---|
$namn | Verb | Kommentar |