obligations-profile
type: StructureDefinition
node role: treeRoot
id:
  v: obligations-profile
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition obligations-profile Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Extension 0..* Extension Authored by an application conforming to a set of obligations #xD; Slices for extension Content/Rules for all slices #xD; extension:profile 1..1 Extension The profile linking elements to obligations #xD; extension 0..0 Extension #xD; url 1..1 uri "profile" #xD; value[x] 1..1 canonical(StructureDefinition) Value of extension #xD; extension:actor 0..1 Extension Indicates which actor obligations apply. #xD; extension 0..0 Extension #xD; url 1..1 uri "actor" #xD; value[x] 1..1 uri Value of extension #xD; url 1..1 uri "http://hl7.org/fhir/StructureDefinition/obligations-profile" #xD; value[x] 0..0 Value of extension #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: fhir
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 0
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: draft
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics
    l: structuredefinition-type-characteristics
  value: Code
    v: can-bind
url:
  v: http://hl7.org/fhir/StructureDefinition/obligations-profile
  l: obligations-profile
version:
  v: 5.3.0
name:
  v: ObligationsProfile
title:
  v: Obligations Profile
status:
  v: draft
experimental:
  v: false
date:
  v: 2022-08-12
publisher:
  v: HL7 International / FHIR Infrastructure
contact:
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/fiwg
description:
  v: This extension declares that the data in a resource was authored (collected/handled/created/transformed) by an application that conformed to the set of element level obligations described in the referenced profile. Note that 'authoring' is often a client function, but that is not always the case. The declaration may optionally reference a particular ActorDefinition to select which set of obligations applied. Note that although the focus of this extension is declaring which obligations applied to the authoring of this resource, obligations are applied at the level of a data element, and the profile maps between the elements of the resource and the obligations at each data element. For this reason, it's better for profiles referenced by this extension to be [obligation profiles](https://hl7.org/fhir/tools/StructureDefinition-obligation-profile.html), or at least, profiles that focus on applicaion obligations rather than data verification. Only the obligations pertaining to authoring the data are considered to apply in this declaration. As an example of the kind of use this extension might support, an application could decide, while reading the contents of a resource, that an element was available for data entry and the fact that it is mising implies 'no value exists' as opposed to 'creating system was unable to provide a value'. This extension is a statement about the provenance of a particular version of the resource that it is describing; as such, it should be made in a Provenance resource referring to that particular version. Alternatively, the extension can be placed in the resource about which the declaration is made (in Resource.meta); in this case, the declaration SHOULD be removed when the resource data is altered (it may be replaced by a new declaration). Unlike the claim of data conformance in Resource.meta.profile, the declaration contained in this extension cannot be added simply because the data in the resource is observed to conform to a profile, since i…
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
context:
  type:
    v: element
  expression:
    v: Provenance.target
context:
  type:
    v: element
  expression:
    v: Resource.meta
type:
  v: Extension
  l: Extension
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  l: Extension
derivation:
  v: constraint
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: Extension
    path:
      v: Extension
    short:
      v: Authored by an application conforming to a set of obligations
    definition:
      v: A declaration that the data in a resource was authored by an application that conformed to the set of element level obligations described in the referenced profile
    comment:
      v: This extension is a statement about the provenance of a particular version of the resource that it is describing; as such, it should be made in a Provenance resource referring to that particular version. Alternatively, the extension can be placed in the resource about which the declaration is made (in Resource.meta); in this case, the declaration SHOULD be removed when the resource data is altered (it may be replaced by a new declaration).
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Extension
      min:
        v: 0
      max:
        v: *
    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
  element:
    id:
      v: Extension.id
    path:
      v: Extension.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:
        value: Url
      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
  element:
    id:
      v: Extension.extension
    path:
      v: Extension.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Additional content defined by implementations

Url
v: id
l: id

v: value

v: url

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.

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.

v: extensions

v: user content

v: 1

v: *

path:
  v: Element.extension
min:
  v: 0
max:
  v: *

code:
  v: Extension
  l: Extension

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

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

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: Extension.extension:profile
path:
  v: Extension.extension
slice name:
  v: profile
short:
  v: The profile linking elements to obligations
definition:
  v: The profile that links the elements in the resource to the obligations that apply to the application.
min:
  v: 1
max:
  v: 1
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

id:
  v: Extension.extension:profile.id
path:
  v: Extension.extension.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: Extension.extension:profile.extension
path:
  v: Extension.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
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

id:
  v: Extension.extension:profile.url
path:
  v: Extension.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: profile
  l: profile
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.extension:profile.value[x]
path:
  v: Extension.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: canonical
    l: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/StructureDefinition
    l: StructureDefinition
condition:
  v: ext-1
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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.extension:actor
path:
  v: Extension.extension
slice name:
  v: actor
short:
  v: Indicates which actor obligations apply.
definition:
  v: If provided, restricts the obligations to those declared for this particular actor.
comment:
  v: This is a reference to an ActorDefinition resource which was first defined in R5. In versions prior to R5, this is treated as a URI that identifies the actor but for which no formal declaration is available. In R5, this SHALL be treated as having the type canonical(ActorDefinition)
min:
  v: 0
max:
  v: 1
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

id:
  v: Extension.extension:actor.id
path:
  v: Extension.extension.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: Extension.extension:actor.extension
path:
  v: Extension.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
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

id:
  v: Extension.extension:actor.url
path:
  v: Extension.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: actor
  l: actor
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.extension:actor.value[x]
path:
  v: Extension.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
condition:
  v: ext-1
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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.url
path:
  v: Extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: uri
      l: uri
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/obligations-profile
  l: obligations-profile
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.value[x]
path:
  v: Extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
    l: base64Binary
type:
  code:
    v: boolean
    l: boolean
type:
  code:
    v: canonical
    l: canonical
type:
  code:
    v: code
    l: code
type:
  code:
    v: date
    l: date
type:
  code:
    v: dateTime
    l: dateTime
type:
  code:
    v: decimal
    l: decimal
type:
  code:
    v: id
    l: id
type:
  code:
    v: instant
    l: instant
type:
  code:
    v: integer
    l: integer
type:
  code:
    v: integer64
    l: integer64
type:
  code:
    v: markdown
    l: markdown
type:
  code:
    v: oid
    l: oid
type:
  code:
    v: positiveInt
    l: positiveInt
type:
  code:
    v: string
    l: string
type:
  code:
    v: time
    l: time
type:
  code:
    v: unsignedInt
    l: unsignedInt
type:
  code:
    v: uri
    l: uri
type:
  code:
    v: url
    l: url
type:
  code:
    v: uuid
    l: uuid
type:
  code:
    v: Address
    l: Address
type:
  code:
    v: Age
    l: Age
type:
  code:
    v: Annotation
    l: Annotation
type:
  code:
    v: Attachment
    l: Attachment
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
type:
  code:
    v: CodeableReference
    l: CodeableReference
type:
  code:
    v: Coding
    l: Coding
type:
  code:
    v: ContactPoint
    l: ContactPoint
type:
  code:
    v: Count
    l: Count
type:
  code:
    v: Distance
    l: Distance
type:
  code:
    v: Duration
    l: Duration
type:
  code:
    v: HumanName
    l: HumanName
type:
  code:
    v: Identifier
    l: Identifier
type:
  code:
    v: Money
    l: Money
type:
  code:
    v: Period
    l: Period
type:
  code:
    v: Quantity
    l: Quantity
type:
  code:
    v: Range
    l: Range
type:
  code:
    v: Ratio
    l: Ratio
type:
  code:
    v: RatioRange
    l: RatioRange
type:
  code:
    v: Reference
    l: Reference
type:
  code:
    v: SampledData
    l: SampledData
type:
  code:
    v: Signature
    l: Signature
type:
  code:
    v: Timing
    l: Timing
type:
  code:
    v: ContactDetail
    l: ContactDetail
type:
  code:
    v: DataRequirement
    l: DataRequirement
type:
  code:
    v: Expression
    l: Expression

code:
  v: ParameterDefinition
  l: ParameterDefinition

code:
  v: RelatedArtifact
  l: RelatedArtifact

code:
  v: TriggerDefinition
  l: TriggerDefinition

code:
  v: UsageContext
  l: UsageContext

code:
  v: Availability
  l: Availability

code:
  v: ExtendedContactDetail
  l: ExtendedContactDetail

code:
  v: Dosage
  l: Dosage

code:
  v: Meta
  l: Meta

v: ext-1

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

v: false

v: false

identity:
  v: rim
map:
  v: N/A

element:
  id:
    v: Extension
  path:
    v: Extension
  short:
    v: Authored by an application conforming to a set of obligations
  definition:
    v: A declaration that the data in a resource was authored by an application that conformed to the set of element level obligations described in the referenced profile
  comment:
    v: This extension is a statement about the provenance of a particular version of the resource that it is describing; as such, it should be made in a Provenance resource referring to that particular version. Alternatively, the extension can be placed in the resource about which the declaration is made (in Resource.meta); in this case, the declaration SHOULD be removed when the resource data is altered (it may be replaced by a new declaration).
  min:
    v: 0
  max:
    v: *
  is modifier:
    v: false
element:
  id:
    v: Extension.extension:profile
  path:
    v: Extension.extension
  slice name:
    v: profile
  short:
    v: The profile linking elements to obligations
  definition:
    v: The profile that links the elements in the resource to the obligations that apply to the application.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
  is modifier:
    v: false
element:
  id:
    v: Extension.extension:profile.extension
  path:
    v: Extension.extension.extension
  max:
    v: 0
element:
  id:
    v: Extension.extension:profile.url
  path:
    v: Extension.extension.url
  type:
    code:
      v: uri
      l: uri
  fixed: Uri
    v: profile
    l: profile
element:
  id:
    v: Extension.extension:profile.value[x]
  path:
    v: Extension.extension.value[x]
  min:
    v: 1
  type:
    code:
      v: canonical
      l: canonical
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/StructureDefinition
      l: StructureDefinition
element:
  id:
    v: Extension.extension:actor
  path:
    v: Extension.extension
  slice name:
    v: actor
  short:
    v: Indicates which actor obligations apply.
  definition:
    v: If provided, restricts the obligations to those declared for this particular actor.
  comment:
    v: This is a reference to an ActorDefinition resource which was first defined in R5. In versions prior to R5, this is treated as a URI that identifies the actor but for which no formal declaration is available. In R5, this SHALL be treated as having the type canonical(ActorDefinition)
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
  is modifier:
    v: false
element:
  id:
    v: Extension.extension:actor.extension
  path:
    v: Extension.extension.extension
  max:
    v: 0
element:
  id:
    v: Extension.extension:actor.url
  path:
    v: Extension.extension.url
  type:
    code:
      v: uri
      l: uri
  fixed: Uri
    v: actor
    l: actor
element:
  id:
    v: Extension.extension:actor.value[x]
  path:
    v: Extension.extension.value[x]
  min:
    v: 1
  type:
    code:
      v: uri
      l: uri
element:
  id:
    v: Extension.url
  path:
    v: Extension.url
  fixed: Uri
    v: http://hl7.org/fhir/StructureDefinition/obligations-profile
    l: obligations-profile
element:
  id:
    v: Extension.value[x]
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 0