Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-Contract resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Contract | |
| Definition | Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement. |
| Short | Legal Agreement |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
| 2. Contract.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Contract.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 6. Contract.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. Contract.extension:action | |
| Slice Name | action |
| Definition | DSTU2: |
| Short | DSTU2: Contract Action (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Action (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. Contract.extension:actionReason | |
| Slice Name | actionReason |
| Definition | DSTU2: |
| Short | DSTU2: Contract Action Reason (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Action Reason (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 12. Contract.extension:role | |
| Slice Name | role |
| Definition | DSTU2: |
| Short | DSTU2: Contract Actor Role (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Actor Role (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 14. Contract.extension:valuedItem | |
| Slice Name | valuedItem |
| Definition | DSTU2: |
| Short | DSTU2: Contract Valued Item (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Valued Item (new)) (Complex Extension) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. Contract.extension:binding | |
| Slice Name | binding |
| Definition | DSTU2: |
| Short | DSTU2: Binding Contract (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Binding Contract (new)) (Extension Type: Choice of: Attachment, Reference(Cross-version Profile for DSTU2.Composition for use in FHIR R5, Composition, Cross-version Profile for DSTU2.DocumentReference for use in FHIR R5, DocumentReference, Cross-version Profile for DSTU2.QuestionnaireResponse for use in FHIR R5, QuestionnaireResponse)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 18. Contract.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 20. Contract.status | |
| Definition | The status of the resource instance. |
| Short | amended | appended | cancelled | disputed | entered-in-error | executable + |
| Comments | This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContractResourceStatusCodeshttp://hl7.org/fhir/ValueSet/contract-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/contract-status|5.0.0)A code specifying the state of the resource instance. |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | This is the Contract Business Workflow Status. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Contract | |
| 2. Contract.meta | |
| 4. Contract.meta.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Contract.meta.extension:meta | |
| Slice Name | meta |
| Definition | DSTU2: |
| Short | DSTU2: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: meta additional types) (Extension Type: Meta) |
| 8. Contract.text | |
| 10. Contract.text.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Contract.text.extension:text | |
| Slice Name | text |
| Definition | DSTU2: |
| Short | DSTU2: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: text additional types) (Complex Extension) |
| 14. Contract.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Contract.extension:action | |
| Slice Name | action |
| Definition | DSTU2: |
| Short | DSTU2: Contract Action (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Action (new)) (Extension Type: CodeableConcept) |
| 18. Contract.extension:actionReason | |
| Slice Name | actionReason |
| Definition | DSTU2: |
| Short | DSTU2: Contract Action Reason (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Action Reason (new)) (Extension Type: CodeableConcept) |
| 20. Contract.extension:role | |
| Slice Name | role |
| Definition | DSTU2: |
| Short | DSTU2: Contract Actor Role (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Actor Role (new)) (Extension Type: CodeableConcept) |
| 22. Contract.extension:valuedItem | |
| Slice Name | valuedItem |
| Definition | DSTU2: |
| Short | DSTU2: Contract Valued Item (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Valued Item (new)) (Complex Extension) |
| 24. Contract.extension:binding | |
| Slice Name | binding |
| Definition | DSTU2: |
| Short | DSTU2: Binding Contract (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Binding Contract (new)) (Extension Type: Choice of: Attachment, Reference(Cross-version Profile for DSTU2.Composition for use in FHIR R5, Composition, Cross-version Profile for DSTU2.DocumentReference for use in FHIR R5, DocumentReference, Cross-version Profile for DSTU2.QuestionnaireResponse for use in FHIR R5, QuestionnaireResponse)) |
| 26. Contract.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 28. Contract.identifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. Contract.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | DSTU2: |
| Short | DSTU2: Contract identifier additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Contract identifier additional types) (Extension Type: Identifier) |
| 32. Contract.applies | |
| 34. Contract.applies.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.applies.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. Contract.applies.extension:applies | |
| Slice Name | applies |
| Definition | DSTU2: |
| Short | DSTU2: applies additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: applies additional types) (Extension Type: Period) |
| 38. Contract.subject | |
| 40. Contract.subject.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. Contract.subject.extension:subject | |
| Slice Name | subject |
| Definition | DSTU2: |
| Short | DSTU2: Subject of this Contract additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 44. Contract.authority | |
| 46. Contract.authority.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.authority.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. Contract.authority.extension:authority | |
| Slice Name | authority |
| Definition | DSTU2: |
| Short | DSTU2: authority additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 50. Contract.domain | |
| 52. Contract.domain.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.domain.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. Contract.domain.extension:domain | |
| Slice Name | domain |
| Definition | DSTU2: |
| Short | DSTU2: Domain in which this Contract applies additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 56. Contract.author | |
| 58. Contract.author.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Contract.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 60. Contract.author.extension:entity | |
| Slice Name | entity |
| Definition | DSTU2: |
| Short | DSTU2: Contract Actor Type |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 62. Contract.term | |
| 64. Contract.term.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.term.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 66. Contract.term.extension:actionReason | |
| Slice Name | actionReason |
| Definition | DSTU2: |
| Short | DSTU2: Contract Term Action Reason (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Term Action Reason (new)) (Extension Type: CodeableConcept) |
| 68. Contract.term.extension:actor | |
| Slice Name | actor |
| Definition | DSTU2: |
| Short | DSTU2: Contract Term Actor List (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Term Actor List (new)) (Complex Extension) |
| 70. Contract.term.extension:valuedItem | |
| Slice Name | valuedItem |
| Definition | DSTU2: |
| Short | DSTU2: Contract Term Valued Item (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Term Valued Item (new)) (Complex Extension) |
| 72. Contract.term.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 74. Contract.term.identifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.term.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 76. Contract.term.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | DSTU2: |
| Short | DSTU2: Contract Term identifier additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Contract Term identifier additional types) (Extension Type: Identifier) |
| 78. Contract.term.applies | |
| 80. Contract.term.applies.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.term.applies.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 82. Contract.term.applies.extension:applies | |
| Slice Name | applies |
| Definition | DSTU2: |
| Short | DSTU2: applies additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: applies additional types) (Extension Type: Period) |
| 84. Contract.term.topicReference | |
| 86. Contract.term.topicReference.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.term.topicReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 88. Contract.term.topicReference.extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | DSTU2: |
| Short | DSTU2: Subject of this Contract Term additional types |
| Comments | Element |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 90. Contract.signer | |
| 92. Contract.signer.party | |
| 94. Contract.signer.party.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.signer.party.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 96. Contract.signer.party.extension:party | |
| Slice Name | party |
| Definition | DSTU2: |
| Short | DSTU2: party |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 98. Contract.signer.signature | |
| 100. Contract.signer.signature.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.signer.signature.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 102. Contract.signer.signature.extension:signature | |
| Slice Name | signature |
| Definition | DSTU2: |
| Short | DSTU2: signature additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: signature additional types) (Extension Type: string) |
| 104. Contract.friendly | |
| 106. Contract.friendly.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.friendly.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 108. Contract.friendly.extension:content | |
| Slice Name | content |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: content additional types) (Extension Type: Attachment) |
| 110. Contract.friendly.contentReference | |
| 112. Contract.friendly.contentReference.extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 114. Contract.legal | |
| 116. Contract.legal.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.legal.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 118. Contract.legal.extension:content | |
| Slice Name | content |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: content additional types) (Extension Type: Attachment) |
| 120. Contract.legal.contentReference | |
| 122. Contract.legal.contentReference.extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 124. Contract.rule | |
| 126. Contract.rule.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Contract.rule.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 128. Contract.rule.extension:content | |
| Slice Name | content |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: content additional types) (Extension Type: Attachment) |
| 130. Contract.rule.contentReference | |
| 132. Contract.rule.contentReference.extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Contract | |
| Definition | Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement. |
| Short | Legal Agreement |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) |
| 2. Contract.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. Contract.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Contract.meta.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 8. Contract.meta.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. Contract.meta.extension:meta | |
| Slice Name | meta |
| Definition | DSTU2: |
| Short | DSTU2: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: meta additional types) (Extension Type: Meta) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. Contract.meta.versionId | |
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
| Short | Version specific identifier |
| Comments | 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. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Contract.meta.lastUpdated | |
| Definition | When the resource last changed - e.g. when the version changed. |
| Short | When the resource version last changed |
| Comments | This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. 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. |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Contract.meta.source | |
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
| Short | Identifies where the resource comes from |
| Comments | The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Contract.meta.profile | |
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Short | Profiles this resource claims to conform to |
| Comments | 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. |
| Control | 0..* |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Contract.meta.security | |
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
| Short | Security Labels applied to this resource |
| Comments | 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. |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from AllSecurityLabels ![]() (extensible to http://hl7.org/fhir/ValueSet/security-labels|5.0.0)Security Labels from the Healthcare Privacy and Security Classification System. |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Contract.meta.tag | |
| Definition | Tags 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. |
| Short | Tags applied to this resource |
| Comments | 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. |
| Control | 0..* |
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|5.0.0)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Contract.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Contract.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. Contract.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a 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. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. Contract.text.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 32. Contract.text.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. Contract.text.extension:text | |
| Slice Name | text |
| Definition | DSTU2: |
| Short | DSTU2: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: text additional types) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 36. Contract.text.status | |
| Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
| Short | generated | extensions | additional | empty |
| Control | 1..1 |
| Binding | The codes SHALL be taken from NarrativeStatus (required to http://hl7.org/fhir/ValueSet/narrative-status|5.0.0)The status of a resource narrative. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. Contract.text.div | |
| Definition | The actual narrative content, a stripped down version of XHTML. |
| Short | Limited xhtml content |
| Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. |
| Control | 1..1 |
| Type | xhtml |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes ( htmlChecks())txt-2: The narrative SHALL have some non-whitespace content ( htmlChecks()) |
| 40. Contract.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 42. Contract.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. Contract.extension:action | |
| Slice Name | action |
| Definition | DSTU2: |
| Short | DSTU2: Contract Action (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Action (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 46. Contract.extension:actionReason | |
| Slice Name | actionReason |
| Definition | DSTU2: |
| Short | DSTU2: Contract Action Reason (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Action Reason (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 48. Contract.extension:role | |
| Slice Name | role |
| Definition | DSTU2: |
| Short | DSTU2: Contract Actor Role (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Actor Role (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 50. Contract.extension:valuedItem | |
| Slice Name | valuedItem |
| Definition | DSTU2: |
| Short | DSTU2: Contract Valued Item (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Valued Item (new)) (Complex Extension) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 52. Contract.extension:binding | |
| Slice Name | binding |
| Definition | DSTU2: |
| Short | DSTU2: Binding Contract (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Binding Contract (new)) (Extension Type: Choice of: Attachment, Reference(Cross-version Profile for DSTU2.Composition for use in FHIR R5, Composition, Cross-version Profile for DSTU2.DocumentReference for use in FHIR R5, DocumentReference, Cross-version Profile for DSTU2.QuestionnaireResponse for use in FHIR R5, QuestionnaireResponse)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 54. Contract.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 56. Contract.identifier | |
| Definition | Unique identifier for this Contract or a derivative that references a Source Contract. |
| Short | Contract number |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | This is the business identifier of the contract content conveyed. It may be a derivative of the legally binding contract, in which case, the identifier of the basal contract is contained in the Contract.binding referenced Contract. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Contract.identifier.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 60. Contract.identifier.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. Contract.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | DSTU2: |
| Short | DSTU2: Contract identifier additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Contract identifier additional types) (Extension Type: Identifier) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 64. Contract.identifier.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. Contract.identifier.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. Contract.identifier.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. Contract.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Contract.identifier.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. Contract.identifier.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. Contract.url | |
| Definition | Canonical identifier for this contract, represented as a URI (globally unique). |
| Short | Basal definition |
| Comments | Used in a domain that uses a supplied contract repository. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | An absolute URI that is used to identify this contract when it is referenced in a specification, model, design, instance or a contract derivative; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which this plan definition is (or will be) published. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. Contract.version | |
| Definition | An edition identifier used for business purposes to label business significant variants. |
| Short | Business edition |
| Comments | Note - This is a business versionId, not a resource version id (see discussion at Versioning) 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]. The version SHOULD NOT contain a '#' - see Business Version. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | The identifier that is used to identify this version of the contract when it is referenced in a specification, model, design, instance, or contract derivative. This is an arbitrary value managed by the contract author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Contract.status | |
| Definition | The status of the resource instance. |
| Short | amended | appended | cancelled | disputed | entered-in-error | executable + |
| Comments | This element is labeled as a modifier because the status contains codes that mark the contract as not currently valid or active. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContractResourceStatusCodes (required to http://hl7.org/fhir/ValueSet/contract-status|5.0.0)A code specifying the state of the resource instance. |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | This is the Contract Business Workflow Status. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. Contract.legalState | |
| Definition | Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement. |
| Short | Negotiation status |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ContractResourceLegalStateCodes (extensible to http://hl7.org/fhir/ValueSet/contract-legalstate|5.0.0)Detailed codes for the legal state of a contract. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | The legal state of a contract follows a prescribed flow as defined by the legal community and these state may be indepenedent of the workflow state. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. Contract.instantiatesCanonical | |
| Definition | The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. |
| Short | Source Contract Definition |
| Control | 0..1 |
| Type | Reference(Contract) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. Contract.instantiatesUri | |
| Definition | The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. |
| Short | External Contract Definition |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. Contract.contentDerivative | |
| Definition | The minimal content derived from the basal information source at a specific stage in its lifecycle. |
| Short | Content derived from the basal information |
| Control | 0..1 |
| Binding | For example codes, see ContractContentDerivationCodes (example to http://hl7.org/fhir/ValueSet/contract-content-derivative|5.0.0)This is an example set of Content Derivative type codes, which represent the minimal content derived from the basal information source. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | In the context of a contract, the information source of the content derivative shall be the information referenced by the contract.binding. The Contract Resource may function simply as the computable representation of the executed contract, which may be the attached to the Contract Resource as the “binding” or as the “friendly” electronic form. For example, a Contract Resource may be automatically populated with the values expressed in a related QuestionnaireResponse. However, the Contract Resource may be considered the legally binding contract if it is the only “executed” form of this contract, and includes the signatures as *The Contract Resource may function as the computable representation of an application or offer in a pre-executed Contract if the grantor has not entered any values. In this case, it is populated with values in a “legal” form of the application or offer or by the values in an associated Questionnaire. If the grantor has filled in the legal form or the associated Questionnaire Response, then these values are used to populate a pre-executed Contract Resource. If the Contract.topic is considered an application or offer, then the policy is often required to be attached as the “legal” basis for the application to ensure “informed consent” to the contract, and that any discrepancy between the application and the policy are interpreted against the policy. Implementers should check organizational and jurisdictional policies to determine the relationship among multiple representations of a contract pre- and post-execution. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. Contract.issued | |
| Definition | When this Contract was issued. |
| Short | When this Contract was issued |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | The Contract issuance dateTime often precedes the Contract effective dateTime. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 92. Contract.applies | |
| Definition | Relevant time or time-period when this Contract is applicable. |
| Short | Effective time |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | The dateTime upon which the Contract is binding. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. Contract.applies.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 96. Contract.applies.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.applies.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 98. Contract.applies.extension:applies | |
| Slice Name | applies |
| Definition | DSTU2: |
| Short | DSTU2: applies additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: applies additional types) (Extension Type: Period) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 100. Contract.applies.start | |
| Definition | The start of the period. The boundary is inclusive. |
| Short | Starting time with inclusive boundary |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 102. Contract.applies.end | |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Short | End time with inclusive boundary, if not ongoing |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Control | 0..1 This element is affected by the following invariants: per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 104. Contract.expirationType | |
| Definition | Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. |
| Short | Contract cessation cause |
| Control | 0..1 |
| Binding | For example codes, see ContractResourceExpirationTypeCodes (example to http://hl7.org/fhir/ValueSet/contract-expiration-type|5.0.0)Codes for the Cessation of Contracts. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 106. Contract.subject | |
| Definition | The target entity impacted by or of interest to parties to the agreement. |
| Short | Contract Target Entity |
| Comments | The Contract.subject is an entity that has some role with respect to the Contract.topic and Contract.topic.term, which is of focal interest to the parties to the contract and likely impacted in a significant way by the Contract.action/Contract.action.reason and the Contract.term.action/Contract.action.reason. In many cases, the Contract.subject is a Contract.signer if the subject is an adult; has a legal interest in the contract; and incompetent to participate in the contract agreement. |
| Control | 0..* |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | The Contract.subject is an entity that has some role with respect to the Contract.topic and Contract.topic.term, which is of focal interest to the parties to the contract and likely impacted in a significant way by the Contract.action/Contract.action.reason and the Contract.term.action/Contract.action.reason. In many cases, the Contract.subject is a Contract.signer if the subject is an adult; has a legal interest in the contract; and incompetent to participate in the contract agreement. |
| Alternate Names | Patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 108. Contract.subject.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 110. Contract.subject.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 112. Contract.subject.extension:subject | |
| Slice Name | subject |
| Definition | DSTU2: |
| Short | DSTU2: Subject of this Contract additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 114. Contract.subject.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 116. Contract.subject.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType ![]() (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 118. Contract.subject.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 120. Contract.subject.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 122. Contract.authority | |
| Definition | A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies. |
| Short | Authority under which this Contract has standing |
| Control | 0..* |
| Type | Reference(Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | The governance framework responsible for ensuring compliance with or enforcement of the contract or policy. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 124. Contract.authority.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 126. Contract.authority.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.authority.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 128. Contract.authority.extension:authority | |
| Slice Name | authority |
| Definition | DSTU2: |
| Short | DSTU2: authority additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 130. Contract.authority.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 132. Contract.authority.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType ![]() (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 134. Contract.authority.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 136. Contract.authority.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 138. Contract.domain | |
| Definition | Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources. |
| Short | A sphere of control governed by an authoritative jurisdiction, organization, or person |
| Control | 0..* |
| Type | Reference(Location) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | The entities bound by governance to comply with the enforcement of contracts or policies by a recognized authority. |
| Alternate Names | scope of governance jurisdiction |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 140. Contract.domain.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 142. Contract.domain.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.domain.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 144. Contract.domain.extension:domain | |
| Slice Name | domain |
| Definition | DSTU2: |
| Short | DSTU2: Domain in which this Contract applies additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 146. Contract.domain.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 148. Contract.domain.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType ![]() (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 150. Contract.domain.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 152. Contract.domain.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 154. Contract.site | |
| Definition | Sites in which the contract is complied with, exercised, or in force. |
| Short | Specific Location |
| Control | 0..* |
| Type | Reference(Location) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 156. Contract.name | |
| Definition | A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Short | Computer friendly designation |
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Support human navigation and code generation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 158. Contract.title | |
| Definition | A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state. |
| Short | Human Friendly name |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 160. Contract.subtitle | |
| Definition | A more detailed or qualifying explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state. |
| Short | Subordinate Friendly name |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 162. Contract.alias | |
| Definition | Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation. |
| Short | Acronym or short name |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 164. Contract.author | |
| Definition | The individual or organization that authored the Contract definition, derivative, or instance in any legal state. |
| Short | Source of Contract |
| Control | 0..1 |
| Type | Reference(Patient, Practitioner, PractitionerRole, Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 166. Contract.author.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 168. Contract.author.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 170. Contract.author.extension:entity | |
| Slice Name | entity |
| Definition | DSTU2: |
| Short | DSTU2: Contract Actor Type |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 172. Contract.author.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 174. Contract.author.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType ![]() (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 176. Contract.author.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 178. Contract.author.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 180. Contract.scope | |
| Definition | A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. |
| Short | Range of Legal Concerns |
| Control | 0..1 |
| Binding | For example codes, see ContractResourceScopeCodes (example to http://hl7.org/fhir/ValueSet/contract-scope|5.0.0)Codes for the range of legal concerns. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 182. Contract.topic[x] | |
| Definition | Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. |
| Short | Focus of contract interest |
| Comments | 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. |
| Control | 0..1 |
| Type | Choice of: CodeableConcept, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | May be used to focus the topic of a Contract definition, derivative, or instance in any legal state. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 184. Contract.type | |
| Definition | A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract. |
| Short | Legal instrument category |
| Control | 0..1 |
| Binding | For example codes, see ContractTypeCodes (example to http://hl7.org/fhir/ValueSet/contract-type|5.0.0)List of overall contract codes. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 186. Contract.subType | |
| Definition | Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope. |
| Short | Subtype within the context of type |
| Control | 0..* |
| Binding | For example codes, see ContractSubtypeCodes (example to http://hl7.org/fhir/ValueSet/contract-subtype|5.0.0)Detailed codes within the above. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 188. Contract.contentDefinition | |
| Definition | Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract. |
| Short | Contract precursor content |
| Control | 0..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 190. Contract.contentDefinition.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 192. Contract.contentDefinition.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 194. Contract.contentDefinition.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 196. Contract.contentDefinition.type | |
| Definition | Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation. |
| Short | Content structure and use |
| Control | 1..1 |
| Binding | For example codes, see ContractResourceDefinitionTypeCodes (example to http://hl7.org/fhir/ValueSet/contract-definition-type|5.0.0)Detailed codes for the definition of contracts. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 198. Contract.contentDefinition.subType | |
| Definition | Detailed Precusory content type. |
| Short | Detailed Content Type Definition |
| Control | 0..1 |
| Binding | For example codes, see ContractResourceDefinitionSubtypeCodes (example to http://hl7.org/fhir/ValueSet/contract-definition-subtype|5.0.0)Detailed codes for the additional definition of contracts. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 200. Contract.contentDefinition.publisher | |
| Definition | The individual or organization that published the Contract precursor content. |
| Short | Publisher Entity |
| Control | 0..1 |
| Type | Reference(Practitioner, PractitionerRole, Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 202. Contract.contentDefinition.publicationDate | |
| Definition | The date (and optionally time) when the contract was last significantly changed. 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. |
| Short | When published |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 204. Contract.contentDefinition.publicationStatus | |
| Definition | amended | appended | cancelled | disputed | entered-in-error | executable +. |
| Short | amended | appended | cancelled | disputed | entered-in-error | executable + |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContractResourcePublicationStatusCodes (required to http://hl7.org/fhir/ValueSet/contract-publicationstatus|5.0.0)Status of the publication of contract content. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 206. Contract.contentDefinition.copyright | |
| Definition | A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content. |
| Short | Publication Ownership |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 208. Contract.term | |
| Definition | One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. |
| Short | Contract Term List |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 210. Contract.term.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 212. Contract.term.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.term.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 214. Contract.term.extension:actionReason | |
| Slice Name | actionReason |
| Definition | DSTU2: |
| Short | DSTU2: Contract Term Action Reason (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Term Action Reason (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 216. Contract.term.extension:actor | |
| Slice Name | actor |
| Definition | DSTU2: |
| Short | DSTU2: Contract Term Actor List (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Term Actor List (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 218. Contract.term.extension:valuedItem | |
| Slice Name | valuedItem |
| Definition | DSTU2: |
| Short | DSTU2: Contract Term Valued Item (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contract Term Valued Item (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 220. Contract.term.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 222. Contract.term.identifier | |
| Definition | Unique identifier for this particular Contract Provision. |
| Short | Contract Term Number |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 224. Contract.term.identifier.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 226. Contract.term.identifier.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.term.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 228. Contract.term.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | DSTU2: |
| Short | DSTU2: Contract Term identifier additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Contract Term identifier additional types) (Extension Type: Identifier) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 230. Contract.term.identifier.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 232. Contract.term.identifier.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 234. Contract.term.identifier.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 236. Contract.term.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 238. Contract.term.identifier.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 240. Contract.term.identifier.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 242. Contract.term.issued | |
| Definition | When this Contract Provision was issued. |
| Short | Contract Term Issue Date Time |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 244. Contract.term.applies | |
| Definition | Relevant time or time-period when this Contract Provision is applicable. |
| Short | Contract Term Effective Time |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 246. Contract.term.applies.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 248. Contract.term.applies.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.term.applies.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 250. Contract.term.applies.extension:applies | |
| Slice Name | applies |
| Definition | DSTU2: |
| Short | DSTU2: applies additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: applies additional types) (Extension Type: Period) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 252. Contract.term.applies.start | |
| Definition | The start of the period. The boundary is inclusive. |
| Short | Starting time with inclusive boundary |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 254. Contract.term.applies.end | |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Short | End time with inclusive boundary, if not ongoing |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Control | 0..1 This element is affected by the following invariants: per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 256. Contract.term.topic[x] | |
| Definition | The entity that the term applies to. |
| Short | Term Concern |
| Control | 0..1 |
| Type | Choice of: CodeableConcept, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 258. Contract.term.topic[x].id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 260. Contract.term.topic[x].extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.term.topic[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 262. Contract.term.topic[x].extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | DSTU2: |
| Short | DSTU2: Subject of this Contract Term additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 264. Contract.term.type | |
| Definition | A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time. |
| Short | Contract Term Type or Form |
| Control | 0..1 |
| Binding | For example codes, see ContractTermTypeCodes (example to http://hl7.org/fhir/ValueSet/contract-term-type|5.0.0)Detailed codes for the types of contract provisions. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 266. Contract.term.subType | |
| Definition | A specialized legal clause or condition based on overarching contract type. |
| Short | Contract Term Type specific classification |
| Control | 0..1 |
| Binding | For example codes, see ContractTermSubtypeCodes (example to http://hl7.org/fhir/ValueSet/contract-term-subtype|5.0.0)Detailed codes for the subtypes of contract provisions. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 268. Contract.term.text | |
| Definition | Statement of a provision in a policy or a contract. |
| Short | Term Statement |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 270. Contract.term.securityLabel | |
| Definition | Security labels that protect the handling of information about the term and its elements, which may be specifically identified. |
| Short | Protection for the Term |
| Comments | 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. 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. 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. 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. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | This security label protects the term and its contained provision elements. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 272. Contract.term.securityLabel.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 274. Contract.term.securityLabel.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 276. Contract.term.securityLabel.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 278. Contract.term.securityLabel.number | |
| Definition | Number used to link this term or term element to the applicable Security Label. |
| Short | Link to Security Labels |
| Control | 0..* |
| Type | unsignedInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 280. Contract.term.securityLabel.classification | |
| Definition | Security label privacy tag that specifies the level of confidentiality protection required for this term and/or term elements. |
| Short | Confidentiality Protection |
| Control | 1..1 |
| Binding | For example codes, see ContractResourceScopeCodes (example to http://hl7.org/fhir/ValueSet/contract-security-classification|5.0.0)Codes for confidentiality protection. |
| Type | Coding |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 282. Contract.term.securityLabel.category | |
| Definition | Security label privacy tag that specifies the applicable privacy and security policies governing this term and/or term elements. |
| Short | Applicable Policy |
| Control | 0..* |
| Binding | For example codes, see ContractResourceScopeCodes (example to http://hl7.org/fhir/ValueSet/contract-security-category|5.0.0)Codes for policy category. |
| Type | Coding |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 284. Contract.term.securityLabel.control | |
| Definition | Security label privacy tag that specifies the manner in which term and/or term elements are to be protected. |
| Short | Handling Instructions |
| Control | 0..* |
| Binding | For example codes, see ContractResourceSecurityControlCodes (example to http://hl7.org/fhir/ValueSet/contract-security-control|5.0.0)Codes for handling instructions. |
| Type | Coding |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 286. Contract.term.offer | |
| Definition | The matter of concern in the context of this provision of the agrement. |
| Short | Context of the Contract term |
| Control | 1..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 288. Contract.term.offer.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 290. Contract.term.offer.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 292. Contract.term.offer.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 294. Contract.term.offer.identifier | |
| Definition | Unique identifier for this particular Contract Provision. |
| Short | Offer business ID |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 296. Contract.term.offer.party | |
| Definition | Offer Recipient. |
| Short | Offer Recipient |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 298. Contract.term.offer.party.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 300. Contract.term.offer.party.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 302. Contract.term.offer.party.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 304. Contract.term.offer.party.reference | |
| Definition | Participant in the offer. |
| Short | Referenced entity |
| Control | 1..* |
| Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Device, Group, Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 306. Contract.term.offer.party.role | |
| Definition | How the party participates in the offer. |
| Short | Participant engagement type |
| Control | 1..1 |
| Binding | For example codes, see ContractResourcePartyRoleCodes (example to http://hl7.org/fhir/ValueSet/contract-party-role|5.0.0)Codes for offer participant roles. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 308. Contract.term.offer.topic | |
| Definition | The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30). |
| Short | Negotiable offer asset |
| Comments | The Contract.topic may be an application for or offer of a policy or service (e.g., uri to a consent directive form or a health insurance policy), which becomes the Contract once accepted by both the grantor and grantee. The Contract Resource may function simply as the computable representation of the executed contract, which may be the attached to the Contract Resource as the “binding” or as the “friendly” electronic form. For example, a Contract Resource may be automatically populated with the values expressed in a related QuestionnaireResponse. However, the Contract Resource may be considered the legally binding contract if it is the only “executed” form of this contract, and includes the signatures as *The Contract Resource may function as the computable representation of an application or offer in a pre-executed Contract if the grantor has not entered any values. In this case, it is populated with values in a “legal” form of the application or offer or by the values in an associated Questionnaire. If the grantor has filled in the legal form or the associated Questionnaire Response, then these values are used to populate a pre-executed Contract Resource. If the Contract.topic is considered an application or offer, then the policy is often required to be attached as the “legal” basis for the application to ensure “informed consent” to the contract, and that any discrepancy between the application and the policy are interpreted against the policy. Implementers should check organizational and jurisdictional policies to determine the relationship among multiple representations of a contract pre- and post-execution. |
| Control | 0..1 |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | In the context of a contract, the topic is the matter under consideration in regards to which specific rights, privileges, obligations, restrictions, and prohibitions are binding on any grantor and grantee parties upon the execution of the contract. Given the wide range of contract topics, implementers need to be cognizant of the business use case for which they are designing a FHIR Contract, and narrowly specify the topic being represented with respect to the Contract.type and any specializing Contract.subtype. The same topic, e.g., an asset such as a good or service, such as a real property, medical supply, insurance, information, a procedure or employment, or a manner of conduct, such adherence to a privacy, trust, or security policy, may be the topic of multiple types of contracts. One way to determine the Contract.topic is to answer the question: “What is the object of negotiation?” Answer: The Contract.topic, which may be described with more detail in the [0..*]Contract.valuedItem @ [0..1] Contract.valuedItem.entity[x] Definition: Specific type of Contract Valued Item that may be priced. CodeableConcept|Reference(Any) Contract.topic is “the what” that a grantor is exchanging with a grantee in return for some benefit. Contract.topic is “the what” to which any Contract.action is being applied for any stipulated Contract.action.reason. AContract.topic is “the what” governed by the execution of the contract to which any party’s rights, privileges, obligations, restrictions, and prohibitions apply. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 310. Contract.term.offer.type | |
| Definition | Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. |
| Short | Contract Offer Type or Form |
| Control | 0..1 |
| Binding | For example codes, see ContractTermTypeCodes (example to http://hl7.org/fhir/ValueSet/contract-term-type|5.0.0)Detailed codes for the types of contract provisions. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 312. Contract.term.offer.decision | |
| Definition | Type of choice made by accepting party with respect to an offer made by an offeror/ grantee. |
| Short | Accepting party choice |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ActConsentDirective (3.0.0) (extensible to http://terminology.hl7.org/ValueSet/v3-ActConsentDirective|3.0.0)The type of decision made by a grantor with respect to an offer made by a grantee. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | In some policy or contract contexts, the "offer" is made by an offeror wishing to be the "grantee" of the offer topic by the grantor. From this perspective, the grantor is the "offeree". |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 314. Contract.term.offer.decisionMode | |
| Definition | How the decision about a Contract was conveyed. |
| Short | How decision is conveyed |
| Control | 0..* |
| Binding | For example codes, see ContractResourceDecisionModeCodes (example to http://hl7.org/fhir/ValueSet/contract-decision-mode|5.0.0)Codes for conveying a decision. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 316. Contract.term.offer.answer | |
| Definition | Response to offer text. |
| Short | Response to offer text |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 318. Contract.term.offer.answer.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 320. Contract.term.offer.answer.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 322. Contract.term.offer.answer.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 324. Contract.term.offer.answer.value[x] | |
| Definition | Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warranty duration, or whether biospecimen may be used for further research. |
| Short | The actual answer response |
| Control | 1..1 |
| Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 326. Contract.term.offer.text | |
| Definition | Human readable form of this Contract Offer. |
| Short | Human readable offer text |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 328. Contract.term.offer.linkId | |
| Definition | The id of the clause or question text of the offer in the referenced questionnaire/response. |
| Short | Pointer to text |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 330. Contract.term.offer.securityLabelNumber | |
| Definition | Security labels that protects the offer. |
| Short | Offer restriction numbers |
| Control | 0..* |
| Type | unsignedInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 332. Contract.term.asset | |
| Definition | Contract Term Asset List. |
| Short | Contract Term Asset List |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 334. Contract.term.asset.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 336. Contract.term.asset.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 338. Contract.term.asset.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 340. Contract.term.asset.scope | |
| Definition | Differentiates the kind of the asset . |
| Short | Range of asset |
| Control | 0..1 |
| Binding | For example codes, see ContractResourceAssetScopeCodes (example to http://hl7.org/fhir/ValueSet/contract-assetscope|5.0.0)Codes for scoping an asset. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 342. Contract.term.asset.type | |
| Definition | Target entity type about which the term may be concerned. |
| Short | Asset category |
| Control | 0..* |
| Binding | For example codes, see ContractResourceAssetTypeCodes (example to http://hl7.org/fhir/ValueSet/contract-assettype|5.0.0)Condes for the type of an asset. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 344. Contract.term.asset.typeReference | |
| Definition | Associated entities. |
| Short | Associated entities |
| Control | 0..* |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 346. Contract.term.asset.subtype | |
| Definition | May be a subtype or part of an offered asset. |
| Short | Asset sub-category |
| Control | 0..* |
| Binding | For example codes, see ContractResourceAssetSubTypeCodes (example to http://hl7.org/fhir/ValueSet/contract-assetsubtype|5.0.0)Condes for the sub-type of an asset. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 348. Contract.term.asset.relationship | |
| Definition | Specifies the applicability of the term to an asset resource instance, and instances it refers to or instances that refer to it, and/or are owned by the offeree. |
| Short | Kinship of the asset |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ConsentContentClass (extensible to http://hl7.org/fhir/ValueSet/consent-content-class|5.0.0)The class (type) of information a consent rule covers. |
| Type | Coding |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 350. Contract.term.asset.context | |
| Definition | Circumstance of the asset. |
| Short | Circumstance of the asset |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 352. Contract.term.asset.context.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 354. Contract.term.asset.context.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 356. Contract.term.asset.context.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 358. Contract.term.asset.context.reference | |
| Definition | Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. |
| Short | Creator,custodian or owner |
| Control | 0..1 |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 360. Contract.term.asset.context.code | |
| Definition | Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location. |
| Short | Codeable asset context |
| Control | 0..* |
| Binding | For example codes, see ContractResourceAssetContextCodes (example to http://hl7.org/fhir/ValueSet/contract-assetcontext|5.0.0)Codes for the context of the asset. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 362. Contract.term.asset.context.text | |
| Definition | Context description. |
| Short | Context description |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 364. Contract.term.asset.condition | |
| Definition | Description of the quality and completeness of the asset that may be a factor in its valuation. |
| Short | Quality desctiption of asset |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 366. Contract.term.asset.periodType | |
| Definition | Type of Asset availability for use or ownership. |
| Short | Asset availability types |
| Control | 0..* |
| Binding | For example codes, see ContractResourceAssetAvailiabilityCodes (example to http://hl7.org/fhir/ValueSet/asset-availability|5.0.0)Codes for asset availability. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 368. Contract.term.asset.period | |
| Definition | Asset relevant contractual time period. |
| Short | Time period of the asset |
| Control | 0..* |
| Type | Period |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 370. Contract.term.asset.usePeriod | |
| Definition | Time period of asset use. |
| Short | Time period |
| Control | 0..* |
| Type | Period |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 372. Contract.term.asset.text | |
| Definition | Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract. |
| Short | Asset clause or question text |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 374. Contract.term.asset.linkId | |
| Definition | Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse. |
| Short | Pointer to asset text |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 376. Contract.term.asset.answer | |
| Definition | Response to assets. |
| Short | Response to assets |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Contract#Contract.term.offer.answer |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 378. Contract.term.asset.securityLabelNumber | |
| Definition | Security labels that protects the asset. |
| Short | Asset restriction numbers |
| Control | 0..* |
| Type | unsignedInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 380. Contract.term.asset.valuedItem | |
| Definition | Contract Valued Item List. |
| Short | Contract Valued Item List |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 382. Contract.term.asset.valuedItem.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 384. Contract.term.asset.valuedItem.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 386. Contract.term.asset.valuedItem.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 388. Contract.term.asset.valuedItem.entity[x] | |
| Definition | Specific type of Contract Valued Item that may be priced. |
| Short | Contract Valued Item Type |
| Control | 0..1 |
| Type | Choice of: CodeableConcept, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 390. Contract.term.asset.valuedItem.identifier | |
| Definition | Identifies a Contract Valued Item instance. |
| Short | Contract Valued Item Number |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 392. Contract.term.asset.valuedItem.effectiveTime | |
| Definition | Indicates the time during which this Contract ValuedItem information is effective. |
| Short | Contract Valued Item Effective Tiem |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 394. Contract.term.asset.valuedItem.quantity | |
| Definition | Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances. |
| Short | Count of Contract Valued Items |
| Control | 0..1 |
| Type | Quantity(SimpleQuantity) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 396. Contract.term.asset.valuedItem.unitPrice | |
| Definition | A Contract Valued Item unit valuation measure. |
| Short | Contract Valued Item fee, charge, or cost |
| Control | 0..1 |
| Type | Money |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 398. Contract.term.asset.valuedItem.factor | |
| Definition | A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
| Short | Contract Valued Item Price Scaling Factor |
| Control | 0..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 400. Contract.term.asset.valuedItem.points | |
| Definition | An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point. |
| Short | Contract Valued Item Difficulty Scaling Factor |
| Control | 0..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 402. Contract.term.asset.valuedItem.net | |
| Definition | Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied. |
| Short | Total Contract Valued Item Value |
| Control | 0..1 |
| Type | Money |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 404. Contract.term.asset.valuedItem.payment | |
| Definition | Terms of valuation. |
| Short | Terms of valuation |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 406. Contract.term.asset.valuedItem.paymentDate | |
| Definition | When payment is due. |
| Short | When payment is due |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 408. Contract.term.asset.valuedItem.responsible | |
| Definition | Who will make payment. |
| Short | Who will make payment |
| Control | 0..1 |
| Type | Reference(Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 410. Contract.term.asset.valuedItem.recipient | |
| Definition | Who will receive payment. |
| Short | Who will receive payment |
| Control | 0..1 |
| Type | Reference(Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 412. Contract.term.asset.valuedItem.linkId | |
| Definition | Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse. |
| Short | Pointer to specific item |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 414. Contract.term.asset.valuedItem.securityLabelNumber | |
| Definition | A set of security labels that define which terms are controlled by this condition. |
| Short | Security Labels that define affected terms |
| Control | 0..* |
| Type | unsignedInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 416. Contract.term.action | |
| Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
| Short | Entity being ascribed responsibility |
| Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. For example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, software, or system process. However, only one user may be the initiator/requestor for the event. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 418. Contract.term.action.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 420. Contract.term.action.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 422. Contract.term.action.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 424. Contract.term.action.doNotPerform | |
| Definition | True if the term prohibits the action. |
| Short | True if the term prohibits the action |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because If true this element negates the specified action. For Example, instead of a dictate to perform an action, it is a dictate not to perform the action. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 426. Contract.term.action.type | |
| Definition | Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term. |
| Short | Type or form of the action |
| Control | 1..1 |
| Binding | For example codes, see ContractActionCodes (example to http://hl7.org/fhir/ValueSet/contract-action|5.0.0)Detailed codes for the contract action. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 428. Contract.term.action.subject | |
| Definition | Entity of the action. |
| Short | Entity of the action |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 430. Contract.term.action.subject.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 432. Contract.term.action.subject.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 434. Contract.term.action.subject.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 436. Contract.term.action.subject.reference | |
| Definition | The entity the action is performed or not performed on or for. |
| Short | Entity of the action |
| Control | 1..* |
| Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Device, Group, Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 438. Contract.term.action.subject.role | |
| Definition | Role type of agent assigned roles in this Contract. |
| Short | Role type of the agent |
| Control | 0..1 |
| Binding | For example codes, see ContractActorRoleCodes (example to http://hl7.org/fhir/ValueSet/contract-actorrole|5.0.0)Detailed codes for the contract actor role. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 440. Contract.term.action.intent | |
| Definition | Reason or purpose for the action stipulated by this Contract Provision. |
| Short | Purpose for the Contract Term Action |
| Control | 1..1 |
| Binding | For example codes, see PurposeOfUse (3.1.0) (example to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0)Detailed codes for the contract action reason. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 442. Contract.term.action.linkId | |
| Definition | Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse. |
| Short | Pointer to specific item |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 444. Contract.term.action.status | |
| Definition | Current state of the term action. |
| Short | State of the action |
| Control | 1..1 |
| Binding | For example codes, see ContractResourceActionStatusCodes (example to http://hl7.org/fhir/ValueSet/contract-actionstatus|5.0.0)Codes for the status of a term action. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 446. Contract.term.action.context | |
| Definition | Encounter or Episode with primary association to the specified term activity. |
| Short | Episode associated with action |
| Control | 0..1 |
| Type | Reference(Encounter, EpisodeOfCare) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 448. Contract.term.action.contextLinkId | |
| Definition | Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. |
| Short | Pointer to specific item |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 450. Contract.term.action.occurrence[x] | |
| Definition | When action happens. |
| Short | When action happens |
| Control | 0..1 |
| Type | Choice of: dateTime, Period, Timing |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 452. Contract.term.action.requester | |
| Definition | Who or what initiated the action and has responsibility for its activation. |
| Short | Who asked for action |
| Control | 0..* |
| Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Device, Group, Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 454. Contract.term.action.requesterLinkId | |
| Definition | Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. |
| Short | Pointer to specific item |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 456. Contract.term.action.performerType | |
| Definition | The type of individual that is desired or required to perform or not perform the action. |
| Short | Kind of service performer |
| Control | 0..* |
| Binding | For example codes, see ParticipationRoleType (example to http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0)Codes for the types of action performer. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 458. Contract.term.action.performerRole | |
| Definition | The type of role or competency of an individual desired or required to perform or not perform the action. |
| Short | Competency of the performer |
| Control | 0..1 |
| Binding | For example codes, see SecurityRoleType (example to http://hl7.org/fhir/ValueSet/security-role-type|5.0.0)Codes for the role of the action performer. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 460. Contract.term.action.performer | |
| Definition | Indicates who or what is being asked to perform (or not perform) the ction. |
| Short | Actor that wil execute (or not) the action |
| Control | 0..1 |
| Type | Reference(RelatedPerson, Patient, Practitioner, PractitionerRole, CareTeam, Device, Substance, Organization, Location) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 462. Contract.term.action.performerLinkId | |
| Definition | Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse. |
| Short | Pointer to specific item |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 464. Contract.term.action.reason | |
| Definition | Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. Either a coded concept, or another resource whose existence justifies permitting or not permitting this action. |
| Short | Why is action (not) needed? |
| Control | 0..* |
| Binding | For example codes, see PurposeOfUse (3.1.0) (example to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0)Detailed codes for the contract action reason. |
| Type | CodeableReference(Condition, Observation, DiagnosticReport, DocumentReference, Questionnaire, QuestionnaireResponse) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 466. Contract.term.action.reasonLinkId | |
| Definition | Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse. |
| Short | Pointer to specific item |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 468. Contract.term.action.note | |
| Definition | Comments made about the term action made by the requester, performer, subject or other participants. |
| Short | Comments about the action |
| Control | 0..* |
| Type | Annotation |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 470. Contract.term.action.securityLabelNumber | |
| Definition | Security labels that protects the action. |
| Short | Action restriction numbers |
| Control | 0..* |
| Type | unsignedInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 472. Contract.term.group | |
| Definition | Nested group of Contract Provisions. |
| Short | Nested Contract Term Group |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Contract#Contract.term |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 474. Contract.supportingInfo | |
| Definition | Information that may be needed by/relevant to the performer in their execution of this term action. |
| Short | Extra Information |
| Control | 0..* |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 476. Contract.relevantHistory | |
| Definition | Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provenance.entity indicates the target that was changed in the update (see Provenance.entity). |
| Short | Key event in Contract History |
| Control | 0..* |
| Type | Reference(Provenance) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 478. Contract.signer | |
| Definition | Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness. |
| Short | Contract Signatory |
| Comments | Signers who are principal parties to the contract are bound by the Contract.activity related to the Contract.topic, and the Contract.term(s), which either extend or restrict the overall action on the topic by, for example, stipulating specific policies or obligations constraining actions, action reason, or agents with respect to some or all of the topic. For example, specifying how policies or obligations shall constrain actions and action reasons permitted or denied on all or a subset of the Contract.topic (e.g., all or a portion of property being transferred by the contract), agents (e.g., who can resell, assign interests, or alter the property being transferred by the contract), actions, and action reasons; or with respect to Contract.terms, stipulating, extending, or limiting the Contract.period of applicability or valuation of items under consideration. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | The Contract.signer applies a signature to the Contract.binding referenced resource, which is the documentation that is the legal "source of truth". The Contract.signer may delegate, such as a legally recognized personal representative, or have a delegate assigned e.g., by a court of law, to actually sign the Contract, such as a trustee in the case of incompetence. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 480. Contract.signer.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 482. Contract.signer.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 484. Contract.signer.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 486. Contract.signer.type | |
| Definition | Role of this Contract signer, e.g. notary, grantee. |
| Short | Contract Signatory Role |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from ContractSignerTypeCodes ![]() (preferred to http://hl7.org/fhir/ValueSet/contract-signer-type|5.0.0)List of parties who may be signing. |
| Type | Coding |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 488. Contract.signer.party | |
| Definition | Party which is a signator to this Contract. |
| Short | Contract Signatory Party |
| Control | 1..1 |
| Type | Reference(Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 490. Contract.signer.party.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 492. Contract.signer.party.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.signer.party.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 494. Contract.signer.party.extension:party | |
| Slice Name | party |
| Definition | DSTU2: |
| Short | DSTU2: party |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 496. Contract.signer.party.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 498. Contract.signer.party.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType ![]() (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 500. Contract.signer.party.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 502. Contract.signer.party.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 504. Contract.signer.signature | |
| Definition | Legally binding Contract DSIG signature contents in Base64. |
| Short | Contract Documentation Signature |
| Control | 1..* |
| Type | Signature |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 506. Contract.signer.signature.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 508. Contract.signer.signature.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.signer.signature.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 510. Contract.signer.signature.extension:signature | |
| Slice Name | signature |
| Definition | DSTU2: |
| Short | DSTU2: signature additional types |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: signature additional types) (Extension Type: string) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 512. Contract.signer.signature.type | |
| Definition | An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. |
| Short | Indication of the reason the entity signed the object(s) |
| Comments | Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication". |
| Control | 0..* |
| Binding | The codes SHOULD be taken from SignatureTypeCodes (preferred to http://hl7.org/fhir/ValueSet/signature-type|5.0.0)An indication of the reason that an entity signed the object. |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 514. Contract.signer.signature.when | |
| Definition | When the digital signature was signed. |
| Short | When the signature was created |
| Comments | This should agree with the information in the signature. |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 516. Contract.signer.signature.who | |
| Definition | A reference to an application-usable description of the identity that signed (e.g. the signature used their private key). |
| Short | Who signed |
| Comments | This should agree with the information in the signature. |
| Control | 0..1 |
| Type | Reference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 518. Contract.signer.signature.onBehalfOf | |
| Definition | A reference to an application-usable description of the identity that is represented by the signature. |
| Short | The party represented |
| Comments | The party that can't sign. For example a child. |
| Control | 0..1 |
| Type | Reference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) |
| Is Modifier | false |
| Summary | true |
| Requirements | used when the signature is on behalf of a non-signer. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 520. Contract.signer.signature.targetFormat | |
| Definition | A mime type that indicates the technical format of the target resources signed by the signature. |
| Short | The technical format of the signed resources |
| Comments | "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MimeTypes (required to http://hl7.org/fhir/ValueSet/mimetypes|5.0.0)BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 522. Contract.signer.signature.sigFormat | |
| Definition | A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc. |
| Short | The technical format of the signature |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MimeTypes (required to http://hl7.org/fhir/ValueSet/mimetypes|5.0.0)BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 524. Contract.signer.signature.data | |
| Definition | The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. |
| Short | The actual signature content (XML DigSig. JWS, picture, etc.) |
| Comments | Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form. |
| Control | 0..1 |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 526. Contract.friendly | |
| Definition | The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement. |
| Short | Contract Friendly Language |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 528. Contract.friendly.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 530. Contract.friendly.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.friendly.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 532. Contract.friendly.extension:content | |
| Slice Name | content |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: content additional types) (Extension Type: Attachment) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 534. Contract.friendly.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 536. Contract.friendly.content[x] | |
| Definition | Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability. |
| Short | Easily comprehended representation of this Contract |
| Control | 1..1 |
| Type | Choice of: Attachment, Reference(Composition, DocumentReference, QuestionnaireResponse) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 538. Contract.friendly.content[x].id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 540. Contract.friendly.content[x].extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.friendly.content[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 542. Contract.friendly.content[x].extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 544. Contract.legal | |
| Definition | List of Legal expressions or representations of this Contract. |
| Short | Contract Legal Language |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 546. Contract.legal.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 548. Contract.legal.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.legal.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 550. Contract.legal.extension:content | |
| Slice Name | content |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: content additional types) (Extension Type: Attachment) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 552. Contract.legal.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 554. Contract.legal.content[x] | |
| Definition | Contract legal text in human renderable form. |
| Short | Contract Legal Text |
| Control | 1..1 |
| Type | Choice of: Attachment, Reference(Composition, DocumentReference, QuestionnaireResponse) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 556. Contract.legal.content[x].id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 558. Contract.legal.content[x].extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.legal.content[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 560. Contract.legal.content[x].extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 562. Contract.rule | |
| Definition | List of Computable Policy Rule Language Representations of this Contract. |
| Short | Computable Contract Language |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 564. Contract.rule.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 566. Contract.rule.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.rule.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 568. Contract.rule.extension:content | |
| Slice Name | content |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: content additional types) (Extension Type: Attachment) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 570. Contract.rule.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 572. Contract.rule.content[x] | |
| Definition | Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal). |
| Short | Computable Contract Rules |
| Control | 1..1 |
| Type | Choice of: Attachment, Reference(DocumentReference) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 574. Contract.rule.content[x].id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 576. Contract.rule.content[x].extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Contract.rule.content[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 578. Contract.rule.content[x].extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | DSTU2: |
| Short | DSTU2: content additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 580. Contract.legallyBinding[x] | |
| Definition | Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract. |
| Short | Binding Contract |
| Control | 0..1 |
| Type | Choice of: Attachment, Reference(Composition, DocumentReference, QuestionnaireResponse, Contract) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |