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/Obligation2Definition | Version: 0.1.0 | |||
Draft as of 2023-10-10 | Responsible: FO | Computable Name: Obligation2Definition |
Obligation 2 Definition Description:
is to be placed before the actor - profile 0..* <- 1 obligation 1..* <- 1 actor
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Obligation2Definition Instances of this logical model can be the target of a Reference | |
![]() ![]() ![]() |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
![]() ![]() ![]() |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
![]() ![]() ![]() |
0..1 | string | Business version of the obligation | |
![]() ![]() ![]() |
0..1 | string | Short Name for this Obligation | |
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Date last changed | |
![]() ![]() ![]() |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
![]() ![]() ![]() |
0..* | Reference(Obligation2Definition) | Other obligations that are implicitly to be included | |
![]() ![]() ![]() |
0..* | BackboneElement | set of obligations | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
![]() |
Path | Conformance | ValueSet | URI |
Base.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
Base.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verb from this IG | |
Base.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlone from this IG | |
Base.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectation from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Obligation2Definition Instances of this logical model can be the target of a Reference | |
![]() ![]() ![]() |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
![]() ![]() ![]() |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
![]() ![]() ![]() |
0..1 | string | Business version of the obligation | |
![]() ![]() ![]() |
0..1 | string | Short Name for this Obligation | |
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Date last changed | |
![]() ![]() ![]() |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
![]() ![]() ![]() |
0..* | Reference(Obligation2Definition) | Other obligations that are implicitly to be included | |
![]() ![]() ![]() |
0..* | BackboneElement | set of obligations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
![]() |
Path | Conformance | ValueSet | URI |
Base.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
Base.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verb from this IG | |
Base.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlone from this IG | |
Base.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectation from 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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Obligation2Definition Instances of this logical model can be the target of a Reference | |
![]() ![]() ![]() |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
![]() ![]() ![]() |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
![]() ![]() ![]() |
0..1 | string | Business version of the obligation | |
![]() ![]() ![]() |
0..1 | string | Short Name for this Obligation | |
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Date last changed | |
![]() ![]() ![]() |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
![]() ![]() ![]() |
0..* | Reference(Obligation2Definition) | Other obligations that are implicitly to be included | |
![]() ![]() ![]() |
0..* | BackboneElement | set of obligations | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
![]() |
Path | Conformance | ValueSet | URI |
Base.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
Base.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verb from this IG | |
Base.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlone from this IG | |
Base.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectation from 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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Obligation2Definition Instances of this logical model can be the target of a Reference | |
![]() ![]() ![]() |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
![]() ![]() ![]() |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
![]() ![]() ![]() |
0..1 | string | Business version of the obligation | |
![]() ![]() ![]() |
0..1 | string | Short Name for this Obligation | |
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Date last changed | |
![]() ![]() ![]() |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
![]() ![]() ![]() |
0..* | Reference(Obligation2Definition) | Other obligations that are implicitly to be included | |
![]() ![]() ![]() |
0..* | BackboneElement | set of obligations | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
![]() |
Path | Conformance | ValueSet | URI |
Base.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
Base.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verb from this IG | |
Base.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlone from this IG | |
Base.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectation from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Obligation2Definition Instances of this logical model can be the target of a Reference | |
![]() ![]() ![]() |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
![]() ![]() ![]() |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
![]() ![]() ![]() |
0..1 | string | Business version of the obligation | |
![]() ![]() ![]() |
0..1 | string | Short Name for this Obligation | |
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Date last changed | |
![]() ![]() ![]() |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
![]() ![]() ![]() |
0..* | Reference(Obligation2Definition) | Other obligations that are implicitly to be included | |
![]() ![]() ![]() |
0..* | BackboneElement | set of obligations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
![]() |
Path | Conformance | ValueSet | URI |
Base.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
Base.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verb from this IG | |
Base.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlone from this IG | |
Base.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectation from 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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Obligation2Definition Instances of this logical model can be the target of a Reference | |
![]() ![]() ![]() |
0..1 | uri | Canonical identifier for this obligation, represented as a URI (globally unique) | |
![]() ![]() ![]() |
0..* | Identifier | Additional identifier for the obligation (business identifier) | |
![]() ![]() ![]() |
0..1 | string | Business version of the obligation | |
![]() ![]() ![]() |
0..1 | string | Short Name for this Obligation | |
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) | |
![]() ![]() ![]() |
0..1 | dateTime | Date last changed | |
![]() ![]() ![]() |
0..1 | markdown | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() |
0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() |
0..* | Reference(StructureDefinition) | Profile element(s) to whom this obligation applies to | |
![]() ![]() ![]() |
0..* | Reference(Obligation2Definition) | Other obligations that are implicitly to be included | |
![]() ![]() ![]() |
0..* | BackboneElement | set of obligations | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) | |
![]() |
Path | Conformance | ValueSet | URI |
Base.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
Base.activity.verb | required | VsVerb (a valid code from Verb Codes)http://v2.hl7.org/fhir/ValueSet/verb from this IG | |
Base.activity.obligation | extensible | VsObligationAloneCodes (a valid code from Obligation Alone Codes)http://v2.hl7.org/fhir/ValueSet/obligationAlone from this IG | |
Base.activity.dataExpectation | required | VsDataExepectation (a valid code from Data Expectation Codes)http://v2.hl7.org/fhir/ValueSet/dataExpectation from 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