Obligation1Definition
type: StructureDefinition
node role: treeRoot
id:
  v: Obligation1Definition
meta:
  last updated:
    v: 2023-08-09T18:09:04.256+02:00
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition Obligation1Definition Last updated: 2023-08-09 18:09:04+0200 Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Obligation 0..* Base Obligation1Definition Instances of this logical model can be the target of a Reference #xD; url 0..1 uri Canonical identifier for this obligation, represented as a URI (globally unique) #xD; identifier 0..* Identifier Additional identifier for the obligation (business identifier) #xD; version 0..1 string Business version of the obligation #xD; name 0..1 string Short Name for this Obligation #xD; status 1..1 code draft | active | retired | unknown Binding: PublicationStatus (required) #xD; date 0..1 dateTime Date last changed #xD; documentation 0..1 markdown Documentation of the purpose or application of the obligation #xD; usage 0..* UsageContext Qualifies the usage - jurisdiction, gender, workflow status etc #xD; actor 0..* Reference(DomainResource) Actor(s) to whom this obligation applies to (if any) #xD; element 0..* Reference(StructureDefinition) Profile element(s) to whom this obligation applies to #xD; including 0..* Reference(Obligation1Definition) Other obligations that are implicitly to be included #xD; activity 0..* BackboneElement set of obligations #xD; verb 0..1 Coding Composite code describing the requirement level of the obligation Binding: Verb ValueSet (required) #xD; obligation 0..1 Coding Composite code describing the activity/obligation to performed by the application Binding: Obligation Alone ValueSet (extensible) #xD; dataExpectation 0..1 Coding Composite code describing the expacation about data appearance Binding: Data Expectation ValueSet (required) #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
    l: logical-target
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: inm
url:
  v: http://v2.hl7.org/fhir/StructureDefinition/Obligation1Definition
  l: Obligation1Definition
version:
  v: 0.1.0
name:
  v: Obligation1Definition
title:
  v: Obligation1Definition
status:
  v: draft
experimental:
  v: true
date:
  v: 2023-10-10T18:09:04+02:00
description:
  v: Obligation 1 Definition Description: is to be placed behind the actor: profile 0..* <- 1 actor 0..* <-> 0..* obligation
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://v2.hl7.org/fhir/Obligation
  l: Obligation
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  l: Base
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 5.0.0
  element:
    id:
      v: Obligation
    path:
      v: Obligation
    short:
      v: Obligation1Definition
    definition:
      v: Obligation 1 Definition Resource
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Obligation.url
    path:
      v: Obligation.url
    short:
      v: Canonical identifier for this obligation, represented as a URI (globally unique)
    definition:
      v: Canonical identifier for this obligation, represented as a URI (globally unique)
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Obligation.url
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: uri
        l: uri
  element:
    id:
      v: Obligation.identifier
    path:
      v: Obligation.identifier
    short:
      v: Additional identifier for the obligation (business identifier)
    definition:
      v: Additional identifier for the obligation (business identifier)
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Obligation.identifier
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Identifier
        l: Identifier
  element:
    id:
      v: Obligation.version
    path:
      v: Obligation.version
    short:
      v: Business version of the obligation
    definition:
      v: Business version of the obligation
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Obligation.version
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: Obligation.name
    path:
      v: Obligation.name
    short:
      v: Short Name for this Obligation
    definition:
      v: Name for this obligation definition (computer friendly)
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Obligation.name
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: Obligation.status
    path:
      v: Obligation.status
    short:
      v: draft | active | retired | unknown
    definition:
      v: draft | active | retired | unknown

v: 1

v: 1

path:
  v: Obligation.status
min:
  v: 1
max:
  v: 1

code:
  v: code
  l: code

strength:
  v: required
value set:
  v: http://hl7.org/fhir/ValueSet/publication-status
  l: publication-status

id:
  v: Obligation.date
path:
  v: Obligation.date
short:
  v: Date last changed
definition:
  v: Date last changed
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Obligation.date
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime

id:
  v: Obligation.documentation
path:
  v: Obligation.documentation
short:
  v: Documentation of the purpose or application of the obligation
definition:
  v: Documentation of the purpose or application of the obligation
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Obligation.documentation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: markdown
    l: markdown

id:
  v: Obligation.usage
path:
  v: Obligation.usage
short:
  v: Qualifies the usage - jurisdiction, gender, workflow status etc
definition:
  v: Qualifies the usage - jurisdiction, gender, workflow status etc
min:
  v: 0
max:
  v: *
base:
  path:
    v: Obligation.usage
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: UsageContext
    l: UsageContext

id:
  v: Obligation.actor
path:
  v: Obligation.actor
short:
  v: Actor(s) to whom this obligation applies to (if any)
definition:
  v: Actor(s) to whom this obligation applies to (if any)
min:
  v: 0
max:
  v: *
base:
  path:
    v: Obligation.actor
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DomainResource
    l: DomainResource

id:
  v: Obligation.element
path:
  v: Obligation.element
short:
  v: Profile element(s) to whom this obligation applies to
definition:
  v: Profile element(s) to whom this obligation applies to
min:
  v: 0
max:
  v: *
base:
  path:
    v: Obligation.element
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/StructureDefinition
    l: StructureDefinition

id:
  v: Obligation.including
path:
  v: Obligation.including
short:
  v: Other obligations that are implicitly to be included
definition:
  v: Other obligations that are implicitly to be included
min:
  v: 0
max:
  v: *
base:
  path:
    v: Obligation.including
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://v2.hl7.org/fhir/StructureDefinition/Obligation1Definition
    l: Obligation1Definition

id:
  v: Obligation.activity
path:
  v: Obligation.activity
short:
  v: set of obligations
definition:
  v: set of obligations
min:
  v: 0
max:
  v: *
base:
  path:
    v: Obligation.activity
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element

id:
  v: Obligation.activity.id
path:
  v: Obligation.activity.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Obligation.activity.extension
path:
  v: Obligation.activity.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Obligation.activity.modifierExtension
path:
  v: Obligation.activity.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Obligation.activity.verb
path:
  v: Obligation.activity.verb
short:
  v: Composite code describing the requirement level of the obligation
definition:
  v: Composite code describing the requirement level of the obligation
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Obligation.activity.verb
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://v2.hl7.org/fhir/ValueSet/verb
    l: verb

id:
  v: Obligation.activity.obligation
path:
  v: Obligation.activity.obligation
short:
  v: Composite code describing the activity/obligation to performed by the application
definition:
  v: Composite code describing the activity/obligation to performed by the application
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Obligation.activity.obligation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: extensible
  value set:
    v: http://v2.hl7.org/fhir/ValueSet/obligationAlone
    l: obligationAlone

id:
  v: Obligation.activity.dataExpectation
path:
  v: Obligation.activity.dataExpectation
short:
  v: Composite code describing the expacation about data appearance
definition:
  v: Composite code describing the expacation about data appearance
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Obligation.activity.dataExpectation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://v2.hl7.org/fhir/ValueSet/dataExpectation
    l: dataExpectation

element:
  id:
    v: Obligation
  path:
    v: Obligation
  short:
    v: Obligation1Definition
  definition:
    v: Obligation 1 Definition Resource
element:
  id:
    v: Obligation.url
  path:
    v: Obligation.url
  short:
    v: Canonical identifier for this obligation, represented as a URI (globally unique)
  definition:
    v: Canonical identifier for this obligation, represented as a URI (globally unique)
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: uri
      l: uri
element:
  id:
    v: Obligation.identifier
  path:
    v: Obligation.identifier
  short:
    v: Additional identifier for the obligation (business identifier)
  definition:
    v: Additional identifier for the obligation (business identifier)
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Identifier
      l: Identifier
element:
  id:
    v: Obligation.version
  path:
    v: Obligation.version
  short:
    v: Business version of the obligation
  definition:
    v: Business version of the obligation
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: Obligation.name
  path:
    v: Obligation.name
  short:
    v: Short Name for this Obligation
  definition:
    v: Name for this obligation definition (computer friendly)
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: Obligation.status
  path:
    v: Obligation.status
  short:
    v: draft | active | retired | unknown
  definition:
    v: draft | active | retired | unknown
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: code
      l: code
  binding:
    strength:
      v: required
    value set:
      v: http://hl7.org/fhir/ValueSet/publication-status
      l: publication-status
element:
  id:
    v: Obligation.date
  path:
    v: Obligation.date
  short:
    v: Date last changed
  definition:
    v: Date last changed
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
element:
  id:
    v: Obligation.documentation
  path:
    v: Obligation.documentation
  short:
    v: Documentation of the purpose or application of the obligation
  definition:
    v: Documentation of the purpose or application of the obligation
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: markdown
      l: markdown
element:
  id:
    v: Obligation.usage
  path:
    v: Obligation.usage
  short:
    v: Qualifies the usage - jurisdiction, gender, workflow status etc
  definition:
    v: Qualifies the usage - jurisdiction, gender, workflow status etc
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: UsageContext
      l: UsageContext
element:
  id:
    v: Obligation.actor
  path:
    v: Obligation.actor
  short:
    v: Actor(s) to whom this obligation applies to (if any)
  definition:
    v: Actor(s) to whom this obligation applies to (if any)
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/DomainResource
      l: DomainResource
element:
  id:
    v: Obligation.element
  path:
    v: Obligation.element
  short:
    v: Profile element(s) to whom this obligation applies to
  definition:
    v: Profile element(s) to whom this obligation applies to
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/StructureDefinition
      l: StructureDefinition
element:
  id:
    v: Obligation.including
  path:
    v: Obligation.including
  short:
    v: Other obligations that are implicitly to be included
  definition:
    v: Other obligations that are implicitly to be included
  min:
    v: 0

v: *

code:
  v: Reference
  l: Reference
target profile:
  v: http://v2.hl7.org/fhir/StructureDefinition/Obligation1Definition
  l: Obligation1Definition

id:
  v: Obligation.activity
path:
  v: Obligation.activity
short:
  v: set of obligations
definition:
  v: set of obligations
min:
  v: 0
max:
  v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement

id:
  v: Obligation.activity.verb
path:
  v: Obligation.activity.verb
short:
  v: Composite code describing the requirement level of the obligation
definition:
  v: Composite code describing the requirement level of the obligation
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://v2.hl7.org/fhir/ValueSet/verb
    l: verb

id:
  v: Obligation.activity.obligation
path:
  v: Obligation.activity.obligation
short:
  v: Composite code describing the activity/obligation to performed by the application
definition:
  v: Composite code describing the activity/obligation to performed by the application
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: extensible
  value set:
    v: http://v2.hl7.org/fhir/ValueSet/obligationAlone
    l: obligationAlone

id:
  v: Obligation.activity.dataExpectation
path:
  v: Obligation.activity.dataExpectation
short:
  v: Composite code describing the expacation about data appearance
definition:
  v: Composite code describing the expacation about data appearance
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://v2.hl7.org/fhir/ValueSet/dataExpectation
    l: dataExpectation