description: This definition is deprecated in favor of the same extension in the core extensions pack. Documents obligations that apply to applications implementing this element. The obligations relate to application behaviour, not the content of the element itself in the resource instances that contain this element. See [Obligation Extension](obligations.html) for further detail.
package_name: hl7.fhir.uv.tools
derivation: constraint
name: Obligation
type: Extension
elements:
  extension:
    short: Composite code describing the nature of the obligation
    index: 0
    slicing:
      slices:
        code:
          match: {}
          schema:
            short: Composite code describing the nature of the obligation
            _required: true
            index: 0
            extensions: {}
            elements:
              extension: {index: 1}
              url:
                pattern: {type: Uri, value: code}
                index: 2
              value:
                choices: [valueCode]
                index: 4
              valueCode: {type: code, choiceOf: value, index: 5}
            required: [valueCode, value]
        elementId:
          match: {}
          schema:
            type: Extension
            short: When the obligation is on the profile itself, not a particular element, a list of elements to which it applies
            array: true
            index: 6
            extensions: {}
            elements:
              extension: {index: 7}
              url:
                pattern: {type: Uri, value: elementId}
                index: 8
              value:
                choices: [valueString]
                index: 10
              valueString: {type: string, choiceOf: value, index: 11}
            required: [valueString, value]
        actor:
          match: {}
          schema:
            short: Actor(s) this obligation applies to (all actors if none)
            array: true
            index: 12
            extensions: {}
            elements:
              extension: {index: 13}
              url:
                pattern: {type: Uri, value: actor}
                index: 14
              value:
                choices: [valueCanonical]
                index: 16
              valueCanonical: {type: canonical, choiceOf: value, index: 17}
            required: [valueCanonical, value]
        documentation:
          match: {}
          schema:
            short: Documentation of the purpose or application of the obligation
            index: 18
            extensions: {}
            elements:
              extension: {index: 19}
              url:
                type: uri
                pattern: {type: Uri, value: documentation}
                index: 20
              value:
                choices: [valueMarkdown]
                index: 22
              valueMarkdown: {type: markdown, choiceOf: value, index: 23}
            required: [valueMarkdown, value]
        usage:
          match: {}
          schema:
            short: Qualifies the usage - jurisdiction, gender, workflow status etc
            array: true
            index: 24
            extensions: {}
            elements:
              extension: {index: 25}
              url:
                pattern: {type: Uri, value: usage}
                index: 26
              value:
                choices: [valueUsageContext]
                index: 28
              valueUsageContext: {type: UsageContext, choiceOf: value, index: 29}
            required: [value, valueUsageContext]
        filter:
          match: {}
          schema:
            short: Limits obligation to some repeats by FHIRPath
            index: 30
            extensions: {}
            elements:
              extension: {index: 31}
              url:
                pattern: {type: Uri, value: filter}
                index: 32
              value:
                choices: [valueString]
                index: 34
              valueString: {type: string, choiceOf: value, index: 35}
            required: [valueString, value]
        filterDocumentation:
          match: {}
          schema:
            short: Ddescribes the intent of the filter (short)
            index: 36
            extensions: {}
            elements:
              extension: {index: 37}
              url:
                pattern: {type: Uri, value: filterDocumentation}
                index: 38
              value:
                choices: [valueString]
                index: 40
              valueString: {type: string, choiceOf: value, index: 41}
            required: [valueString, value]
        process:
          match: {}
          schema:
            short: The obligation only applies when performing the indicated process
            array: true
            index: 42
            extensions: {}
            elements:
              extension: {index: 43}
              url:
                pattern: {type: Uri, value: process}
                index: 44
              value:
                choices: [valueCode]
                index: 46
              valueCode: {type: code, choiceOf: value, index: 47}
            required: [valueCode, value]
  url:
    pattern: {type: Uri, value: 'http://hl7.org/fhir/tools/StructureDefinition/obligation'}
    index: 48
  value:
    choices: []
    index: 50
package_version: 0.1.0
extensions:
  code:
    url: null
    short: Composite code describing the nature of the obligation
    _required: true
    index: 0
    extensions: {}
    elements:
      extension: {index: 1}
      url:
        pattern: {type: Uri, value: code}
        index: 2
      value:
        choices: [valueCode]
        index: 4
      valueCode: {type: code, choiceOf: value, index: 5}
    required: [valueCode, value]
  elementId:
    url: null
    type: Extension
    short: When the obligation is on the profile itself, not a particular element, a list of elements to which it applies
    array: true
    index: 6
    extensions: {}
    elements:
      extension: {index: 7}
      url:
        pattern: {type: Uri, value: elementId}
        index: 8
      value:
        choices: [valueString]
        index: 10
      valueString: {type: string, choiceOf: value, index: 11}
    required: [valueString, value]
  actor:
    url: null
    short: Actor(s) this obligation applies to (all actors if none)
    array: true
    index: 12
    extensions: {}
    elements:
      extension: {index: 13}
      url:
        pattern: {type: Uri, value: actor}
        index: 14
      value:
        choices: [valueCanonical]
        index: 16
      valueCanonical: {type: canonical, choiceOf: value, index: 17}
    required: [valueCanonical, value]
  documentation:
    url: null
    short: Documentation of the purpose or application of the obligation
    index: 18
    extensions: {}
    elements:
      extension: {index: 19}
      url:
        type: uri
        pattern: {type: Uri, value: documentation}
        index: 20
      value:
        choices: [valueMarkdown]
        index: 22
      valueMarkdown: {type: markdown, choiceOf: value, index: 23}
    required: [valueMarkdown, value]
  usage:
    url: null
    short: Qualifies the usage - jurisdiction, gender, workflow status etc
    array: true
    index: 24
    extensions: {}
    elements:
      extension: {index: 25}
      url:
        pattern: {type: Uri, value: usage}
        index: 26
      value:
        choices: [valueUsageContext]
        index: 28
      valueUsageContext: {type: UsageContext, choiceOf: value, index: 29}
    required: [value, valueUsageContext]
  filter:
    url: null
    short: Limits obligation to some repeats by FHIRPath
    index: 30
    extensions: {}
    elements:
      extension: {index: 31}
      url:
        pattern: {type: Uri, value: filter}
        index: 32
      value:
        choices: [valueString]
        index: 34
      valueString: {type: string, choiceOf: value, index: 35}
    required: [valueString, value]
  filterDocumentation:
    url: null
    short: Ddescribes the intent of the filter (short)
    index: 36
    extensions: {}
    elements:
      extension: {index: 37}
      url:
        pattern: {type: Uri, value: filterDocumentation}
        index: 38
      value:
        choices: [valueString]
        index: 40
      valueString: {type: string, choiceOf: value, index: 41}
    required: [valueString, value]
  process:
    url: null
    short: The obligation only applies when performing the indicated process
    array: true
    index: 42
    extensions: {}
    elements:
      extension: {index: 43}
      url:
        pattern: {type: Uri, value: process}
        index: 44
      value:
        choices: [valueCode]
        index: 46
      valueCode: {type: code, choiceOf: value, index: 47}
    required: [valueCode, value]
class: extension
kind: complex-type
url: http://hl7.org/fhir/tools/StructureDefinition/obligation
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 0.1.0
required: [extension]