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

Logical Model: Obligation2Definition ( Experimental )

Official URL: http://v2.hl7.org/fhir/StructureDefinition/Obligation2Definition Version: 0.1.0
Draft as of 2023-10-10 Computable Name: Obligation2Definition

Obligation 2 Definition Description:

is to be placed before the actor - profile 0..* <- 1 obligation 1..* <- 1 actor

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Base 0..* Base Obligation2Definition
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
... 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
... element 0..* Reference(StructureDefinition) Profile element(s) to whom this obligation applies to
... including 0..* Reference(Obligation2Definition) 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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Base.status Base required PublicationStatus 📦5.0.0 FHIR Std.
Base.activity.verb Base required Verb ValueSet 📦0.1.0 This IG
Base.activity.obligation Base extensible Obligation Alone ValueSet 📦0.1.0 This IG
Base.activity.dataExpectation Base required Data Expectation ValueSet 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Base 0..* Base Obligation2Definition
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
... 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
... element 0..* Reference(StructureDefinition) Profile element(s) to whom this obligation applies to
... including 0..* Reference(Obligation2Definition) 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)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Base.status Base required PublicationStatus 📦5.0.0 FHIR Std.
Base.activity.verb Base required Verb ValueSet 📦0.1.0 This IG
Base.activity.obligation Base extensible Obligation Alone ValueSet 📦0.1.0 This IG
Base.activity.dataExpectation Base required Data Expectation ValueSet 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Base 0..* Base Obligation2Definition
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
... 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
... element 0..* Reference(StructureDefinition) Profile element(s) to whom this obligation applies to
... including 0..* Reference(Obligation2Definition) 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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Base.status Base required PublicationStatus 📦5.0.0 FHIR Std.
Base.activity.verb Base required Verb ValueSet 📦0.1.0 This IG
Base.activity.obligation Base extensible Obligation Alone ValueSet 📦0.1.0 This IG
Base.activity.dataExpectation Base required Data Expectation ValueSet 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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

Summary

Mandatory: 0 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Base 0..* Base Obligation2Definition
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
... 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
... element 0..* Reference(StructureDefinition) Profile element(s) to whom this obligation applies to
... including 0..* Reference(Obligation2Definition) 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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Base.status Base required PublicationStatus 📦5.0.0 FHIR Std.
Base.activity.verb Base required Verb ValueSet 📦0.1.0 This IG
Base.activity.obligation Base extensible Obligation Alone ValueSet 📦0.1.0 This IG
Base.activity.dataExpectation Base required Data Expectation ValueSet 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Base 0..* Base Obligation2Definition
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
... 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
... element 0..* Reference(StructureDefinition) Profile element(s) to whom this obligation applies to
... including 0..* Reference(Obligation2Definition) 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)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Base.status Base required PublicationStatus 📦5.0.0 FHIR Std.
Base.activity.verb Base required Verb ValueSet 📦0.1.0 This IG
Base.activity.obligation Base extensible Obligation Alone ValueSet 📦0.1.0 This IG
Base.activity.dataExpectation Base required Data Expectation ValueSet 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Base 0..* Base Obligation2Definition
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
... 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
... element 0..* Reference(StructureDefinition) Profile element(s) to whom this obligation applies to
... including 0..* Reference(Obligation2Definition) 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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Base.status Base required PublicationStatus 📦5.0.0 FHIR Std.
Base.activity.verb Base required Verb ValueSet 📦0.1.0 This IG
Base.activity.obligation Base extensible Obligation Alone ValueSet 📦0.1.0 This IG
Base.activity.dataExpectation Base required Data Expectation ValueSet 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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

Summary

Mandatory: 0 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel