Obligation Discussion
0.5.1 - Working Draft to present the Concept Ideas and Background Details (FO)
Obligation Discussion
0.5.1 - Working Draft to present the Concept Ideas and Background Details (FO)
Obligation Discussion, published by . This guide is not an authorized publication; it is the continuous build for version 0.5.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/frankoemig/obligation/ and changes regularly. See the Directory of published versions
| Draft as of 2023-10-10 |
Definitions for the Obligation2Definition logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Base | |
| Definition | Obligation 2 Definition Resource Base definition for all types defined in FHIR type system. |
| Short | Obligation2DefinitionBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. Base.url | |
| Definition | Canonical identifier for this obligation, represented as a URI (globally unique) |
| Short | Canonical identifier for this obligation, represented as a URI (globally unique) |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. Base.identifier | |
| Definition | Additional identifier for the obligation (business identifier) |
| Short | Additional identifier for the obligation (business identifier) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 6. Base.version | |
| Definition | Business version of the obligation |
| Short | Business version of the obligation |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. Base.name | |
| Definition | Name for this obligation definition (computer friendly) |
| Short | Short Name for this Obligation |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Base.status | |
| Definition | draft | active | retired | unknown |
| Short | draft | active | retired | unknown |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. Base.date | |
| Definition | Date last changed |
| Short | Date last changed |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. Base.documentation | |
| Definition | Documentation of the purpose or application of the obligation |
| Short | Documentation of the purpose or application of the obligation |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Base.usage | |
| Definition | Qualifies the usage - jurisdiction, gender, workflow status etc |
| Short | Qualifies the usage - jurisdiction, gender, workflow status etc |
| Control | 0..* |
| Type | UsageContext |
| 18. Base.element | |
| Definition | Profile element(s) to whom this obligation applies to |
| Short | Profile element(s) to whom this obligation applies to |
| Control | 0..* |
| Type | Reference(StructureDefinition) |
| 20. Base.including | |
| Definition | Other obligations that are implicitly to be included |
| Short | Other obligations that are implicitly to be included |
| Control | 0..* |
| Type | Reference(Obligation2Definition) |
| 22. Base.activity | |
| Definition | set of obligations |
| Short | set of obligations |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Base.activity.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 | idstring |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 26. Base.activity.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 Base.activity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. Base.activity.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()) |
| 30. Base.activity.verb | |
| Definition | Composite code describing the requirement level of the obligation |
| Short | Composite code describing the requirement level of the obligation |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Verb ValueSet (required to http://v2.hl7.org/fhir/ValueSet/verb) |
| Type | Coding |
| 32. Base.activity.obligation | |
| Definition | Composite code describing the activity/obligation to performed by the application |
| Short | Composite code describing the activity/obligation to performed by the application |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from Obligation Alone ValueSet (extensible to http://v2.hl7.org/fhir/ValueSet/obligationAlone) |
| Type | Coding |
| 34. Base.activity.dataExpectation | |
| Definition | Composite code describing the expacation about data appearance |
| Short | Composite code describing the expacation about data appearance |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Data Expectation ValueSet (required to http://v2.hl7.org/fhir/ValueSet/dataExpectation) |
| Type | Coding |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Base | |
| Definition | Obligation 2 Definition Resource |
| Short | Obligation2Definition |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. Base.url | |
| Definition | Canonical identifier for this obligation, represented as a URI (globally unique) |
| Short | Canonical identifier for this obligation, represented as a URI (globally unique) |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. Base.identifier | |
| Definition | Additional identifier for the obligation (business identifier) |
| Short | Additional identifier for the obligation (business identifier) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 6. Base.version | |
| Definition | Business version of the obligation |
| Short | Business version of the obligation |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. Base.name | |
| Definition | Name for this obligation definition (computer friendly) |
| Short | Short Name for this Obligation |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Base.status | |
| Definition | draft | active | retired | unknown |
| Short | draft | active | retired | unknown |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. Base.date | |
| Definition | Date last changed |
| Short | Date last changed |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. Base.documentation | |
| Definition | Documentation of the purpose or application of the obligation |
| Short | Documentation of the purpose or application of the obligation |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Base.usage | |
| Definition | Qualifies the usage - jurisdiction, gender, workflow status etc |
| Short | Qualifies the usage - jurisdiction, gender, workflow status etc |
| Control | 0..* |
| Type | UsageContext |
| 18. Base.element | |
| Definition | Profile element(s) to whom this obligation applies to |
| Short | Profile element(s) to whom this obligation applies to |
| Control | 0..* |
| Type | Reference(StructureDefinition) |
| 20. Base.including | |
| Definition | Other obligations that are implicitly to be included |
| Short | Other obligations that are implicitly to be included |
| Control | 0..* |
| Type | Reference(Obligation2Definition) |
| 22. Base.activity | |
| Definition | set of obligations |
| Short | set of obligations |
| Control | 0..* |
| Type | BackboneElement |
| 24. Base.activity.verb | |
| Definition | Composite code describing the requirement level of the obligation |
| Short | Composite code describing the requirement level of the obligation |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Verb ValueSet (required to http://v2.hl7.org/fhir/ValueSet/verb) |
| Type | Coding |
| 26. Base.activity.obligation | |
| Definition | Composite code describing the activity/obligation to performed by the application |
| Short | Composite code describing the activity/obligation to performed by the application |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from Obligation Alone ValueSet (extensible to http://v2.hl7.org/fhir/ValueSet/obligationAlone) |
| Type | Coding |
| 28. Base.activity.dataExpectation | |
| Definition | Composite code describing the expacation about data appearance |
| Short | Composite code describing the expacation about data appearance |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Data Expectation ValueSet (required to http://v2.hl7.org/fhir/ValueSet/dataExpectation) |
| Type | Coding |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Base | |
| Definition | Obligation 2 Definition Resource |
| Short | Obligation2Definition |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. Base.url | |
| Definition | Canonical identifier for this obligation, represented as a URI (globally unique) |
| Short | Canonical identifier for this obligation, represented as a URI (globally unique) |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. Base.identifier | |
| Definition | Additional identifier for the obligation (business identifier) |
| Short | Additional identifier for the obligation (business identifier) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 6. Base.version | |
| Definition | Business version of the obligation |
| Short | Business version of the obligation |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. Base.name | |
| Definition | Name for this obligation definition (computer friendly) |
| Short | Short Name for this Obligation |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Base.status | |
| Definition | draft | active | retired | unknown |
| Short | draft | active | retired | unknown |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. Base.date | |
| Definition | Date last changed |
| Short | Date last changed |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. Base.documentation | |
| Definition | Documentation of the purpose or application of the obligation |
| Short | Documentation of the purpose or application of the obligation |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Base.usage | |
| Definition | Qualifies the usage - jurisdiction, gender, workflow status etc |
| Short | Qualifies the usage - jurisdiction, gender, workflow status etc |
| Control | 0..* |
| Type | UsageContext |
| 18. Base.element | |
| Definition | Profile element(s) to whom this obligation applies to |
| Short | Profile element(s) to whom this obligation applies to |
| Control | 0..* |
| Type | Reference(StructureDefinition) |
| 20. Base.including | |
| Definition | Other obligations that are implicitly to be included |
| Short | Other obligations that are implicitly to be included |
| Control | 0..* |
| Type | Reference(Obligation2Definition) |
| 22. Base.activity | |
| Definition | set of obligations |
| Short | set of obligations |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Base.activity.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 |
| 26. Base.activity.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 Base.activity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. Base.activity.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()) |
| 30. Base.activity.verb | |
| Definition | Composite code describing the requirement level of the obligation |
| Short | Composite code describing the requirement level of the obligation |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Verb ValueSet (required to http://v2.hl7.org/fhir/ValueSet/verb) |
| Type | Coding |
| 32. Base.activity.obligation | |
| Definition | Composite code describing the activity/obligation to performed by the application |
| Short | Composite code describing the activity/obligation to performed by the application |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from Obligation Alone ValueSet (extensible to http://v2.hl7.org/fhir/ValueSet/obligationAlone) |
| Type | Coding |
| 34. Base.activity.dataExpectation | |
| Definition | Composite code describing the expacation about data appearance |
| Short | Composite code describing the expacation about data appearance |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Data Expectation ValueSet (required to http://v2.hl7.org/fhir/ValueSet/dataExpectation) |
| Type | Coding |