FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Obligations Profile (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/obligations-profile Version: 5.2.0-ballot
Standards status: Draft Maturity Level: 0 Computable Name: ObligationsProfile

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, 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 it pertains to the rules that apply to the application that authored the resource. For the same reason, intermediaries processing resources SHOULD preserve this declaration unless they alter the data itself.

This declaration is often used to drive processing rules associated with the trustworthiness of the data in the resource. Applications/specifications/workflows that make use of this declaration should carefully consider the integrity of the chain of handling from the source the processing before choosing to trust the declaration.

A simpler alternative to this profile is to use the [[[http://hl7.org/fhir/StructureDefinition/feature-assertion]]] extension.

This is an experimental extension definition; the committee is seeking implementation feedback, and the definition or contents of the extension may change in future versions.

Context of Use

This extension may be used on the following element(s):

  • Element ID Provenance.target
  • Element ID Resource.meta

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: 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, 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 it pertains to the rules that apply to the application that authored the resource. For the same reason, intermediaries processing resources SHOULD preserve this declaration unless they alter the data itself. This declaration is often used to drive processing rules associated with the trustworthiness of the data in the resource. Applications/specifications/workflows that make use of this declaration should carefully consider the integrity of the chain of handling from the source the processing before choosing to trust the declaration. A simpler alternative to this profile is to use the http://hl7.org/fhir/StructureDefinition/feature-assertion extension.

    • profile: canonical: The profile that links the elements in the resource to the obligations that apply to the application.
    • actor: uri: If provided, restricts the obligations to those declared for this particular actor.

    Maturity: 0

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Authored by an application conforming to a set of obligations
    ... Slices for extension Content/Rules for all slices
    .... extension:profile 1..1 Extension The profile linking elements to obligations
    ..... extension 0..0
    ..... url 1..1 uri "profile"
    ..... value[x] 1..1 canonical(StructureDefinition) Value of extension
    .... extension:actor 0..1 Extension Indicates which actor obligations apply.
    ..... extension 0..0
    ..... url 1..1 uri "actor"
    ..... value[x] 1..1 uri Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/obligations-profile"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Authored by an application conforming to a set of obligations
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:profile 1..1 Extension The profile linking elements to obligations
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "profile"
    ..... value[x] 1..1 canonical(StructureDefinition) Value of extension
    .... extension:actor 0..1 Extension Indicates which actor obligations apply.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "actor"
    ..... value[x] 1..1 uri Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/obligations-profile"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: 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, 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 it pertains to the rules that apply to the application that authored the resource. For the same reason, intermediaries processing resources SHOULD preserve this declaration unless they alter the data itself. This declaration is often used to drive processing rules associated with the trustworthiness of the data in the resource. Applications/specifications/workflows that make use of this declaration should carefully consider the integrity of the chain of handling from the source the processing before choosing to trust the declaration. A simpler alternative to this profile is to use the http://hl7.org/fhir/StructureDefinition/feature-assertion extension.

    • profile: canonical: The profile that links the elements in the resource to the obligations that apply to the application.
    • actor: uri: If provided, restricts the obligations to those declared for this particular actor.

    Maturity: 0

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Authored by an application conforming to a set of obligations
    ... Slices for extension Content/Rules for all slices
    .... extension:profile 1..1 Extension The profile linking elements to obligations
    ..... extension 0..0
    ..... url 1..1 uri "profile"
    ..... value[x] 1..1 canonical(StructureDefinition) Value of extension
    .... extension:actor 0..1 Extension Indicates which actor obligations apply.
    ..... extension 0..0
    ..... url 1..1 uri "actor"
    ..... value[x] 1..1 uri Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/obligations-profile"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Authored by an application conforming to a set of obligations
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:profile 1..1 Extension The profile linking elements to obligations
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "profile"
    ..... value[x] 1..1 canonical(StructureDefinition) Value of extension
    .... extension:actor 0..1 Extension Indicates which actor obligations apply.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "actor"
    ..... value[x] 1..1 uri Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/obligations-profile"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)