Generated Narrative: StructureDefinition obligation Name Flags Card. Type Description & Constraints <a href="StructureDefinition-obligation-definitions.html#Extension" title="When appearing on an element, documents obligations that apply to applications implementing that element. When appearing at the root of a StructureDefinition, indicates obligations that apply to all listed elements within the extension. When appearing on a type, indicates obligations that apply to the use of that specific type. 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.">Extension 0..* Extension Obligations for applications using element/in model #xD; Slices for extension Content/Rules for all slices #xD; extension:name 0..1 Extension Short label for collection of obligations #xD; extension 0..0 Extension #xD; url 1..1 uri "name" #xD; value[x] 1..1 string Value of extension #xD; extension:code 1..* Extension Composite code describing the nature of the obligation #xD; extension 0..0 Extension #xD; url 1..1 uri "code" #xD; value[x] 1..1 code Value of extension Binding: ObligationCodesVS (required): Codes that describe an obligation that applies to implementing applications #xD; extension:elementId 0..* Extension When the obligation is on the profile itself, not a particular element, a list of elements to which it applies #xD; extension 0..0 Extension #xD; url 1..1 uri "elementId" #xD; value[x] 1..1 string Value of extension #xD; extension:actor 0..* Extension Actor(s) this obligation applies to (all actors if none) #xD; extension 0..0 Extension #xD; url 1..1 uri "actor" #xD; value[x] 1..1 canonical(ActorDefinition) Value of extension #xD; extension:documentation 0..1 Extension Documentation of the purpose or application of the obligation #xD; extension 0..0 Extension #xD; url 1..1 uri "documentation" #xD; value[x] 1..1 markdown Value of extension #xD; <a href="StructureDefinition-obligation-definitions.html#Extension.extension:usage" title="Slice usage: 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. An expected use: limiting obligations to particular jurisdictions (e.g. in IPS).">extension:usage 0..* Extension Qualifies the usage - jurisdiction, gender, workflow status etc #xD; extension 0..0 Extension #xD; url 1..1 uri "usage" #xD; value[x] 1..1 UsageContext Value of extension #xD; extension:filter 0..1 Extension Limits obligation to some repeats by FHIRPath #xD; extension 0..0 Extension #xD; url 1..1 uri "filter" #xD; value[x] 1..1 string Value of extension #xD; extension:filterDocumentation 0..1 Extension Describes the intent of the filter (short) #xD; extension 0..0 Extension #xD; url 1..1 uri "filterDocumentation" #xD; value[x] 1..1 string Value of extension #xD; <a href="StructureDefinition-obligation-definitions.html#Extension.extension:applicable-number" title="Slice applicable-number: If present, limits the obligation to the specified number of repetitions. I.e. systems are not obligated to store/display/capture/whatever ALL possible repetitions of the element, but only the specified number. If more repetitions exist than the specified number and the system opts not to support them all, it's up to the systems which repetitions it chooses to support. Note that the applicable-number applies after any reduction in elements from applying the Obligation.filter">extension:applicable-number 0..1 Extension # of repetitions obligation applies to #xD; extension 0..0 Extension #xD; url 1..1 uri "applicable-number" #xD; value[x] 1..1 positiveInt Value of extension #xD; extension:process 0..* Extension The obligation only applies when performing the indicated process #xD; extension 0..0 Extension #xD; url 1..1 uri "process" #xD; value[x] 1..1 Value of extension #xD; valueCanonical canonical(OperationDefinition) #xD; valueUri uri #xD; url 1..1 uri "http://hl7.org/fhir/StructureDefinition/obligation" #xD; value[x] 0..0 Value of extension #xD; Documentation for this format
When appearing on an element, documents obligations that apply to applications implementing that element. When appearing at the root of a StructureDefinition, indicates obligations that apply to all listed elements within the extension. When appearing on a type, indicates obligations that apply to the use of that specific type. The obligations relate to application behaviour, not the content of the element itself in the resource instances that contain this element. See the [Obligation](obligations.html) page in the core specification for further detail.
Obligations for applications using element/in model
When appearing on an element, documents obligations that apply to applications implementing that element. When appearing at the root of a StructureDefinition, indicates obligations that apply to all listed elements within the extension. When appearing on a type, indicates obligations that apply to the use of that specific type. 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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
Short label for collection of obligations
A short label for the set of obligations that is unique within the element defining the obligation set that can be used to point to that set.
In a derived profile, if no name is present or the name doesn't correspond to an obligation name found on that element in the base profile, the obligations will be considered additions to rather than replacements of the existing obligations
Used for rendering collection sets, as well as when deriving profiles to distinguish whether a new obligation set is being defined or an existing one is being updated.
Source of the definition for the extension code - a logical name or a URL.
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.
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).
Composite code describing the nature of the obligation
A code that describes the obligation(s) that apply to implementing applications.
The code must be a 'selectable' code. If multiple codes are specified, all obligations apply to the associated element(s). When multiple codes are selected, they SHOULD NOT include (directly or by inheritance) a code that is a converse obligation and SHALL NOT include codes that are converses where the strength of both codes is SHALL.
Codes that describe an obligation that applies to implementing applications
When the obligation is on the profile itself, not a particular element, a list of elements to which it applies
Actor(s) this obligation applies to (all actors if none)
Actor(s) to which the obligation applies.
If no actors are specified, then the obligation applies to all implementations. (This should be done with caution as it may limit reuseability of the profile.)
Documentation of the purpose or application of the obligation
Human readable documentation of the purpose or application of the obligation.
Qualifies the usage - jurisdiction, gender, workflow status etc
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. An expected use: limiting obligations to particular jurisdictions (e.g. in IPS).
Limits obligation to some repeats by FHIRPath
A FHIRPath expression that restricts to the obligation to only those occurrences of the element that fall into the collection defined by the expression.
For example, this might be used to indicate obligations that apply to home phone numbers and not to other contact points.
Describes the intent of the filter (short)
Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.
If present, limits the obligation to the specified number of repetitions. I.e. systems are not obligated to store/display/capture/whatever ALL possible repetitions of the element, but only the specified number. If more repetitions exist than the specified number and the system opts not to support them all, it's up to the systems which repetitions it chooses to support. Note that the applicable-number applies after any reduction in elements from applying the Obligation.filter
If this element is declared on a slicing element, the applicable-number applies across all slices, not to each individual slice. If this element is present on an obligation declared on a specific slice, then the applicable number applies for that particular slice.
The obligation only applies when performing the indicated process
A process that the obligation applies to. This might a canonical URL for an OperationDefinition, or a uri that refers to some externally defined process such as a section within an IG.
If not specified, the implication is that the obligation applies to all repetitions