description: 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.extensions.r3
derivation: constraint
name: Obligation
type: Extension
elements:
  extension:
    short: Composite code describing the nature of the obligation
    array: true
    min: 1
    index: 0
    slicing:
      slices:
        code:
          match: {}
          schema:
            short: Composite code describing the nature of the obligation
            array: true
            min: 1
            _required: true
            index: 0
            elements:
              url:
                pattern: {type: Uri, value: code}
                index: 1
              value:
                choices: [valueCoding]
                index: 3
              valueCoding: {type: Coding, choiceOf: value, index: 4}
            required: [valueCoding, value]
        actor:
          match: {}
          schema:
            short: Actor(s) this obligation applies to (all actors if none)
            array: true
            index: 5
            elements:
              url:
                pattern: {type: Uri, value: actor}
                index: 6
              value:
                choices: [valueCanonical]
                index: 8
              valueCanonical: {type: canonical, choiceOf: value, index: 9}
            required: [valueCanonical, value]
        documentation:
          match: {}
          schema:
            short: Documentation of the purpose or application of the obligation
            index: 10
            elements:
              url:
                pattern: {type: Uri, value: documentation}
                index: 11
              value:
                choices: [valueMarkdown]
                index: 13
              valueMarkdown: {type: markdown, choiceOf: value, index: 14}
            required: [valueMarkdown, value]
        usage:
          match: {}
          schema:
            short: Qualifies the usage - jurisdiction, gender, workflow status etc
            array: true
            index: 15
            elements:
              url:
                pattern: {type: Uri, value: usage}
                index: 16
              value:
                choices: [valueUsageContext]
                index: 18
              valueUsageContext: {type: UsageContext, choiceOf: value, index: 19}
            required: [value, valueUsageContext]
        filter:
          match: {}
          schema:
            short: Limits obligation to some repeats by FHIRPath
            index: 20
            elements:
              url:
                pattern: {type: Uri, value: filter}
                index: 21
              value:
                choices: [valueString]
                index: 23
              valueString: {type: string, choiceOf: value, index: 24}
            required: [valueString, value]
        filterDocumentation:
          match: {}
          schema:
            short: Ddescribes the intent of the filter (short)
            index: 25
            elements:
              url:
                pattern: {type: Uri, value: filterDocumentation}
                index: 26
              value:
                choices: [valueString]
                index: 28
              valueString: {type: string, choiceOf: value, index: 29}
            required: [valueString, value]
        process:
          match: {}
          schema:
            short: The obligation only applies when perfomring the indicated process
            array: true
            index: 30
            elements:
              url:
                pattern: {type: Uri, value: process}
                index: 31
              value:
                choices: [valueUri]
                index: 33
              valueUri: {type: uri, choiceOf: value, index: 34}
            required: [valueUri, value]
  url:
    pattern: {type: Uri, value: 'http://hl7.org/fhir/StructureDefinition/obligation'}
    index: 35
  value:
    choices: []
    index: 37
package_version: 1.0.0
extensions:
  code:
    url: null
    short: Composite code describing the nature of the obligation
    array: true
    min: 1
    _required: true
    index: 0
    elements:
      url:
        pattern: {type: Uri, value: code}
        index: 1
      value:
        choices: [valueCoding]
        index: 3
      valueCoding: {type: Coding, choiceOf: value, index: 4}
    required: [valueCoding, value]
  actor:
    url: null
    short: Actor(s) this obligation applies to (all actors if none)
    array: true
    index: 5
    elements:
      url:
        pattern: {type: Uri, value: actor}
        index: 6
      value:
        choices: [valueCanonical]
        index: 8
      valueCanonical: {type: canonical, choiceOf: value, index: 9}
    required: [valueCanonical, value]
  documentation:
    url: null
    short: Documentation of the purpose or application of the obligation
    index: 10
    elements:
      url:
        pattern: {type: Uri, value: documentation}
        index: 11
      value:
        choices: [valueMarkdown]
        index: 13
      valueMarkdown: {type: markdown, choiceOf: value, index: 14}
    required: [valueMarkdown, value]
  usage:
    url: null
    short: Qualifies the usage - jurisdiction, gender, workflow status etc
    array: true
    index: 15
    elements:
      url:
        pattern: {type: Uri, value: usage}
        index: 16
      value:
        choices: [valueUsageContext]
        index: 18
      valueUsageContext: {type: UsageContext, choiceOf: value, index: 19}
    required: [value, valueUsageContext]
  filter:
    url: null
    short: Limits obligation to some repeats by FHIRPath
    index: 20
    elements:
      url:
        pattern: {type: Uri, value: filter}
        index: 21
      value:
        choices: [valueString]
        index: 23
      valueString: {type: string, choiceOf: value, index: 24}
    required: [valueString, value]
  filterDocumentation:
    url: null
    short: Ddescribes the intent of the filter (short)
    index: 25
    elements:
      url:
        pattern: {type: Uri, value: filterDocumentation}
        index: 26
      value:
        choices: [valueString]
        index: 28
      valueString: {type: string, choiceOf: value, index: 29}
    required: [valueString, value]
  process:
    url: null
    short: The obligation only applies when perfomring the indicated process
    array: true
    index: 30
    elements:
      url:
        pattern: {type: Uri, value: process}
        index: 31
      value:
        choices: [valueUri]
        index: 33
      valueUri: {type: uri, choiceOf: value, index: 34}
    required: [valueUri, value]
class: extension
kind: complex-type
url: http://hl7.org/fhir/StructureDefinition/obligation
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 1.0.0
required: [extension]