Obligation Discussion
0.4.1 - Working Draft to present the Concept Ideas and Background Details (FO)
Obligation Discussion
0.4.1 - Working Draft to present the Concept Ideas and Background Details (FO)
Obligation Discussion - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://v2.hl7.org/fhir/StructureDefinition/Obligation1Definition | Version: 0.1.0 | |||
| Draft as of 2023-10-10 | Responsible: HL7 International / Infrastructure And Messaging | Computable Name: Obligation1Definition | ||
Obligation 1 Definition Description:
is to be placed behind the actor: profile 0..* <- 1 actor 0..* <-> 0..* obligation
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Obligation |
0..* | Base | Obligation1Definition Instances of this logical model can be the target of a Reference | |
  url |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
 identifier |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
| version |
0..1 | string | Business version of the obligation | |
| name |
0..1 | string | Short Name for this Obligation | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
| date |
0..1 | dateTime | Date last changed | |
| documentation |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
| usage |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
 actor |
0..* | Reference(DomainResource) | Actor(s) to whom this obligation applies to (if any) | |
| element |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
| including |
0..* | Reference(Obligation1Definition) | Other obligations that are implicitly to be included | |
 activity |
0..* | BackboneElement | set of obligations | |
 verb |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
| obligation |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
 dataExpectation |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Obligation.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-statusfrom the FHIR Standard | |
| Obligation.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verbfrom this IG | |
| Obligation.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlonefrom this IG | |
| Obligation.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectationfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Obligation |
0..* | Base | Obligation1Definition Instances of this logical model can be the target of a Reference | |
| url |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
| identifier |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
| version |
0..1 | string | Business version of the obligation | |
| name |
0..1 | string | Short Name for this Obligation | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
| date |
0..1 | dateTime | Date last changed | |
| documentation |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
| usage |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
| actor |
0..* | Reference(DomainResource) | Actor(s) to whom this obligation applies to (if any) | |
| element |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
| including |
0..* | Reference(Obligation1Definition) | Other obligations that are implicitly to be included | |
| activity |
0..* | BackboneElement | set of obligations | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| verb |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
| obligation |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
| dataExpectation |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Obligation.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-statusfrom the FHIR Standard | |
| Obligation.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verbfrom this IG | |
| Obligation.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlonefrom this IG | |
| Obligation.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectationfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Obligation |
0..* | Base | Obligation1Definition Instances of this logical model can be the target of a Reference | |
| url |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
| identifier |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
| version |
0..1 | string | Business version of the obligation | |
| name |
0..1 | string | Short Name for this Obligation | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
| date |
0..1 | dateTime | Date last changed | |
| documentation |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
| usage |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
| actor |
0..* | Reference(DomainResource) | Actor(s) to whom this obligation applies to (if any) | |
| element |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
| including |
0..* | Reference(Obligation1Definition) | Other obligations that are implicitly to be included | |
| activity |
0..* | BackboneElement | set of obligations | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| verb |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
| obligation |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
| dataExpectation |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Obligation.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-statusfrom the FHIR Standard | |
| Obligation.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verbfrom this IG | |
| Obligation.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlonefrom this IG | |
| Obligation.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectationfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Obligation |
0..* | Base | Obligation1Definition Instances of this logical model can be the target of a Reference | |
| url |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
| identifier |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
| version |
0..1 | string | Business version of the obligation | |
| name |
0..1 | string | Short Name for this Obligation | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
| date |
0..1 | dateTime | Date last changed | |
| documentation |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
| usage |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
| actor |
0..* | Reference(DomainResource) | Actor(s) to whom this obligation applies to (if any) | |
| element |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
| including |
0..* | Reference(Obligation1Definition) | Other obligations that are implicitly to be included | |
| activity |
0..* | BackboneElement | set of obligations | |
| verb |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
| obligation |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
| dataExpectation |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Obligation.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-statusfrom the FHIR Standard | |
| Obligation.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verbfrom this IG | |
| Obligation.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlonefrom this IG | |
| Obligation.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectationfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Obligation |
0..* | Base | Obligation1Definition Instances of this logical model can be the target of a Reference | |
| url |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
| identifier |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
| version |
0..1 | string | Business version of the obligation | |
| name |
0..1 | string | Short Name for this Obligation | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
| date |
0..1 | dateTime | Date last changed | |
| documentation |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
| usage |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
| actor |
0..* | Reference(DomainResource) | Actor(s) to whom this obligation applies to (if any) | |
| element |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
| including |
0..* | Reference(Obligation1Definition) | Other obligations that are implicitly to be included | |
| activity |
0..* | BackboneElement | set of obligations | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| verb |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
| obligation |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
| dataExpectation |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Obligation.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-statusfrom the FHIR Standard | |
| Obligation.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verbfrom this IG | |
| Obligation.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlonefrom this IG | |
| Obligation.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectationfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Obligation |
0..* | Base | Obligation1Definition Instances of this logical model can be the target of a Reference | |
| url |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
| identifier |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
| version |
0..1 | string | Business version of the obligation | |
| name |
0..1 | string | Short Name for this Obligation | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
| date |
0..1 | dateTime | Date last changed | |
| documentation |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
| usage |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
| actor |
0..* | Reference(DomainResource) | Actor(s) to whom this obligation applies to (if any) | |
| element |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
| including |
0..* | Reference(Obligation1Definition) | Other obligations that are implicitly to be included | |
| activity |
0..* | BackboneElement | set of obligations | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| verb |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
| obligation |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
| dataExpectation |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Obligation.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-statusfrom the FHIR Standard | |
| Obligation.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verbfrom this IG | |
| Obligation.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlonefrom this IG | |
| Obligation.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectationfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base