FHIR Extensions Pack
1.0.0 - Working Copy International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This is not an authorized publication; it is the continuous build for version 1.0.0). 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: Obligation (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/obligation Version: 1.0.0
Standards status: Draft Maturity Level: 1 Computable Name: Obligation

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 for further detail

Context of Use

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

  • Element ID Dosage

Usage info

Usage:

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

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: 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

  • code: Coding: A code that describes the obligations that apply to implementing applications.
  • actor: canonical: Actor(s) to which the obligation applies.
  • documentation: markdown: Human readable documentation of the purpose or application of the obligation.
  • usage: UsageContext: Qualifies the usage of the obligation. Typically obligations are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.
  • filter: string: A FHIRPath expression that restricts to the obligation to one of a set of repeats.
  • filterDocumentation: string: Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.
  • process: uri: A process that the obligation applies to. This might a canonical URL for an OperationDefiniti on, or some other reference.

Maturity: 1

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionDocuments obligations for applications making use of this element
... extension:code 1..*ExtensionComposite code describing the nature of the obligation
.... url 1..1uri"code"
.... value[x] 1..1CodingValue of extension
Binding: ObligationCodesVS (extensible)
... extension:actor 0..*ExtensionActor(s) this obligation applies to (all actors if none)
.... url 1..1uri"actor"
.... value[x] 1..1canonical(ActorDefinition)Value of extension
... extension:documentation 0..1ExtensionDocumentation of the purpose or application of the obligation
.... url 1..1uri"documentation"
.... value[x] 1..1markdownValue of extension
.... url 1..1uri"usage"
.... value[x] 1..1UsageContextValue of extension
... extension:filter 0..1ExtensionLimits obligation to some repeats by FHIRPath
.... url 1..1uri"filter"
.... value[x] 1..1stringValue of extension
... extension:filterDocumentation 0..1ExtensionDdescribes the intent of the filter (short)
.... url 1..1uri"filterDocumentation"
.... value[x] 1..1stringValue of extension
... extension:process 0..*ExtensionThe obligation only applies when perfomring the indicated process
.... url 1..1uri"process"
.... value[x] 1..1uriValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/obligation"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionDocuments obligations for applications making use of this element
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:code 1..*ExtensionComposite code describing the nature of the obligation
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"code"
.... value[x] 1..1CodingValue of extension
Binding: ObligationCodesVS (extensible)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"actor"
.... value[x] 1..1canonical(ActorDefinition)Value of extension
... extension:documentation 0..1ExtensionDocumentation of the purpose or application of the obligation
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"documentation"
.... value[x] 1..1markdownValue of extension
... extension:usage 0..*ExtensionQualifies the usage - jurisdiction, gender, workflow status etc
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"usage"
.... value[x] 1..1UsageContextValue of extension
... extension:filter 0..1ExtensionLimits obligation to some repeats by FHIRPath
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"filter"
.... value[x] 1..1stringValue of extension
... extension:filterDocumentation 0..1ExtensionDdescribes the intent of the filter (short)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"filterDocumentation"
.... value[x] 1..1stringValue of extension
... extension:process 0..*ExtensionThe obligation only applies when perfomring the indicated process
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"process"
.... value[x] 1..1uriValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/obligation"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: 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

  • code: Coding: A code that describes the obligations that apply to implementing applications.
  • actor: canonical: Actor(s) to which the obligation applies.
  • documentation: markdown: Human readable documentation of the purpose or application of the obligation.
  • usage: UsageContext: Qualifies the usage of the obligation. Typically obligations are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.
  • filter: string: A FHIRPath expression that restricts to the obligation to one of a set of repeats.
  • filterDocumentation: string: Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.
  • process: uri: A process that the obligation applies to. This might a canonical URL for an OperationDefiniti on, or some other reference.

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionDocuments obligations for applications making use of this element
... extension:code 1..*ExtensionComposite code describing the nature of the obligation
.... url 1..1uri"code"
.... value[x] 1..1CodingValue of extension
Binding: ObligationCodesVS (extensible)
... extension:actor 0..*ExtensionActor(s) this obligation applies to (all actors if none)
.... url 1..1uri"actor"
.... value[x] 1..1canonical(ActorDefinition)Value of extension
... extension:documentation 0..1ExtensionDocumentation of the purpose or application of the obligation
.... url 1..1uri"documentation"
.... value[x] 1..1markdownValue of extension
.... url 1..1uri"usage"
.... value[x] 1..1UsageContextValue of extension
... extension:filter 0..1ExtensionLimits obligation to some repeats by FHIRPath
.... url 1..1uri"filter"
.... value[x] 1..1stringValue of extension
... extension:filterDocumentation 0..1ExtensionDdescribes the intent of the filter (short)
.... url 1..1uri"filterDocumentation"
.... value[x] 1..1stringValue of extension
... extension:process 0..*ExtensionThe obligation only applies when perfomring the indicated process
.... url 1..1uri"process"
.... value[x] 1..1uriValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/obligation"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionDocuments obligations for applications making use of this element
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:code 1..*ExtensionComposite code describing the nature of the obligation
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"code"
.... value[x] 1..1CodingValue of extension
Binding: ObligationCodesVS (extensible)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"actor"
.... value[x] 1..1canonical(ActorDefinition)Value of extension
... extension:documentation 0..1ExtensionDocumentation of the purpose or application of the obligation
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"documentation"
.... value[x] 1..1markdownValue of extension
... extension:usage 0..*ExtensionQualifies the usage - jurisdiction, gender, workflow status etc
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"usage"
.... value[x] 1..1UsageContextValue of extension
... extension:filter 0..1ExtensionLimits obligation to some repeats by FHIRPath
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"filter"
.... value[x] 1..1stringValue of extension
... extension:filterDocumentation 0..1ExtensionDdescribes the intent of the filter (short)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"filterDocumentation"
.... value[x] 1..1stringValue of extension
... extension:process 0..*ExtensionThe obligation only applies when perfomring the indicated process
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"process"
.... value[x] 1..1uriValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/obligation"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:code.value[x]extensibleObligationCodesVS (a valid code from Obligation Codes)

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)