This page is part of the Subscriptions R5 Backport (v1.1.0: STU 1.1) based on FHIR v4.3.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2023-01-11 |
Definitions for the backport-subscription-status-r4 resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Parameters | |
2. Parameters.parameter | |
Control | 30..* |
Slicing | This element introduces a set of slices on Parameters.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
3. Parameters.parameter:subscription | |
SliceName | subscription |
Control | 1..1 |
Must Support | true |
4. Parameters.parameter:subscription.name | |
Control | 0..? |
Fixed Value | subscription |
5. Parameters.parameter:subscription.value[x] | |
Definition | The reference to the Subscription which generated this notification. |
Control | 1..? |
Type | Reference(Subscription) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
6. Parameters.parameter:topic | |
SliceName | topic |
Control | 0..1 |
Must Support | true |
7. Parameters.parameter:topic.name | |
Control | 0..? |
Fixed Value | topic |
8. Parameters.parameter:topic.value[x] | |
Definition | Canonical reference to the SubscriptionTopic for the Subscription which generated this notification. |
Control | 0..? |
Type | canonical |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Comments | This value SHOULD NOT be present when using |
9. Parameters.parameter:status | |
SliceName | status |
Control | 1..1 |
Must Support | true |
10. Parameters.parameter:status.name | |
Control | 0..? |
Fixed Value | status |
11. Parameters.parameter:status.value[x] | |
Definition | The status of the subscription, which marks the server state for managing the subscription. |
Control | 1..? |
Binding | The codes SHALL be taken from SubscriptionStatusCodes |
Type | code |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
12. Parameters.parameter:type | |
SliceName | type |
Control | 1..1 |
Must Support | true |
13. Parameters.parameter:type.name | |
Control | 0..? |
Fixed Value | type |
14. Parameters.parameter:type.value[x] | |
Control | 1..? |
Binding | The codes SHALL be taken from SubscriptionNotificationType |
Type | code |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
15. Parameters.parameter:eventsSinceSubscriptionStart | |
SliceName | eventsSinceSubscriptionStart |
Control | 0..1 |
Must Support | true |
16. Parameters.parameter:eventsSinceSubscriptionStart.name | |
Control | 0..? |
Fixed Value | events-since-subscription-start |
17. Parameters.parameter:eventsSinceSubscriptionStart.value[x] | |
Definition | The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications. |
Control | 0..? |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
18. Parameters.parameter:notificationEvent | |
SliceName | notificationEvent |
Control | 0..* |
Must Support | true |
19. Parameters.parameter:notificationEvent.name | |
Control | 0..? |
Fixed Value | notification-event |
20. Parameters.parameter:notificationEvent.part | |
Control | 1..? |
Must Support | true |
Slicing | This element introduces a set of slices on Parameters.parameter.part. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
21. Parameters.parameter:notificationEvent.part:eventNumber | |
SliceName | eventNumber |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
22. Parameters.parameter:notificationEvent.part:eventNumber.name | |
Control | 0..? |
Fixed Value | event-number |
23. Parameters.parameter:notificationEvent.part:eventNumber.value[x] | |
Definition | The sequential number of this event in this subscription context. |
Control | 1..? |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
24. Parameters.parameter:notificationEvent.part:eventTimestamp | |
SliceName | eventTimestamp |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
25. Parameters.parameter:notificationEvent.part:eventTimestamp.name | |
Control | 0..? |
Fixed Value | timestamp |
26. Parameters.parameter:notificationEvent.part:eventTimestamp.value[x] | |
Definition | The actual time this event occured on the server. |
Control | 0..? |
Type | instant |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
27. Parameters.parameter:notificationEvent.part:eventFocus | |
SliceName | eventFocus |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
28. Parameters.parameter:notificationEvent.part:eventFocus.name | |
Control | 0..? |
Fixed Value | focus |
29. Parameters.parameter:notificationEvent.part:eventFocus.value[x] | |
Definition | The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object. |
Control | 0..? |
Type | Reference |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
30. Parameters.parameter:notificationEvent.part:eventAdditionalContext | |
SliceName | eventAdditionalContext |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
31. Parameters.parameter:notificationEvent.part:eventAdditionalContext.name | |
Control | 0..? |
Fixed Value | additional-context |
32. Parameters.parameter:notificationEvent.part:eventAdditionalContext.value[x] | |
Definition | Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects. |
Control | 0..? |
Type | Reference |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
33. Parameters.parameter:error | |
SliceName | error |
Control | 0..* |
Must Support | true |
34. Parameters.parameter:error.name | |
Control | 0..? |
Fixed Value | error |
35. Parameters.parameter:error.value[x] | |
Definition | A record of errors that occurred when the server processed a notification. |
Control | 0..? |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here.
1. Parameters | |
Definition | This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. |
Control | 0..* |
Summary | false |
Comments | The parameters that may be used are defined by the OperationDefinition resource. |
2. Parameters.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. Parameters.parameter | |
Definition | A parameter passed to or received from the operation. |
Control | 30..* |
Type | BackboneElement |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) |
Slicing | This element introduces a set of slices on Parameters.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Parameters.parameter.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
5. Parameters.parameter.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. Parameters.parameter:subscription | |
SliceName | subscription |
Definition | A parameter passed to or received from the operation. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) |
7. Parameters.parameter:subscription.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
8. Parameters.parameter:subscription.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | subscription |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. Parameters.parameter:subscription.value[x] | |
Definition | The reference to the Subscription which generated this notification. Conveys the content if the parameter is a data type. |
Control | 10..1 This element is affected by the following invariants: inv-1 |
Type | Choice of: Reference(Subscription), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. Parameters.parameter:topic | |
SliceName | topic |
Definition | A parameter passed to or received from the operation. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) |
11. Parameters.parameter:topic.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
12. Parameters.parameter:topic.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | topic |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. Parameters.parameter:topic.value[x] | |
Definition | Canonical reference to the SubscriptionTopic for the Subscription which generated this notification. Conveys the content if the parameter is a data type. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | Choice of: canonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Comments | This value SHOULD NOT be present when using |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. Parameters.parameter:status | |
SliceName | status |
Definition | A parameter passed to or received from the operation. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) |
15. Parameters.parameter:status.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
16. Parameters.parameter:status.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | status |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. Parameters.parameter:status.value[x] | |
Definition | The status of the subscription, which marks the server state for managing the subscription. Conveys the content if the parameter is a data type. |
Control | 10..1 This element is affected by the following invariants: inv-1 |
Binding | The codes SHALL be taken from SubscriptionStatusCodesFor codes, see (unbound) |
Type | Choice of: code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. Parameters.parameter:type | |
SliceName | type |
Definition | A parameter passed to or received from the operation. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) |
19. Parameters.parameter:type.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
20. Parameters.parameter:type.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | type |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. Parameters.parameter:type.value[x] | |
Definition | Conveys the content if the parameter is a data type. |
Control | 10..1 This element is affected by the following invariants: inv-1 |
Binding | The codes SHALL be taken from SubscriptionNotificationTypeFor codes, see (unbound) |
Type | Choice of: code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. Parameters.parameter:eventsSinceSubscriptionStart | |
SliceName | eventsSinceSubscriptionStart |
Definition | A parameter passed to or received from the operation. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) |
23. Parameters.parameter:eventsSinceSubscriptionStart.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
24. Parameters.parameter:eventsSinceSubscriptionStart.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | events-since-subscription-start |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Parameters.parameter:eventsSinceSubscriptionStart.value[x] | |
Definition | The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications. Conveys the content if the parameter is a data type. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | Choice of: string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Parameters.parameter:notificationEvent | |
SliceName | notificationEvent |
Definition | A parameter passed to or received from the operation. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) |
27. Parameters.parameter:notificationEvent.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
28. Parameters.parameter:notificationEvent.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | notification-event |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. Parameters.parameter:notificationEvent.part | |
Definition | A named part of a multi-part parameter. |
Control | 10..* |
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter |
Must Support | true |
Summary | true |
Comments | Only one level of nested parameters is allowed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Parameters.parameter.part. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
30. Parameters.parameter:notificationEvent.part:eventNumber | |
SliceName | eventNumber |
Definition | A named part of a multi-part parameter. |
Control | 10..1* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Comments | Only one level of nested parameters is allowed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. Parameters.parameter:notificationEvent.part:eventNumber.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
32. Parameters.parameter:notificationEvent.part:eventNumber.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | event-number |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. Parameters.parameter:notificationEvent.part:eventNumber.value[x] | |
Definition | The sequential number of this event in this subscription context. Conveys the content if the parameter is a data type. |
Control | 10..1 This element is affected by the following invariants: inv-1 |
Type | Choice of: string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. Parameters.parameter:notificationEvent.part:eventTimestamp | |
SliceName | eventTimestamp |
Definition | A named part of a multi-part parameter. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Comments | Only one level of nested parameters is allowed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. Parameters.parameter:notificationEvent.part:eventTimestamp.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
36. Parameters.parameter:notificationEvent.part:eventTimestamp.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | timestamp |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
37. Parameters.parameter:notificationEvent.part:eventTimestamp.value[x] | |
Definition | The actual time this event occured on the server. Conveys the content if the parameter is a data type. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | Choice of: instant, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
38. Parameters.parameter:notificationEvent.part:eventFocus | |
SliceName | eventFocus |
Definition | A named part of a multi-part parameter. |
Control | 0..1* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Comments | Only one level of nested parameters is allowed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. Parameters.parameter:notificationEvent.part:eventFocus.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
40. Parameters.parameter:notificationEvent.part:eventFocus.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | focus |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
41. Parameters.parameter:notificationEvent.part:eventFocus.value[x] | |
Definition | The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object. Conveys the content if the parameter is a data type. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | Choice of: Reference, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. Parameters.parameter:notificationEvent.part:eventAdditionalContext | |
SliceName | eventAdditionalContext |
Definition | A named part of a multi-part parameter. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Comments | Only one level of nested parameters is allowed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
43. Parameters.parameter:notificationEvent.part:eventAdditionalContext.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
44. Parameters.parameter:notificationEvent.part:eventAdditionalContext.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | additional-context |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
45. Parameters.parameter:notificationEvent.part:eventAdditionalContext.value[x] | |
Definition | Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects. Conveys the content if the parameter is a data type. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | Choice of: Reference, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
46. Parameters.parameter:error | |
SliceName | error |
Definition | A parameter passed to or received from the operation. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) |
47. Parameters.parameter:error.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
48. Parameters.parameter:error.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Summary | true |
Fixed Value | error |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
49. Parameters.parameter:error.value[x] | |
Definition | A record of errors that occurred when the server processed a notification. Conveys the content if the parameter is a data type. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | Choice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. Parameters | |||||
Definition | This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. | ||||
Control | 0..* | ||||
Summary | false | ||||
Comments | The parameters that may be used are defined by the OperationDefinition resource. | ||||
2. Parameters.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. Parameters.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. Parameters.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
5. Parameters.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
IETF language ta
| ||||
Type | code | ||||
Summary | false | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
6. Parameters.parameter | |||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 3..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||
Slicing | This element introduces a set of slices on Parameters.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
7. Parameters.parameter.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
8. Parameters.parameter.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
9. Parameters.parameter.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
10. Parameters.parameter.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
11. Parameters.parameter.value[x] | |||||
Definition | Conveys the content if the parameter is a data type. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
12. Parameters.parameter.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
13. Parameters.parameter.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
14. Parameters.parameter:subscription | |||||
SliceName | subscription | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||
15. Parameters.parameter:subscription.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
16. Parameters.parameter:subscription.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
17. Parameters.parameter:subscription.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
18. Parameters.parameter:subscription.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | subscription | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
19. Parameters.parameter:subscription.value[x] | |||||
Definition | The reference to the Subscription which generated this notification. | ||||
Control | 1..1 This element is affected by the following invariants: inv-1 | ||||
Type | Reference(Subscription) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
20. Parameters.parameter:subscription.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
21. Parameters.parameter:subscription.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
22. Parameters.parameter:topic | |||||
SliceName | topic | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||
23. Parameters.parameter:topic.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
24. Parameters.parameter:topic.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
25. Parameters.parameter:topic.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
26. Parameters.parameter:topic.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | topic | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Parameters.parameter:topic.value[x] | |||||
Definition | Canonical reference to the SubscriptionTopic for the Subscription which generated this notification. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | canonical | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | This value SHOULD NOT be present when using | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Parameters.parameter:topic.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
29. Parameters.parameter:topic.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. Parameters.parameter:status | |||||
SliceName | status | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||
31. Parameters.parameter:status.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
32. Parameters.parameter:status.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
33. Parameters.parameter:status.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
34. Parameters.parameter:status.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | status | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. Parameters.parameter:status.value[x] | |||||
Definition | The status of the subscription, which marks the server state for managing the subscription. | ||||
Control | 1..1 This element is affected by the following invariants: inv-1 | ||||
Binding | The codes SHALL be taken from SubscriptionStatusCodes | ||||
Type | code | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. Parameters.parameter:status.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
37. Parameters.parameter:status.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. Parameters.parameter:type | |||||
SliceName | type | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||
39. Parameters.parameter:type.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
40. Parameters.parameter:type.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
41. Parameters.parameter:type.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
42. Parameters.parameter:type.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | type | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. Parameters.parameter:type.value[x] | |||||
Definition | Conveys the content if the parameter is a data type. | ||||
Control | 1..1 This element is affected by the following invariants: inv-1 | ||||
Binding | The codes SHALL be taken from SubscriptionNotificationType | ||||
Type | code | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. Parameters.parameter:type.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
45. Parameters.parameter:type.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. Parameters.parameter:eventsSinceSubscriptionStart | |||||
SliceName | eventsSinceSubscriptionStart | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||
47. Parameters.parameter:eventsSinceSubscriptionStart.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
48. Parameters.parameter:eventsSinceSubscriptionStart.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
49. Parameters.parameter:eventsSinceSubscriptionStart.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
50. Parameters.parameter:eventsSinceSubscriptionStart.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | events-since-subscription-start | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. Parameters.parameter:eventsSinceSubscriptionStart.value[x] | |||||
Definition | The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. Parameters.parameter:eventsSinceSubscriptionStart.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
53. Parameters.parameter:eventsSinceSubscriptionStart.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. Parameters.parameter:notificationEvent | |||||
SliceName | notificationEvent | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||
55. Parameters.parameter:notificationEvent.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
56. Parameters.parameter:notificationEvent.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
57. Parameters.parameter:notificationEvent.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
58. Parameters.parameter:notificationEvent.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | notification-event | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
59. Parameters.parameter:notificationEvent.value[x] | |||||
Definition | Conveys the content if the parameter is a data type. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
60. Parameters.parameter:notificationEvent.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
61. Parameters.parameter:notificationEvent.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 1..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Parameters.parameter.part. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
62. Parameters.parameter:notificationEvent.part:eventNumber | |||||
SliceName | eventNumber | ||||
Definition | A named part of a multi-part parameter. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. Parameters.parameter:notificationEvent.part:eventNumber.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
64. Parameters.parameter:notificationEvent.part:eventNumber.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
65. Parameters.parameter:notificationEvent.part:eventNumber.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
66. Parameters.parameter:notificationEvent.part:eventNumber.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | event-number | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
67. Parameters.parameter:notificationEvent.part:eventNumber.value[x] | |||||
Definition | The sequential number of this event in this subscription context. | ||||
Control | 1..1 This element is affected by the following invariants: inv-1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
68. Parameters.parameter:notificationEvent.part:eventNumber.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
69. Parameters.parameter:notificationEvent.part:eventNumber.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
70. Parameters.parameter:notificationEvent.part:eventTimestamp | |||||
SliceName | eventTimestamp | ||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
71. Parameters.parameter:notificationEvent.part:eventTimestamp.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
72. Parameters.parameter:notificationEvent.part:eventTimestamp.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
73. Parameters.parameter:notificationEvent.part:eventTimestamp.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
74. Parameters.parameter:notificationEvent.part:eventTimestamp.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | timestamp | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
75. Parameters.parameter:notificationEvent.part:eventTimestamp.value[x] | |||||
Definition | The actual time this event occured on the server. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | instant | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
76. Parameters.parameter:notificationEvent.part:eventTimestamp.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
77. Parameters.parameter:notificationEvent.part:eventTimestamp.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
78. Parameters.parameter:notificationEvent.part:eventFocus | |||||
SliceName | eventFocus | ||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
79. Parameters.parameter:notificationEvent.part:eventFocus.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
80. Parameters.parameter:notificationEvent.part:eventFocus.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
81. Parameters.parameter:notificationEvent.part:eventFocus.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
82. Parameters.parameter:notificationEvent.part:eventFocus.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | focus | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
83. Parameters.parameter:notificationEvent.part:eventFocus.value[x] | |||||
Definition | The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Reference | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
84. Parameters.parameter:notificationEvent.part:eventFocus.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
85. Parameters.parameter:notificationEvent.part:eventFocus.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
86. Parameters.parameter:notificationEvent.part:eventAdditionalContext | |||||
SliceName | eventAdditionalContext | ||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
87. Parameters.parameter:notificationEvent.part:eventAdditionalContext.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
88. Parameters.parameter:notificationEvent.part:eventAdditionalContext.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
89. Parameters.parameter:notificationEvent.part:eventAdditionalContext.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
90. Parameters.parameter:notificationEvent.part:eventAdditionalContext.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | additional-context | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
91. Parameters.parameter:notificationEvent.part:eventAdditionalContext.value[x] | |||||
Definition | Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Reference | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
92. Parameters.parameter:notificationEvent.part:eventAdditionalContext.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
93. Parameters.parameter:notificationEvent.part:eventAdditionalContext.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
94. Parameters.parameter:error | |||||
SliceName | error | ||||
Definition | A parameter passed to or received from the operation. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) inv-1: A parameter must have one and only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))) | ||||
95. Parameters.parameter:error.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
96. Parameters.parameter:error.extension | |||||
Definition | 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 manageable, 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
97. Parameters.parameter:error.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
98. Parameters.parameter:error.name | |||||
Definition | The name of the parameter (reference to the operation definition). | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Fixed Value | error | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
99. Parameters.parameter:error.value[x] | |||||
Definition | A record of errors that occurred when the server processed a notification. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
100. Parameters.parameter:error.resource | |||||
Definition | If the parameter is a whole resource. | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | Resource | ||||
Summary | true | ||||
Comments | When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. | ||||
101. Parameters.parameter:error.part | |||||
Definition | A named part of a multi-part parameter. | ||||
Control | 0..* | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter | ||||
Summary | true | ||||
Comments | Only one level of nested parameters is allowed. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |