FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.3.0 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
| Official URL: http://hl7.org/fhir/StructureDefinition/obligation | Version: 5.3.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: Obligation | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.5.1531 | ||||
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.
Context of Use
This extension may be used on the following element(s)
ElementDefinition
StructureDefinition
ElementDefinition.type
Obligations relate to application behaviour, not the content of the element itself in the resource instances that contain this element.
If obligations appear on an element that is allowed to repeat, the default expectation is that the obligation applies to all repetitions allowed by the profile. I.e. if maxOccurs is "20" and there are obligations around display, storage, and data sharing, then the system would be expected to handle 20 for all of those purposes.
This default expectation can be overridden to establish a different "must support at least this many" on a per obligation basis using the applicable-number property.
If there is no upper cardinality specified (i.e. maxOccurs = "*"), the expectation is that the obligation applies to "as many as the system can technically manage", but there's an understanding that all systems will have a practical limit. E.g. not all systems will be able to allow data entry, persistence, display, etc. of "5000 patient given names". However, based on database design, some systems might have a practical limit of "3 patient given names". In the absence of an explicit cardinality or applicable-number value, there can be no confident assumption on the number that will be supported.
The technical limitations of a system will often vary based on the type of obligation. A system may be able to transmit more elements than they necessarily allow for capture, but in some cases (e.g. transmission via UPC code), the reverse might be true.
When constraining a profile element, applicable-number SHALL be less than or equal to maxOccurs, and SHALL be greater than or equal to the minimum of the current maxOccurs and the applicable-number of the element in the parent profile, if one is present.
When an obligation applies to a repeating element, the repetitions it applies to are determined as follows:
filterapplicable-number (if present) sets the minimum number of matching occurrences that the system must support. If more occurrences exist than the system supports, which occurrences are chosen is selected by the system adhering to the obligationNote that the result of this on elements with repetitions is that a variable number of results will be included based on all of the above rules, which may be zero or more in any given instance.
Whether an obligation applies, or how it applies, often depends on the context: clinical context, relevance to the purpose of the exchange, workflow, jurisdiction, and other business rules. For example, a system might only provide the most recent reaction on an allergy, or the general practitioner that is local to where the patient currently is.
There are several ways that this is handled:
usage property of the extension, which links clinical, workflow, or implementation context to the obligation - e.g. that the obligation applies to female patients, or in a particular jurisdiction (see UsageContext) Note that an implementation guide cannot change the meaning of the obligation codes themselves to take context into account (e.g. by redefining populate-if-known as "populate if known and relevant"); context rules are expressed using the mechanisms above.
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 5.3.0:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Summary
Complex Extension: 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.
Maturity: 1
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | Obligations for applications using element/in model | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Extension | Short label for collection of obligations | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "name" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
1..* | Extension | Composite code describing the nature of the obligation | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "code" | |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ObligationCodesVS (required): Codes that describe an obligation that applies to implementing applications | |
![]() ![]() ![]() |
0..* | Extension | When the obligation is on the profile itself, not a particular element, a list of elements to which it applies | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "elementId" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Actor(s) this obligation applies to (all actors if none) | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "actor" | |
![]() ![]() ![]() ![]() |
1..1 | canonical(ActorDefinition) | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "documentation" | |
![]() ![]() ![]() ![]() |
1..1 | markdown | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "usage" | |
![]() ![]() ![]() ![]() |
1..1 | UsageContext | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Limits obligation to some repeats by FHIRPath | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "filter" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Describes the intent of the filter (short) | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "filterDocumentation" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Minimum # of repetitions the obligation applies to | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "applicable-number" | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | The obligation only applies when performing the indicated process | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "process" | |
![]() ![]() ![]() ![]() |
1..1 | Value of extension | ||
![]() ![]() ![]() ![]() ![]() |
canonical(OperationDefinition) | |||
![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/obligation" | |
![]() ![]() |
0..0 | Value of extension | ||
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | Obligations for applications using element/in model | |
![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | Extension | Short label for collection of obligations | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "name" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
1..* | Extension | Composite code describing the nature of the obligation | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "code" | |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ObligationCodesVS (required): Codes that describe an obligation that applies to implementing applications | |
![]() ![]() ![]() |
0..* | Extension | When the obligation is on the profile itself, not a particular element, a list of elements to which it applies | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "elementId" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Actor(s) this obligation applies to (all actors if none) | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "actor" | |
![]() ![]() ![]() ![]() |
1..1 | canonical(ActorDefinition) | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "documentation" | |
![]() ![]() ![]() ![]() |
1..1 | markdown | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "usage" | |
![]() ![]() ![]() ![]() |
1..1 | UsageContext | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Limits obligation to some repeats by FHIRPath | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "filter" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Describes the intent of the filter (short) | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "filterDocumentation" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Minimum # of repetitions the obligation applies to | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "applicable-number" | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | The obligation only applies when performing the indicated process | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "process" | |
![]() ![]() ![]() ![]() |
1..1 | Value of extension | ||
![]() ![]() ![]() ![]() ![]() |
canonical(OperationDefinition) | |||
![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/obligation" | |
Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: 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.
Maturity: 1
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | Obligations for applications using element/in model | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Extension | Short label for collection of obligations | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "name" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
1..* | Extension | Composite code describing the nature of the obligation | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "code" | |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ObligationCodesVS (required): Codes that describe an obligation that applies to implementing applications | |
![]() ![]() ![]() |
0..* | Extension | When the obligation is on the profile itself, not a particular element, a list of elements to which it applies | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "elementId" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Actor(s) this obligation applies to (all actors if none) | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "actor" | |
![]() ![]() ![]() ![]() |
1..1 | canonical(ActorDefinition) | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "documentation" | |
![]() ![]() ![]() ![]() |
1..1 | markdown | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "usage" | |
![]() ![]() ![]() ![]() |
1..1 | UsageContext | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Limits obligation to some repeats by FHIRPath | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "filter" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Describes the intent of the filter (short) | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "filterDocumentation" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Minimum # of repetitions the obligation applies to | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "applicable-number" | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | The obligation only applies when performing the indicated process | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "process" | |
![]() ![]() ![]() ![]() |
1..1 | Value of extension | ||
![]() ![]() ![]() ![]() ![]() |
canonical(OperationDefinition) | |||
![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/obligation" | |
![]() ![]() |
0..0 | Value of extension | ||
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | Obligations for applications using element/in model | |
![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | Extension | Short label for collection of obligations | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "name" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
1..* | Extension | Composite code describing the nature of the obligation | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "code" | |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ObligationCodesVS (required): Codes that describe an obligation that applies to implementing applications | |
![]() ![]() ![]() |
0..* | Extension | When the obligation is on the profile itself, not a particular element, a list of elements to which it applies | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "elementId" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Actor(s) this obligation applies to (all actors if none) | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "actor" | |
![]() ![]() ![]() ![]() |
1..1 | canonical(ActorDefinition) | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Documentation of the purpose or application of the obligation | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "documentation" | |
![]() ![]() ![]() ![]() |
1..1 | markdown | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Qualifies the usage - jurisdiction, gender, workflow status etc | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "usage" | |
![]() ![]() ![]() ![]() |
1..1 | UsageContext | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Limits obligation to some repeats by FHIRPath | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "filter" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Describes the intent of the filter (short) | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "filterDocumentation" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Minimum # of repetitions the obligation applies to | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "applicable-number" | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | The obligation only applies when performing the indicated process | |
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "process" | |
![]() ![]() ![]() ![]() |
1..1 | Value of extension | ||
![]() ![]() ![]() ![]() ![]() |
canonical(OperationDefinition) | |||
![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/obligation" | |
Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:code.​value[x] | Base | required | Obligation Codes ValueSet | 📦5.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
The extension is represented a little differently in R4B:
| Name | Flags | Card. | Type |
Description & Constraints
Filter:
|
|---|---|---|---|---|
|
0..* | Extension |
Obligations for applications using element/in model |
|
|
Content/Rules for all slices | |||
|
0..1 | Extension | Short label for collection of obligations | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "name" | |
|
1.. 1 | string | Value of extension | |
|
1..* | Extension |
Composite code describing the nature of the obligation |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "code" | |
|
1.. 1 | code |
Value of extension
Binding: ObligationCodesVS ( required ) : Codes that describe an obligation that applies to implementing applications |
|
|
0..* | Extension |
When the obligation is on the profile itself, not a particular element, a list of elements to which it applies |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "elementId" | |
|
1.. 1 | string | Value of extension | |
|
0..* | Extension |
Actor(s) this obligation applies to (all actors if none) |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "actor" | |
|
1..1 | canonical () | Value of extension | |
|
0..1 | Extension | Documentation of the purpose or application of the obligation | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "documentation" | |
|
1.. 1 | markdown | Value of extension | |
|
0..* | Extension |
Qualifies the usage - jurisdiction, gender, workflow status etc |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "usage" | |
|
1.. 1 | UsageContext | Value of extension | |
|
0..1 | Extension | Limits obligation to some repeats by FHIRPath | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "filter" | |
|
1.. 1 | string | Value of extension | |
|
0..1 | Extension | Describes the intent of the filter (short) | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "filterDocumentation" | |
|
1.. 1 | string | Value of extension | |
|
0..1 | Extension | Minimum # of repetitions the obligation applies to | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "applicable-number" | |
|
1.. 1 | positiveInt | Value of extension | |
|
0..* | Extension |
The obligation only applies when performing the indicated process |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "process" | |
|
1.. 1 | Value of extension | ||
|
canonical ( OperationDefinition ) | |||
|
uri | |||
|
1 .. 1 | uri | "http://hl7.org/fhir/StructureDefinition/obligation" | |
|
0 .. 0 | Value of extension | ||
Documentation for this format
|
||||
The extension is represented a little differently in R4:
| Name | Flags | Card. | Type |
Description & Constraints
Filter:
|
|---|---|---|---|---|
|
0..* | Extension |
Obligations for applications using element/in model |
|
|
Content/Rules for all slices | |||
|
0..1 | Extension | Short label for collection of obligations | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "name" | |
|
1.. 1 | string | Value of extension | |
|
1..* | Extension |
Composite code describing the nature of the obligation |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "code" | |
|
1.. 1 | code |
Value of extension
Binding: ObligationCodesVS ( required ) : Codes that describe an obligation that applies to implementing applications |
|
|
0..* | Extension |
When the obligation is on the profile itself, not a particular element, a list of elements to which it applies |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "elementId" | |
|
1.. 1 | string | Value of extension | |
|
0..* | Extension |
Actor(s) this obligation applies to (all actors if none) |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "actor" | |
|
1..1 | canonical () | Value of extension | |
|
0..1 | Extension | Documentation of the purpose or application of the obligation | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "documentation" | |
|
1.. 1 | markdown | Value of extension | |
|
0..* | Extension |
Qualifies the usage - jurisdiction, gender, workflow status etc |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "usage" | |
|
1.. 1 | UsageContext | Value of extension | |
|
0..1 | Extension | Limits obligation to some repeats by FHIRPath | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "filter" | |
|
1.. 1 | string | Value of extension | |
|
0..1 | Extension | Describes the intent of the filter (short) | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "filterDocumentation" | |
|
1.. 1 | string | Value of extension | |
|
0..1 | Extension | Minimum # of repetitions the obligation applies to | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "applicable-number" | |
|
1.. 1 | positiveInt | Value of extension | |
|
0..* | Extension |
The obligation only applies when performing the indicated process |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "process" | |
|
1.. 1 | Value of extension | ||
|
canonical ( OperationDefinition ) | |||
|
uri | |||
|
1 .. 1 | uri | "http://hl7.org/fhir/StructureDefinition/obligation" | |
|
0 .. 0 | Value of extension | ||
Documentation for this format
|
||||
The extension is represented a little differently in R3:
| Name | Flags | Card. | Type |
Description & Constraints
Filter:
|
|---|---|---|---|---|
|
0..* | Extension |
Obligations for applications using element/in model |
|
|
Content/Rules for all slices | |||
|
0..1 | Extension | Short label for collection of obligations | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "name" | |
|
1.. 1 | string | Value of extension | |
|
1..* | Extension |
Composite code describing the nature of the obligation |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "code" | |
|
1.. 1 | code |
Value of extension
Binding: ObligationCodesVS ( required ) : Codes that describe an obligation that applies to implementing applications |
|
|
0..* | Extension |
When the obligation is on the profile itself, not a particular element, a list of elements to which it applies |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "elementId" | |
|
1.. 1 | string | Value of extension | |
|
0..* | Extension |
Actor(s) this obligation applies to (all actors if none) |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "actor" | |
|
1..1 | uri | Value of extension | |
|
0..1 | Extension | Documentation of the purpose or application of the obligation | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "documentation" | |
|
1.. 1 | markdown | Value of extension | |
|
0..* | Extension |
Qualifies the usage - jurisdiction, gender, workflow status etc |
|
|
0 ..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|
|
Content/Rules for all slices | |||
|
1..1 | (Complex) |
DataType name 'UsageContext' from R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype |
|
|
1.. 1 | string |
Value of extension
Fixed Value: UsageContext |
|
|
1..1 | Extension | Type of context being specified | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "code" | |
|
1.. 1 | Coding |
Value of extension
Binding: UsageContextType ( extensible ) : A code that specifies a type of context being specified by a usage context. |
|
|
1..1 | Extension | Value that defines the context | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "value[x]" | |
|
1.. 1 |
Value of extension
Binding: ContextOfUseValueSet ( example ) : A code that defines the specific value for the context being specified. |
||
|
CodeableConcept | |||
|
Quantity | |||
|
Range | |||
|
Reference ( PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization ) | |||
|
1 .. 1 | uri | "usage" | |
|
0 .. 0 | Value of extension | ||
|
0..1 | Extension | Limits obligation to some repeats by FHIRPath | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "filter" | |
|
1.. 1 | string | Value of extension | |
|
0..1 | Extension | Describes the intent of the filter (short) | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "filterDocumentation" | |
|
1.. 1 | string | Value of extension | |
|
0..1 | Extension | Minimum # of repetitions the obligation applies to | |
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "applicable-number" | |
|
1.. 1 | positiveInt | Value of extension | |
|
0..* | Extension |
The obligation only applies when performing the indicated process |
|
|
0 .. 0 | Extension | ||
|
1 .. 1 | uri | "process" | |
|
1.. 1 | Value of extension | ||
|
uri | |||
|
uri | |||
|
1 .. 1 | uri | "http://hl7.org/fhir/StructureDefinition/obligation" | |
|
0 .. 0 | Value of extension | ||
Documentation for this format
|
||||
(none found)