Contract
Full Profile Definition: | Profile: Contract |
Resource Content:
Differential
Contract | I | Contract | There are no (further) constraints on this element Element idContract Legal Agreement DefinitionLegally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idContract.meta Metadata about the resource DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idContract.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idContract.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idContract.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
meta-source | Σ | 1..1 | uri | Element idContract.meta.source:meta-source uri of the data source DefinitionTypically the data owner's URL followed by a source/file description mandatory for all resources in bWell's FHIR Server In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
example of meta.source https://www.icanbwell.com/provider-directory Mappings
|
profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idContract.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
|
meta-security | Σ | 1..* | CodingBinding | Element idContract.meta.security:meta-security security tags representing the data's owner, vendor, and accessibility Definitiondata owner: data vendor: data access: /owner & /access are mandatory for all resources in bWell's FHIR Server The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
example of data owner security tag { "system": "https://www.icanbwell.com/owner", "code": "bwell" } example of data access security tag { "system": "https://www.icanbwell.com/access", "code": "bwell" } example of data vendor security tag { "system": "https://www.icanbwell.com/vendor", "code": "bwell" } Mappings
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idContract.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idContract.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idContract.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idContract.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idContract.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idContract.identifier Contract number DefinitionUnique identifier for this Contract or a derivative that references a Source Contract. 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.
|
url | 0..1 | uri | There are no (further) constraints on this element Element idContract.url Basal definition DefinitionCanonical identifier for this contract, represented as a URI (globally unique). 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. Used in a domain that uses a supplied contract repository.
| |
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.version Business edition DefinitionAn edition identifier used for business purposes to label business significant variants. 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. 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].
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idContract.status amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated DefinitionThe status of the resource instance. This is the Contract Business Workflow Status. This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active. A code specifying the state of the resource instance.
|
legalState | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idContract.legalState Negotiation status DefinitionLegal 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. 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. 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. Detailed codes for the legal state of a contract.
| |
instantiatesCanonical | I | 0..1 | Reference(Contract) | There are no (further) constraints on this element Element idContract.instantiatesCanonical Source Contract Definition DefinitionThe URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. 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.
|
instantiatesUri | 0..1 | uri | There are no (further) constraints on this element Element idContract.instantiatesUri External Contract Definition DefinitionThe URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
contentDerivative | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.contentDerivative Content derived from the basal information DefinitionThe minimal content derived from the basal information source at a specific stage in its lifecycle. 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. 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. This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source.
| |
issued | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.issued When this Contract was issued DefinitionWhen this Contract was issued. The Contract issuance dateTime often precedes the Contract effective dateTime.
|
applies | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idContract.applies Effective time DefinitionRelevant time or time-period when this Contract is applicable. The dateTime upon which the Contract is binding. 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.
|
expirationType | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.expirationType Contract cessation cause DefinitionEvent resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. 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. Codes for the Cessation of Contracts.
| |
subject | Σ I | 0..* | Reference(Profile: Patient) | Element idContract.subject The patient who signed the contract Alternate namesPatient DefinitionThe target entity impacted by or of interest to parties to the agreement. 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. 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.
|
authority | I | 0..* | Reference(Profile: Insurance Company | https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-partner-organization | Profile: Healthcare Organization) | Element idContract.authority Contract is signed through which organization DefinitionA 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. The governance framework responsible for ensuring compliance with or enforcement of the contract or policy. 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. Reference(Profile: Insurance Company | https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-partner-organization | Profile: Healthcare Organization) Constraints
|
domain | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element idContract.domain A sphere of control governed by an authoritative jurisdiction, organization, or person Alternate namesscope of governance jurisdiction DefinitionRecognized 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. The entities bound by governance to comply with the enforcement of contracts or policies by a recognized authority. 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.
|
site | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element idContract.site Specific Location DefinitionSites in which the contract is complied with, exercised, or in force. 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.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.name Computer friendly designation DefinitionA 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. Support human navigation and code generation. 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.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.title Human Friendly name DefinitionA short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size
|
subtitle | 0..1 | string | There are no (further) constraints on this element Element idContract.subtitle Subordinate Friendly name DefinitionAn explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
alias | 0..* | string | There are no (further) constraints on this element Element idContract.alias Acronym or short name DefinitionAlternative 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
author | S I | 0..1 | Reference(Profile: Patient | Profile: Healthcare Organization | https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-partner-organization | Profile: Insurance Company) | Element idContract.author who owns the contract program. DefinitionThe individual or organization that authored the Contract definition, derivative, or instance in any legal state. 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. Reference(Profile: Patient | Profile: Healthcare Organization | https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-partner-organization | Profile: Insurance Company) Constraints
|
scope | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.scope Range of Legal Concerns DefinitionA selector of legal concerns for this Contract definition, derivative, or instance in any legal state. 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. Codes for the range of legal concerns.
| |
topic[x] | 0..1 | There are no (further) constraints on this element Element idContract.topic[x] Focus of contract interest DefinitionNarrows the range of legal concerns to focus on the achievement of specific contractual objectives. 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.
| ||
topicCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
topicReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
type | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.type Legal instrument category DefinitionA 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. 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. List of overall contract codes.
|
subType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.subType Subtype within the context of type DefinitionSub-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. 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. Detailed codes within the above.
|
contentDefinition | 0..1 | BackboneElement | There are no (further) constraints on this element Element idContract.contentDefinition Contract precursor content DefinitionPrecusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.contentDefinition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.contentDefinition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.contentDefinition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.contentDefinition.type Content structure and use DefinitionPrecusory 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. 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. Detailed codes for the definition of contracts.
| |
subType | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.contentDefinition.subType Detailed Content Type Definition DefinitionDetailed Precusory content type. 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. Detailed codes for the additional definition of contracts.
| |
publisher | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idContract.contentDefinition.publisher Publisher Entity DefinitionThe individual or organization that published the Contract precursor content. 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. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
publicationDate | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.contentDefinition.publicationDate When published DefinitionThe 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.
| |
publicationStatus | 1..1 | codeBinding | There are no (further) constraints on this element Element idContract.contentDefinition.publicationStatus amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Definitionamended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated. Note that FHIR strings SHALL NOT exceed 1MB in size Status of the publication of contract content.
| |
copyright | 0..1 | markdown | There are no (further) constraints on this element Element idContract.contentDefinition.copyright Publication Ownership DefinitionA copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content. 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/
| |
term | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term Contract Term List DefinitionOne or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idContract.term.identifier Contract Term Number DefinitionUnique identifier for this particular Contract Provision.
|
issued | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.term.issued Contract Term Issue Date Time DefinitionWhen this Contract Provision was issued.
|
applies | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idContract.term.applies Contract Term Effective Time DefinitionRelevant time or time-period when this Contract Provision is applicable. 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.
|
topic[x] | 0..1 | There are no (further) constraints on this element Element idContract.term.topic[x] Term Concern DefinitionThe entity that the term applies to.
| ||
topicCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
topicReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.type Contract Term Type or Form DefinitionA 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. 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. Detailed codes for the types of contract provisions.
| |
subType | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.subType Contract Term Type specific classification DefinitionA specialized legal clause or condition based on overarching contract type. 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. Detailed codes for the subtypes of contract provisions.
| |
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.term.text Term Statement DefinitionStatement of a provision in a policy or a contract. Note that FHIR strings SHALL NOT exceed 1MB in size
|
securityLabel | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.securityLabel Protection for the Term DefinitionSecurity labels that protect the handling of information about the term and its elements, which may be specifically identified.. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.securityLabel.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.securityLabel.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.securityLabel.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
number | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.securityLabel.number Link to Security Labels DefinitionNumber used to link this term or term element to the applicable Security Label. 32 bit number; for values larger than this, use decimal
| |
classification | 1..1 | Coding | There are no (further) constraints on this element Element idContract.term.securityLabel.classification Confidentiality Protection DefinitionSecurity label privacy tag that species the level of confidentiality protection required for this term and/or term elements. 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. Codes for confidentiality protection.
| |
category | 0..* | Coding | There are no (further) constraints on this element Element idContract.term.securityLabel.category Applicable Policy DefinitionSecurity label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. 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. Codes for policy category.
| |
control | 0..* | Coding | There are no (further) constraints on this element Element idContract.term.securityLabel.control Handling Instructions DefinitionSecurity label privacy tag that species the manner in which term and/or term elements are to be protected. 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. Codes for handling instructions.
| |
offer | 1..1 | BackboneElement | There are no (further) constraints on this element Element idContract.term.offer Context of the Contract term DefinitionThe matter of concern in the context of this provision of the agrement.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.offer.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idContract.term.offer.identifier Offer business ID DefinitionUnique identifier for this particular Contract Provision.
| |
party | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.offer.party Offer Recipient DefinitionOffer Recipient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.offer.party.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.party.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.party.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
reference | I | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | There are no (further) constraints on this element Element idContract.term.offer.party.reference Referenced entity DefinitionParticipant in the offer. 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. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Constraints
|
role | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.offer.party.role Participant engagement type DefinitionHow the party participates in the offer. 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. Codes for offer participant roles.
| |
topic | Σ I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idContract.term.offer.topic Negotiable offer asset DefinitionThe 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). 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. 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.
|
type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.offer.type Contract Offer Type or Form DefinitionType of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. 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. Detailed codes for the types of contract provisions.
| |
decision | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idContract.term.offer.decision Accepting party choice DefinitionType of choice made by accepting party with respect to an offer made by an offeror/ grantee. 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". 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. The type of decision made by a grantor with respect to an offer made by a grantee.
| |
decisionMode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.offer.decisionMode How decision is conveyed DefinitionHow the decision about a Contract was conveyed. 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. Codes for conveying a decision.
| |
answer | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.offer.answer Response to offer text DefinitionResponse to offer text.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.offer.answer.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.answer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.answer.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
value[x] | 1..1 | There are no (further) constraints on this element Element idContract.term.offer.answer.value[x] The actual answer response DefinitionResponse 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.
| ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
text | 0..1 | string | There are no (further) constraints on this element Element idContract.term.offer.text Human readable offer text DefinitionHuman readable form of this Contract Offer. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
linkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.offer.linkId Pointer to text DefinitionThe id of the clause or question text of the offer in the referenced questionnaire/response. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
securityLabelNumber | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.offer.securityLabelNumber Offer restriction numbers DefinitionSecurity labels that protects the offer. 32 bit number; for values larger than this, use decimal
| |
asset | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.asset Contract Term Asset List DefinitionContract Term Asset List.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
scope | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.scope Range of asset DefinitionDifferentiates the kind of the asset . 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. Codes for scoping an asset.
| |
type | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.type Asset category DefinitionTarget entity type about which the term may be concerned. 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. Condes for the type of an asset.
| |
typeReference | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idContract.term.asset.typeReference Associated entities DefinitionAssociated entities. 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.
|
subtype | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.subtype Asset sub-category DefinitionMay be a subtype or part of an offered asset. 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. Condes for the sub-type of an asset.
| |
relationship | 0..1 | CodingBinding | There are no (further) constraints on this element Element idContract.term.asset.relationship Kinship of the asset DefinitionSpecifies 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. 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. The class (type) of information a consent rule covers.
| |
context | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.asset.context Circumstance of the asset DefinitionCircumstance of the asset.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.context.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.context.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.context.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
reference | I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idContract.term.asset.context.reference Creator,custodian or owner DefinitionAsset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. 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.
|
code | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.context.code Codeable asset context DefinitionCoded representation of the context generally or of the Referenced entity, such as the asset holder type or location. 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. Codes for the context of the asset.
| |
text | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.context.text Context description DefinitionContext description. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
condition | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.condition Quality desctiption of asset DefinitionDescription of the quality and completeness of the asset that imay be a factor in its valuation. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
periodType | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.periodType Asset availability types DefinitionType of Asset availability for use or ownership. 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. Codes for asset availability.
| |
period | I | 0..* | Period | There are no (further) constraints on this element Element idContract.term.asset.period Time period of the asset DefinitionAsset relevant contractual time period. 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.
|
usePeriod | I | 0..* | Period | There are no (further) constraints on this element Element idContract.term.asset.usePeriod Time period DefinitionTime period of asset use. 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.
|
text | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.text Asset clause or question text DefinitionClause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
linkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.asset.linkId Pointer to asset text DefinitionId [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
answer | 0..* | see (answer) | There are no (further) constraints on this element Element idContract.term.asset.answer Response to assets DefinitionResponse to assets. | |
securityLabelNumber | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.asset.securityLabelNumber Asset restriction numbers DefinitionSecurity labels that protects the asset. 32 bit number; for values larger than this, use decimal
| |
valuedItem | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.asset.valuedItem Contract Valued Item List DefinitionContract Valued Item List.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
entity[x] | 0..1 | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.entity[x] Contract Valued Item Type DefinitionSpecific type of Contract Valued Item that may be priced.
| ||
entityCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
entityReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
identifier | 0..1 | Identifier | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.identifier Contract Valued Item Number DefinitionIdentifies a Contract Valued Item instance.
| |
effectiveTime | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.effectiveTime Contract Valued Item Effective Tiem DefinitionIndicates the time during which this Contract ValuedItem information is effective.
| |
quantity | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.quantity Count of Contract Valued Items DefinitionSpecifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances. 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.
|
unitPrice | 0..1 | Money | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.unitPrice Contract Valued Item fee, charge, or cost DefinitionA Contract Valued Item unit valuation measure.
| |
factor | 0..1 | decimal | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.factor Contract Valued Item Price Scaling Factor DefinitionA 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. 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)
| |
points | 0..1 | decimal | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.points Contract Valued Item Difficulty Scaling Factor DefinitionAn 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. 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)
| |
net | 0..1 | Money | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.net Total Contract Valued Item Value DefinitionExpresses 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.
| |
payment | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.payment Terms of valuation DefinitionTerms of valuation. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
paymentDate | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.paymentDate When payment is due DefinitionWhen payment is due.
| |
responsible | I | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.responsible Who will make payment DefinitionWho will make payment. 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. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Constraints
|
recipient | I | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.recipient Who will receive payment DefinitionWho will receive payment. 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. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Constraints
|
linkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.linkId Pointer to specific item DefinitionId of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
securityLabelNumber | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.securityLabelNumber Security Labels that define affected terms DefinitionA set of security labels that define which terms are controlled by this condition. 32 bit number; for values larger than this, use decimal
| |
action | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.action Entity being ascribed responsibility DefinitionAn actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.action.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.action.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.action.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
doNotPerform | ?! | 0..1 | boolean | There are no (further) constraints on this element Element idContract.term.action.doNotPerform True if the term prohibits the action DefinitionTrue if the term prohibits the action.
|
type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.type Type or form of the action DefinitionActivity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term. 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. Detailed codes for the contract action.
| |
subject | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.action.subject Entity of the action DefinitionEntity of the action.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.action.subject.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.action.subject.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.action.subject.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
reference | I | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | There are no (further) constraints on this element Element idContract.term.action.subject.reference Entity of the action DefinitionThe entity the action is performed or not performed on or for. 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. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Constraints
|
role | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.subject.role Role type of the agent DefinitionRole type of agent assigned roles in this Contract. 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. Detailed codes for the contract actor role.
| |
intent | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.intent Purpose for the Contract Term Action DefinitionReason or purpose for the action stipulated by this Contract Provision. 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. Detailed codes for the contract action reason.
| |
linkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.linkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
status | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.status State of the action DefinitionCurrent state of the term action. 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. Codes for the status of an term action.
| |
context | I | 0..1 | Reference(Encounter | EpisodeOfCare) | There are no (further) constraints on this element Element idContract.term.action.context Episode associated with action DefinitionEncounter or Episode with primary association to specified term activity. 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. Reference(Encounter | EpisodeOfCare) Constraints
|
contextLinkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.contextLinkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
occurrence[x] | 0..1 | There are no (further) constraints on this element Element idContract.term.action.occurrence[x] When action happens DefinitionWhen action happens.
| ||
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||
occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||
occurrenceTiming | Timing | There are no (further) constraints on this element Data type | ||
requester | I | 0..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | There are no (further) constraints on this element Element idContract.term.action.requester Who asked for action DefinitionWho or what initiated the action and has responsibility for its activation. 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. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Constraints
|
requesterLinkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.requesterLinkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
performerType | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.performerType Kind of service performer DefinitionThe type of individual that is desired or required to perform or not perform the action. 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. Codes for the types of action perfomer.
| |
performerRole | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.performerRole Competency of the performer DefinitionThe type of role or competency of an individual desired or required to perform or not perform the action. 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. Codes for the role of the action performer.
| |
performer | I | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) | There are no (further) constraints on this element Element idContract.term.action.performer Actor that wil execute (or not) the action DefinitionIndicates who or what is being asked to perform (or not perform) the ction. 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. Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) Constraints
|
performerLinkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.performerLinkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
reasonCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.reasonCode Why is action (not) needed? DefinitionRationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. 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. Detailed codes for the contract action reason.
| |
reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) | There are no (further) constraints on this element Element idContract.term.action.reasonReference Why is action (not) needed? DefinitionIndicates another resource whose existence justifies permitting or not permitting this action. 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. Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) Constraints
|
reason | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.reason Why action is to be performed DefinitionDescribes why the action is to be performed or not performed in textual form. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
reasonLinkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.reasonLinkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element idContract.term.action.note Comments about the action DefinitionComments made about the term action made by the requester, performer, subject or other participants. 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).
| |
securityLabelNumber | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.action.securityLabelNumber Action restriction numbers DefinitionSecurity labels that protects the action. 32 bit number; for values larger than this, use decimal
| |
group | 0..* | see (term) | There are no (further) constraints on this element Element idContract.term.group Nested Contract Term Group DefinitionNested group of Contract Provisions.
| |
supportingInfo | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idContract.supportingInfo Extra Information DefinitionInformation that may be needed by/relevant to the performer in their execution of this term action. 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.
|
relevantHistory | I | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idContract.relevantHistory Key event in Contract History DefinitionLinks 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. 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.
|
signer | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.signer Contract Signatory DefinitionParties 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. 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. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.signer.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.signer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.signer.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | 1..1 | CodingBinding | There are no (further) constraints on this element Element idContract.signer.type Contract Signatory Role DefinitionRole of this Contract signer, e.g. notary, grantee. 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. List of parties who may be signing.
| |
party | I | 1..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idContract.signer.party Contract Signatory Party DefinitionParty which is a signator to this Contract. 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. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Constraints
|
signature | 1..* | Signature | There are no (further) constraints on this element Element idContract.signer.signature Contract Documentation Signature DefinitionLegally binding Contract DSIG signature contents in Base64. 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.
| |
friendly | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.friendly Contract Friendly Language DefinitionThe "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.friendly.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.friendly.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.friendly.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
content[x] | 1..1 | There are no (further) constraints on this element Element idContract.friendly.content[x] Easily comprehended representation of this Contract DefinitionHuman readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
| ||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | There are no (further) constraints on this element Data type Reference(Composition | DocumentReference | QuestionnaireResponse) | ||
legal | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.legal Contract Legal Language DefinitionList of Legal expressions or representations of this Contract.
|
id | S | 1..1 | string | Element idContract.legal.id tbd DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.legal.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.legal.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
content[x] | S | 1..1 | Element idContract.legal.content[x] stores the generated pdf contract DefinitionContract legal text in human renderable form.
| |
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | There are no (further) constraints on this element Data type Reference(Composition | DocumentReference | QuestionnaireResponse) | ||
rule | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.rule Computable Contract Language DefinitionList of Computable Policy Rule Language Representations of this Contract.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.rule.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.rule.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.rule.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
content[x] | 1..1 | There are no (further) constraints on this element Element idContract.rule.content[x] Computable Contract Rules DefinitionComputable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
| ||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(DocumentReference) | There are no (further) constraints on this element Data type | ||
legallyBinding[x] | 0..1 | There are no (further) constraints on this element Element idContract.legallyBinding[x] Binding Contract DefinitionLegally 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.
| ||
legallyBindingAttachment | Attachment | There are no (further) constraints on this element Data type | ||
legallyBindingReference | Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) | There are no (further) constraints on this element Data type Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) |
Hybrid
Contract | I | Contract | There are no (further) constraints on this element Element idContract Legal Agreement DefinitionLegally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idContract.meta Metadata about the resource DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idContract.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idContract.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idContract.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
meta-source | Σ | 1..1 | uri | Element idContract.meta.source:meta-source uri of the data source DefinitionTypically the data owner's URL followed by a source/file description mandatory for all resources in bWell's FHIR Server In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
example of meta.source https://www.icanbwell.com/provider-directory Mappings
|
profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idContract.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
|
meta-security | Σ | 1..* | CodingBinding | Element idContract.meta.security:meta-security security tags representing the data's owner, vendor, and accessibility Definitiondata owner: data vendor: data access: /owner & /access are mandatory for all resources in bWell's FHIR Server The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
example of data owner security tag { "system": "https://www.icanbwell.com/owner", "code": "bwell" } example of data access security tag { "system": "https://www.icanbwell.com/access", "code": "bwell" } example of data vendor security tag { "system": "https://www.icanbwell.com/vendor", "code": "bwell" } Mappings
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idContract.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idContract.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idContract.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idContract.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idContract.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idContract.identifier Contract number DefinitionUnique identifier for this Contract or a derivative that references a Source Contract. 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.
|
url | 0..1 | uri | There are no (further) constraints on this element Element idContract.url Basal definition DefinitionCanonical identifier for this contract, represented as a URI (globally unique). 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. Used in a domain that uses a supplied contract repository.
| |
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.version Business edition DefinitionAn edition identifier used for business purposes to label business significant variants. 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. 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].
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idContract.status amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated DefinitionThe status of the resource instance. This is the Contract Business Workflow Status. This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active. A code specifying the state of the resource instance.
|
legalState | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idContract.legalState Negotiation status DefinitionLegal 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. 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. 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. Detailed codes for the legal state of a contract.
| |
instantiatesCanonical | I | 0..1 | Reference(Contract) | There are no (further) constraints on this element Element idContract.instantiatesCanonical Source Contract Definition DefinitionThe URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. 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.
|
instantiatesUri | 0..1 | uri | There are no (further) constraints on this element Element idContract.instantiatesUri External Contract Definition DefinitionThe URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
contentDerivative | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.contentDerivative Content derived from the basal information DefinitionThe minimal content derived from the basal information source at a specific stage in its lifecycle. 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. 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. This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source.
| |
issued | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.issued When this Contract was issued DefinitionWhen this Contract was issued. The Contract issuance dateTime often precedes the Contract effective dateTime.
|
applies | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idContract.applies Effective time DefinitionRelevant time or time-period when this Contract is applicable. The dateTime upon which the Contract is binding. 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.
|
expirationType | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.expirationType Contract cessation cause DefinitionEvent resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. 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. Codes for the Cessation of Contracts.
| |
subject | Σ I | 0..* | Reference(Profile: Patient) | Element idContract.subject The patient who signed the contract Alternate namesPatient DefinitionThe target entity impacted by or of interest to parties to the agreement. 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. 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.
|
authority | I | 0..* | Reference(Profile: Insurance Company | https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-partner-organization | Profile: Healthcare Organization) | Element idContract.authority Contract is signed through which organization DefinitionA 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. The governance framework responsible for ensuring compliance with or enforcement of the contract or policy. 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. Reference(Profile: Insurance Company | https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-partner-organization | Profile: Healthcare Organization) Constraints
|
domain | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element idContract.domain A sphere of control governed by an authoritative jurisdiction, organization, or person Alternate namesscope of governance jurisdiction DefinitionRecognized 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. The entities bound by governance to comply with the enforcement of contracts or policies by a recognized authority. 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.
|
site | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element idContract.site Specific Location DefinitionSites in which the contract is complied with, exercised, or in force. 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.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.name Computer friendly designation DefinitionA 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. Support human navigation and code generation. 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.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.title Human Friendly name DefinitionA short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size
|
subtitle | 0..1 | string | There are no (further) constraints on this element Element idContract.subtitle Subordinate Friendly name DefinitionAn explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
alias | 0..* | string | There are no (further) constraints on this element Element idContract.alias Acronym or short name DefinitionAlternative 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
author | S I | 0..1 | Reference(Profile: Patient | Profile: Healthcare Organization | https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-partner-organization | Profile: Insurance Company) | Element idContract.author who owns the contract program. DefinitionThe individual or organization that authored the Contract definition, derivative, or instance in any legal state. 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. Reference(Profile: Patient | Profile: Healthcare Organization | https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-partner-organization | Profile: Insurance Company) Constraints
|
scope | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.scope Range of Legal Concerns DefinitionA selector of legal concerns for this Contract definition, derivative, or instance in any legal state. 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. Codes for the range of legal concerns.
| |
topic[x] | 0..1 | There are no (further) constraints on this element Element idContract.topic[x] Focus of contract interest DefinitionNarrows the range of legal concerns to focus on the achievement of specific contractual objectives. 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.
| ||
topicCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
topicReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
type | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.type Legal instrument category DefinitionA 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. 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. List of overall contract codes.
|
subType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.subType Subtype within the context of type DefinitionSub-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. 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. Detailed codes within the above.
|
contentDefinition | 0..1 | BackboneElement | There are no (further) constraints on this element Element idContract.contentDefinition Contract precursor content DefinitionPrecusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.contentDefinition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.contentDefinition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.contentDefinition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.contentDefinition.type Content structure and use DefinitionPrecusory 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. 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. Detailed codes for the definition of contracts.
| |
subType | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.contentDefinition.subType Detailed Content Type Definition DefinitionDetailed Precusory content type. 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. Detailed codes for the additional definition of contracts.
| |
publisher | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idContract.contentDefinition.publisher Publisher Entity DefinitionThe individual or organization that published the Contract precursor content. 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. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
publicationDate | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.contentDefinition.publicationDate When published DefinitionThe 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.
| |
publicationStatus | 1..1 | codeBinding | There are no (further) constraints on this element Element idContract.contentDefinition.publicationStatus amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Definitionamended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated. Note that FHIR strings SHALL NOT exceed 1MB in size Status of the publication of contract content.
| |
copyright | 0..1 | markdown | There are no (further) constraints on this element Element idContract.contentDefinition.copyright Publication Ownership DefinitionA copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content. 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/
| |
term | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term Contract Term List DefinitionOne or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idContract.term.identifier Contract Term Number DefinitionUnique identifier for this particular Contract Provision.
|
issued | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.term.issued Contract Term Issue Date Time DefinitionWhen this Contract Provision was issued.
|
applies | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idContract.term.applies Contract Term Effective Time DefinitionRelevant time or time-period when this Contract Provision is applicable. 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.
|
topic[x] | 0..1 | There are no (further) constraints on this element Element idContract.term.topic[x] Term Concern DefinitionThe entity that the term applies to.
| ||
topicCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
topicReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.type Contract Term Type or Form DefinitionA 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. 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. Detailed codes for the types of contract provisions.
| |
subType | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.subType Contract Term Type specific classification DefinitionA specialized legal clause or condition based on overarching contract type. 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. Detailed codes for the subtypes of contract provisions.
| |
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idContract.term.text Term Statement DefinitionStatement of a provision in a policy or a contract. Note that FHIR strings SHALL NOT exceed 1MB in size
|
securityLabel | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.securityLabel Protection for the Term DefinitionSecurity labels that protect the handling of information about the term and its elements, which may be specifically identified.. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.securityLabel.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.securityLabel.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.securityLabel.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
number | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.securityLabel.number Link to Security Labels DefinitionNumber used to link this term or term element to the applicable Security Label. 32 bit number; for values larger than this, use decimal
| |
classification | 1..1 | Coding | There are no (further) constraints on this element Element idContract.term.securityLabel.classification Confidentiality Protection DefinitionSecurity label privacy tag that species the level of confidentiality protection required for this term and/or term elements. 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. Codes for confidentiality protection.
| |
category | 0..* | Coding | There are no (further) constraints on this element Element idContract.term.securityLabel.category Applicable Policy DefinitionSecurity label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. 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. Codes for policy category.
| |
control | 0..* | Coding | There are no (further) constraints on this element Element idContract.term.securityLabel.control Handling Instructions DefinitionSecurity label privacy tag that species the manner in which term and/or term elements are to be protected. 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. Codes for handling instructions.
| |
offer | 1..1 | BackboneElement | There are no (further) constraints on this element Element idContract.term.offer Context of the Contract term DefinitionThe matter of concern in the context of this provision of the agrement.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.offer.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idContract.term.offer.identifier Offer business ID DefinitionUnique identifier for this particular Contract Provision.
| |
party | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.offer.party Offer Recipient DefinitionOffer Recipient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.offer.party.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.party.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.party.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
reference | I | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | There are no (further) constraints on this element Element idContract.term.offer.party.reference Referenced entity DefinitionParticipant in the offer. 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. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Constraints
|
role | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.offer.party.role Participant engagement type DefinitionHow the party participates in the offer. 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. Codes for offer participant roles.
| |
topic | Σ I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idContract.term.offer.topic Negotiable offer asset DefinitionThe 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). 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. 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.
|
type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.offer.type Contract Offer Type or Form DefinitionType of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. 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. Detailed codes for the types of contract provisions.
| |
decision | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idContract.term.offer.decision Accepting party choice DefinitionType of choice made by accepting party with respect to an offer made by an offeror/ grantee. 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". 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. The type of decision made by a grantor with respect to an offer made by a grantee.
| |
decisionMode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.offer.decisionMode How decision is conveyed DefinitionHow the decision about a Contract was conveyed. 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. Codes for conveying a decision.
| |
answer | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.offer.answer Response to offer text DefinitionResponse to offer text.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.offer.answer.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.answer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.offer.answer.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
value[x] | 1..1 | There are no (further) constraints on this element Element idContract.term.offer.answer.value[x] The actual answer response DefinitionResponse 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.
| ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
text | 0..1 | string | There are no (further) constraints on this element Element idContract.term.offer.text Human readable offer text DefinitionHuman readable form of this Contract Offer. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
linkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.offer.linkId Pointer to text DefinitionThe id of the clause or question text of the offer in the referenced questionnaire/response. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
securityLabelNumber | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.offer.securityLabelNumber Offer restriction numbers DefinitionSecurity labels that protects the offer. 32 bit number; for values larger than this, use decimal
| |
asset | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.asset Contract Term Asset List DefinitionContract Term Asset List.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
scope | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.scope Range of asset DefinitionDifferentiates the kind of the asset . 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. Codes for scoping an asset.
| |
type | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.type Asset category DefinitionTarget entity type about which the term may be concerned. 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. Condes for the type of an asset.
| |
typeReference | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idContract.term.asset.typeReference Associated entities DefinitionAssociated entities. 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.
|
subtype | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.subtype Asset sub-category DefinitionMay be a subtype or part of an offered asset. 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. Condes for the sub-type of an asset.
| |
relationship | 0..1 | CodingBinding | There are no (further) constraints on this element Element idContract.term.asset.relationship Kinship of the asset DefinitionSpecifies 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. 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. The class (type) of information a consent rule covers.
| |
context | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.asset.context Circumstance of the asset DefinitionCircumstance of the asset.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.context.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.context.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.context.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
reference | I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idContract.term.asset.context.reference Creator,custodian or owner DefinitionAsset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. 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.
|
code | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.context.code Codeable asset context DefinitionCoded representation of the context generally or of the Referenced entity, such as the asset holder type or location. 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. Codes for the context of the asset.
| |
text | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.context.text Context description DefinitionContext description. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
condition | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.condition Quality desctiption of asset DefinitionDescription of the quality and completeness of the asset that imay be a factor in its valuation. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
periodType | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.asset.periodType Asset availability types DefinitionType of Asset availability for use or ownership. 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. Codes for asset availability.
| |
period | I | 0..* | Period | There are no (further) constraints on this element Element idContract.term.asset.period Time period of the asset DefinitionAsset relevant contractual time period. 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.
|
usePeriod | I | 0..* | Period | There are no (further) constraints on this element Element idContract.term.asset.usePeriod Time period DefinitionTime period of asset use. 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.
|
text | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.text Asset clause or question text DefinitionClause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
linkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.asset.linkId Pointer to asset text DefinitionId [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
answer | 0..* | see (answer) | There are no (further) constraints on this element Element idContract.term.asset.answer Response to assets DefinitionResponse to assets. | |
securityLabelNumber | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.asset.securityLabelNumber Asset restriction numbers DefinitionSecurity labels that protects the asset. 32 bit number; for values larger than this, use decimal
| |
valuedItem | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.asset.valuedItem Contract Valued Item List DefinitionContract Valued Item List.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
entity[x] | 0..1 | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.entity[x] Contract Valued Item Type DefinitionSpecific type of Contract Valued Item that may be priced.
| ||
entityCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
entityReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
identifier | 0..1 | Identifier | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.identifier Contract Valued Item Number DefinitionIdentifies a Contract Valued Item instance.
| |
effectiveTime | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.effectiveTime Contract Valued Item Effective Tiem DefinitionIndicates the time during which this Contract ValuedItem information is effective.
| |
quantity | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.quantity Count of Contract Valued Items DefinitionSpecifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances. 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.
|
unitPrice | 0..1 | Money | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.unitPrice Contract Valued Item fee, charge, or cost DefinitionA Contract Valued Item unit valuation measure.
| |
factor | 0..1 | decimal | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.factor Contract Valued Item Price Scaling Factor DefinitionA 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. 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)
| |
points | 0..1 | decimal | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.points Contract Valued Item Difficulty Scaling Factor DefinitionAn 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. 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)
| |
net | 0..1 | Money | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.net Total Contract Valued Item Value DefinitionExpresses 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.
| |
payment | 0..1 | string | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.payment Terms of valuation DefinitionTerms of valuation. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
paymentDate | 0..1 | dateTime | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.paymentDate When payment is due DefinitionWhen payment is due.
| |
responsible | I | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.responsible Who will make payment DefinitionWho will make payment. 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. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Constraints
|
recipient | I | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.recipient Who will receive payment DefinitionWho will receive payment. 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. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Constraints
|
linkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.linkId Pointer to specific item DefinitionId of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
securityLabelNumber | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.asset.valuedItem.securityLabelNumber Security Labels that define affected terms DefinitionA set of security labels that define which terms are controlled by this condition. 32 bit number; for values larger than this, use decimal
| |
action | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.action Entity being ascribed responsibility DefinitionAn actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.action.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.action.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.action.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
doNotPerform | ?! | 0..1 | boolean | There are no (further) constraints on this element Element idContract.term.action.doNotPerform True if the term prohibits the action DefinitionTrue if the term prohibits the action.
|
type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.type Type or form of the action DefinitionActivity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term. 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. Detailed codes for the contract action.
| |
subject | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.term.action.subject Entity of the action DefinitionEntity of the action.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.term.action.subject.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.action.subject.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.term.action.subject.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
reference | I | 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | There are no (further) constraints on this element Element idContract.term.action.subject.reference Entity of the action DefinitionThe entity the action is performed or not performed on or for. 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. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Constraints
|
role | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.subject.role Role type of the agent DefinitionRole type of agent assigned roles in this Contract. 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. Detailed codes for the contract actor role.
| |
intent | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.intent Purpose for the Contract Term Action DefinitionReason or purpose for the action stipulated by this Contract Provision. 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. Detailed codes for the contract action reason.
| |
linkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.linkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
status | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.status State of the action DefinitionCurrent state of the term action. 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. Codes for the status of an term action.
| |
context | I | 0..1 | Reference(Encounter | EpisodeOfCare) | There are no (further) constraints on this element Element idContract.term.action.context Episode associated with action DefinitionEncounter or Episode with primary association to specified term activity. 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. Reference(Encounter | EpisodeOfCare) Constraints
|
contextLinkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.contextLinkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
occurrence[x] | 0..1 | There are no (further) constraints on this element Element idContract.term.action.occurrence[x] When action happens DefinitionWhen action happens.
| ||
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||
occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||
occurrenceTiming | Timing | There are no (further) constraints on this element Data type | ||
requester | I | 0..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | There are no (further) constraints on this element Element idContract.term.action.requester Who asked for action DefinitionWho or what initiated the action and has responsibility for its activation. 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. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) Constraints
|
requesterLinkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.requesterLinkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
performerType | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.performerType Kind of service performer DefinitionThe type of individual that is desired or required to perform or not perform the action. 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. Codes for the types of action perfomer.
| |
performerRole | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.performerRole Competency of the performer DefinitionThe type of role or competency of an individual desired or required to perform or not perform the action. 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. Codes for the role of the action performer.
| |
performer | I | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) | There are no (further) constraints on this element Element idContract.term.action.performer Actor that wil execute (or not) the action DefinitionIndicates who or what is being asked to perform (or not perform) the ction. 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. Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) Constraints
|
performerLinkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.performerLinkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
reasonCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idContract.term.action.reasonCode Why is action (not) needed? DefinitionRationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. 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. Detailed codes for the contract action reason.
| |
reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) | There are no (further) constraints on this element Element idContract.term.action.reasonReference Why is action (not) needed? DefinitionIndicates another resource whose existence justifies permitting or not permitting this action. 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. Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) Constraints
|
reason | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.reason Why action is to be performed DefinitionDescribes why the action is to be performed or not performed in textual form. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
reasonLinkId | 0..* | string | There are no (further) constraints on this element Element idContract.term.action.reasonLinkId Pointer to specific item DefinitionId [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element idContract.term.action.note Comments about the action DefinitionComments made about the term action made by the requester, performer, subject or other participants. 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).
| |
securityLabelNumber | 0..* | unsignedInt | There are no (further) constraints on this element Element idContract.term.action.securityLabelNumber Action restriction numbers DefinitionSecurity labels that protects the action. 32 bit number; for values larger than this, use decimal
| |
group | 0..* | see (term) | There are no (further) constraints on this element Element idContract.term.group Nested Contract Term Group DefinitionNested group of Contract Provisions.
| |
supportingInfo | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idContract.supportingInfo Extra Information DefinitionInformation that may be needed by/relevant to the performer in their execution of this term action. 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.
|
relevantHistory | I | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idContract.relevantHistory Key event in Contract History DefinitionLinks 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. 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.
|
signer | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.signer Contract Signatory DefinitionParties 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. 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. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.signer.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.signer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.signer.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | 1..1 | CodingBinding | There are no (further) constraints on this element Element idContract.signer.type Contract Signatory Role DefinitionRole of this Contract signer, e.g. notary, grantee. 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. List of parties who may be signing.
| |
party | I | 1..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idContract.signer.party Contract Signatory Party DefinitionParty which is a signator to this Contract. 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. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Constraints
|
signature | 1..* | Signature | There are no (further) constraints on this element Element idContract.signer.signature Contract Documentation Signature DefinitionLegally binding Contract DSIG signature contents in Base64. 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.
| |
friendly | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.friendly Contract Friendly Language DefinitionThe "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.friendly.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.friendly.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.friendly.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
content[x] | 1..1 | There are no (further) constraints on this element Element idContract.friendly.content[x] Easily comprehended representation of this Contract DefinitionHuman readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
| ||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | There are no (further) constraints on this element Data type Reference(Composition | DocumentReference | QuestionnaireResponse) | ||
legal | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.legal Contract Legal Language DefinitionList of Legal expressions or representations of this Contract.
|
id | S | 1..1 | string | Element idContract.legal.id tbd DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.legal.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.legal.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
content[x] | S | 1..1 | Element idContract.legal.content[x] stores the generated pdf contract DefinitionContract legal text in human renderable form.
| |
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(Composition | DocumentReference | QuestionnaireResponse) | There are no (further) constraints on this element Data type Reference(Composition | DocumentReference | QuestionnaireResponse) | ||
rule | 0..* | BackboneElement | There are no (further) constraints on this element Element idContract.rule Computable Contract Language DefinitionList of Computable Policy Rule Language Representations of this Contract.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContract.rule.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContract.rule.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idContract.rule.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
content[x] | 1..1 | There are no (further) constraints on this element Element idContract.rule.content[x] Computable Contract Rules DefinitionComputable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
| ||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(DocumentReference) | There are no (further) constraints on this element Data type | ||
legallyBinding[x] | 0..1 | There are no (further) constraints on this element Element idContract.legallyBinding[x] Binding Contract DefinitionLegally 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.
| ||
legallyBindingAttachment | Attachment | There are no (further) constraints on this element Data type | ||
legallyBindingReference | Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) | There are no (further) constraints on this element Data type Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) |
Examples:
{ "resourceType": "Contract", "id": "DC-AAA111", "issued": "2014-08-17", "status": "submitted", "subject": [ { "reference": "Patient/medicare-AAA111" } ], "authority": [ { "reference": "Organization/Unity Point" } ], "author": { "reference": "Organization/Medicare" }, "title": "Unity Point Direct Contracting Program", "legal": [ { "contentAttachment": { "title": "UnityPoint - Direct Contracting Form ", "contentType": "application/pdf", "url": "http://www.aws.com/s3/doc.pdf" } } ] }