Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-SubscriptionTopic resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. SubscriptionTopic | |
| Definition | Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic. |
| Short | The definition of a specific topic for triggering events within the Subscriptions framework |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
| 2. SubscriptionTopic.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. |
| Short | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. SubscriptionTopic.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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. |
| Short | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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())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()) |
| Slicing | This element introduces a set of slices on SubscriptionTopic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. SubscriptionTopic.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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())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. SubscriptionTopic.extension:name | |
| Slice Name | name |
| Definition | R5: |
| Short | R5: Name for this subscription topic (computer friendly) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(ArtifactName) (Extension Type: string) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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())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. SubscriptionTopic.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Copyright Label) (Extension Type: string) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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())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. SubscriptionTopic.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | false |
| 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 |
| Invariants | 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())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()) |
| 14. SubscriptionTopic.url | |
| Definition | An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers. |
| Short | Canonical identifier for this subscription topic definition, represented as a URI (globally unique) |
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Allows the subscription topic to be referenced by a single globally unique identifier. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. SubscriptionTopic.url.extension | |
| Definition | An Extension 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. |
| Short | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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())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()) |
| Slicing | This element introduces a set of slices on SubscriptionTopic.url.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. SubscriptionTopic.url.extension:url | |
| Slice Name | url |
| Definition | R5: |
| Short | R5: Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) |
| Comments | Element The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. When this is a locally defined topic or derived from a topic defined in the FHIR spec or an IG, this uniquely identifies the topic and functionality. Ideally this URL resolves to documentation about the use cases. When this is a topic derived from another topic (e.g., it adds additional filters or functionality to a topic defined in an IG), then this URL should be different than the base and the When this is a direct implementation from another IG or registered topic (with no additional filters, etc., so not derived), then this url is the unique url for this topic as defined by the IG. |
| Control | 0..1 |
| Type | Extension(Artifact URL) (Extension Type: uri) |
| Is Modifier | false |
| Summary | false |
| Invariants | 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())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. SubscriptionTopic.status | |
| Definition | The current state of the SubscriptionTopic. |
| Short | draft | active | retired | unknown |
| Comments | A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.3.0 (required to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)The lifecycle status of an artifact. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired SubscriptionTopic without due consideration |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. SubscriptionTopic.experimental | |
| Definition | A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
| Short | If for testing purposes, not real usage |
| Comments | Allows filtering of SubscriptionTopic that are appropriate for use vs. not. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use an experimental SubscriptionTopic in production. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Enables experimental content to be developed following the same life-cycle as a production-level SubscriptionTopic would. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. SubscriptionTopic.experimental.extension | |
| Definition | An Extension 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. |
| Short | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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())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()) |
| Slicing | This element introduces a set of slices on SubscriptionTopic.experimental.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. SubscriptionTopic.experimental.extension:experimental | |
| Slice Name | experimental |
| Definition | R5: |
| Short | R5: experimental |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Experimental) (Extension Type: boolean) |
| Is Modifier | false |
| Summary | false |
| Invariants | 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())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()) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. SubscriptionTopic | |
| 2. SubscriptionTopic.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. SubscriptionTopic.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding) |
| 6. SubscriptionTopic.extension:name | |
| Slice Name | name |
| Definition | R5: |
| Short | R5: Name for this subscription topic (computer friendly) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(ArtifactName) (Extension Type: string) |
| 8. SubscriptionTopic.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Copyright Label) (Extension Type: string) |
| 10. SubscriptionTopic.url | |
| 12. SubscriptionTopic.url.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.url.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. SubscriptionTopic.url.extension:url | |
| Slice Name | url |
| Definition | R5: |
| Short | R5: Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) |
| Comments | Element The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. When this is a locally defined topic or derived from a topic defined in the FHIR spec or an IG, this uniquely identifies the topic and functionality. Ideally this URL resolves to documentation about the use cases. When this is a topic derived from another topic (e.g., it adds additional filters or functionality to a topic defined in an IG), then this URL should be different than the base and the When this is a direct implementation from another IG or registered topic (with no additional filters, etc., so not derived), then this url is the unique url for this topic as defined by the IG. |
| Control | 0..1 |
| Type | Extension(Artifact URL) (Extension Type: uri) |
| 16. SubscriptionTopic.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 18. SubscriptionTopic.identifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. SubscriptionTopic.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | R5: |
| Short | R5: Business identifier for subscription topic |
| Comments | Element |
| Control | 0..* |
| Type | Extension(Artifact Identifier) (Extension Type: Identifier) |
| 22. SubscriptionTopic.version | |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| 24. SubscriptionTopic.version.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.version.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. SubscriptionTopic.version.extension:version | |
| Slice Name | version |
| Definition | R5: |
| Short | R5: version |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(ArtifactVersion) (Extension Type: string) |
| 28. SubscriptionTopic.title | |
| 30. SubscriptionTopic.title.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. SubscriptionTopic.title.extension:title | |
| Slice Name | title |
| Definition | R5: |
| Short | R5: Name for this subscription topic (human friendly) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Title) (Extension Type: string) |
| 34. SubscriptionTopic.status | |
| 36. SubscriptionTopic.status.modifierExtension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.status.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 38. SubscriptionTopic.status.modifierExtension:status | |
| Slice Name | status |
| Definition | R5: |
| Short | R5: status |
| Comments | Element Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | Extension(Artifact Status) (Extension Type: code) |
| 40. SubscriptionTopic.experimental | |
| 42. SubscriptionTopic.experimental.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.experimental.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. SubscriptionTopic.experimental.extension:experimental | |
| Slice Name | experimental |
| Definition | R5: |
| Short | R5: experimental |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Experimental) (Extension Type: boolean) |
| 46. SubscriptionTopic.date | |
| 48. SubscriptionTopic.date.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.date.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 50. SubscriptionTopic.date.extension:date | |
| Slice Name | date |
| Definition | R5: |
| Short | R5: date |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Date) (Extension Type: dateTime) |
| 52. SubscriptionTopic.publisher | |
| 54. SubscriptionTopic.publisher.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.publisher.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 56. SubscriptionTopic.publisher.extension:publisher | |
| Slice Name | publisher |
| Definition | R5: |
| Short | R5: publisher |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Publisher) (Extension Type: string) |
| 58. SubscriptionTopic.contact | |
| 60. SubscriptionTopic.contact.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. SubscriptionTopic.contact.extension:contact | |
| Slice Name | contact |
| Definition | R5: |
| Short | R5: contact |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..* |
| Type | Extension(Artifact Contact) (Extension Type: ContactDetail) |
| 64. SubscriptionTopic.description | |
| 66. SubscriptionTopic.description.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. SubscriptionTopic.description.extension:description | |
| Slice Name | description |
| Definition | R5: |
| Short | R5: description |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Description) (Extension Type: markdown) |
| 70. SubscriptionTopic.useContext | |
| 72. SubscriptionTopic.useContext.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 74. SubscriptionTopic.useContext.extension:useContext | |
| Slice Name | useContext |
| Definition | R5: |
| Short | R5: useContext |
| Comments | Element |
| Control | 0..* |
| Type | Extension(Artifact use context) (Extension Type: UsageContext) |
| 76. SubscriptionTopic.purpose | |
| 78. SubscriptionTopic.purpose.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.purpose.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 80. SubscriptionTopic.purpose.extension:purpose | |
| Slice Name | purpose |
| Definition | R5: |
| Short | R5: purpose |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Purpose) (Extension Type: markdown) |
| 82. SubscriptionTopic.copyright | |
| 84. SubscriptionTopic.copyright.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.copyright.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 86. SubscriptionTopic.copyright.extension:copyright | |
| Slice Name | copyright |
| Definition | R5: |
| Short | R5: copyright |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Copyright) (Extension Type: markdown) |
| 88. SubscriptionTopic.approvalDate | |
| 90. SubscriptionTopic.approvalDate.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.approvalDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 92. SubscriptionTopic.approvalDate.extension:approvalDate | |
| Slice Name | approvalDate |
| Definition | R5: |
| Short | R5: approvalDate |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Approval Date) (Extension Type: date) |
| 94. SubscriptionTopic.lastReviewDate | |
| 96. SubscriptionTopic.lastReviewDate.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.lastReviewDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 98. SubscriptionTopic.lastReviewDate.extension:lastReviewDate | |
| Slice Name | lastReviewDate |
| Definition | R5: |
| Short | R5: lastReviewDate |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Last Review Date) (Extension Type: date) |
| 100. SubscriptionTopic.effectivePeriod | |
| 102. SubscriptionTopic.effectivePeriod.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.effectivePeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 104. SubscriptionTopic.effectivePeriod.extension:effectivePeriod | |
| Slice Name | effectivePeriod |
| Definition | R5: |
| Short | R5: effectivePeriod |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Effective Period) (Extension Type: Period) |
| 106. SubscriptionTopic.canFilterBy | |
| 108. SubscriptionTopic.canFilterBy.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.canFilterBy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 110. SubscriptionTopic.canFilterBy.extension:comparator | |
| Slice Name | comparator |
| Definition | R5: |
| Short | R5: eq | ne | gt | lt | ge | le | sa | eb | ap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: eq | ne | gt | lt | ge | le | sa | eb | ap (new)) (Extension Type: code) |
| 112. SubscriptionTopic.canFilterBy.modifier | |
| 114. SubscriptionTopic.canFilterBy.modifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SubscriptionTopic.canFilterBy.modifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 116. SubscriptionTopic.canFilterBy.modifier.extension:modifier | |
| Slice Name | modifier |
| Definition | R5: |
| Short | R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate) (Extension Type: code) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. SubscriptionTopic | |||||
| Definition | Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic. | ||||
| Short | The definition of a specific topic for triggering events within the Subscriptions framework | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | ||||
| 2. SubscriptionTopic.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| 4. SubscriptionTopic.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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. SubscriptionTopic.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. | ||||
| Short | A set of rules under which this content was created | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. SubscriptionTopic.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)IETF language tag
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. SubscriptionTopic.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. SubscriptionTopic.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| Invariants | dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)) | ||||
| 14. SubscriptionTopic.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. SubscriptionTopic.extension:versionAlgorithm | |||||
| Slice Name | versionAlgorithm | ||||
| Definition | R5: | ||||
| Short | R5: How to compare versions (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | 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. SubscriptionTopic.extension:name | |||||
| Slice Name | name | ||||
| Definition | R5: | ||||
| Short | R5: Name for this subscription topic (computer friendly) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(ArtifactName) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | 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. SubscriptionTopic.extension:copyrightLabel | |||||
| Slice Name | copyrightLabel | ||||
| Definition | R5: | ||||
| Short | R5: Copyright holder and year(s) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Copyright Label) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 22. SubscriptionTopic.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Must Support | false | ||||
| Summary | false | ||||
| 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 | ||||
| Invariants | 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. SubscriptionTopic.url | |||||
| Definition | An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers. | ||||
| Short | Canonical identifier for this subscription topic definition, represented as a URI (globally unique) | ||||
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Allows the subscription topic to be referenced by a single globally unique identifier. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. SubscriptionTopic.url.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 28. SubscriptionTopic.url.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.url.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 30. SubscriptionTopic.url.extension:url | |||||
| Slice Name | url | ||||
| Definition | R5: | ||||
| Short | R5: Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) | ||||
| Comments | Element The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. When this is a locally defined topic or derived from a topic defined in the FHIR spec or an IG, this uniquely identifies the topic and functionality. Ideally this URL resolves to documentation about the use cases. When this is a topic derived from another topic (e.g., it adds additional filters or functionality to a topic defined in an IG), then this URL should be different than the base and the When this is a direct implementation from another IG or registered topic (with no additional filters, etc., so not derived), then this url is the unique url for this topic as defined by the IG. | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact URL) (Extension Type: uri) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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. SubscriptionTopic.url.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for uri | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 34. SubscriptionTopic.identifier | |||||
| Definition | Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. | ||||
| Short | Business Identifier for this subscription topic | ||||
| Comments | Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Allows identification of the subscription topic as it is known by various participating systems and in a way that remains consistent across servers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. SubscriptionTopic.identifier.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 38. SubscriptionTopic.identifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 40. SubscriptionTopic.identifier.extension:identifier | |||||
| Slice Name | identifier | ||||
| Definition | R5: | ||||
| Short | R5: Business identifier for subscription topic | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(Artifact Identifier) (Extension Type: Identifier) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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. SubscriptionTopic.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0) | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. SubscriptionTopic.identifier.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.3.0) | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. SubscriptionTopic.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | General: http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. SubscriptionTopic.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | General: 123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. SubscriptionTopic.identifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. SubscriptionTopic.identifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. SubscriptionTopic.version | |||||
| Definition | The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. | ||||
| Short | Business version of the subscription topic | ||||
| Comments | There may be multiple different instances of a subscription topic that have the same identifier but different versions. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. SubscriptionTopic.version.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 58. SubscriptionTopic.version.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.version.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 60. SubscriptionTopic.version.extension:version | |||||
| Slice Name | version | ||||
| Definition | R5: | ||||
| Short | R5: version | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(ArtifactVersion) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 62. SubscriptionTopic.version.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Max Length: | 1048576 | ||||
| 64. SubscriptionTopic.title | |||||
| Definition | A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission". | ||||
| Short | Name for this subscription topic (Human friendly) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Alternate Names | Name, SubscriptionTopic Name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. SubscriptionTopic.title.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 68. SubscriptionTopic.title.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 70. SubscriptionTopic.title.extension:title | |||||
| Slice Name | title | ||||
| Definition | R5: | ||||
| Short | R5: Name for this subscription topic (human friendly) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Title) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 72. SubscriptionTopic.title.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Max Length: | 1048576 | ||||
| 74. SubscriptionTopic.derivedFrom | |||||
| Definition | The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic. | ||||
| Short | Based on FHIR protocol or definition | ||||
| Control | 0..* | ||||
| Type | canonical(SubscriptionTopic) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | SubscriptionTopics may be refinements of more generic topics. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. SubscriptionTopic.status | |||||
| Definition | The current state of the SubscriptionTopic. | ||||
| Short | draft | active | retired | unknown | ||||
| Comments | A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)The lifecycle status of an artifact. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired SubscriptionTopic without due consideration | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. SubscriptionTopic.status.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 80. SubscriptionTopic.status.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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. SubscriptionTopic.status.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 84. SubscriptionTopic.experimental | |||||
| Definition | A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. | ||||
| Short | If for testing purposes, not real usage | ||||
| Comments | Allows filtering of SubscriptionTopic that are appropriate for use vs. not. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use an experimental SubscriptionTopic in production. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Enables experimental content to be developed following the same life-cycle as a production-level SubscriptionTopic would. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. SubscriptionTopic.experimental.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 88. SubscriptionTopic.experimental.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.experimental.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 90. SubscriptionTopic.experimental.extension:experimental | |||||
| Slice Name | experimental | ||||
| Definition | R5: | ||||
| Short | R5: experimental | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Experimental) (Extension Type: boolean) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 92. SubscriptionTopic.experimental.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for boolean | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 94. SubscriptionTopic.date | |||||
| Definition | For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal. | ||||
| Short | Date status first applied | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Alternate Names | created | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. SubscriptionTopic.date.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 98. SubscriptionTopic.date.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.date.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 100. SubscriptionTopic.date.extension:date | |||||
| Slice Name | date | ||||
| Definition | R5: | ||||
| Short | R5: date | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Date) (Extension Type: dateTime) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 102. SubscriptionTopic.date.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for dateTime | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 104. SubscriptionTopic.publisher | |||||
| Definition | Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact. | ||||
| Short | The name of the individual or organization that published the SubscriptionTopic | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Usually an organization, but may be an individual. The publisher (or steward) of the SubscriptionTopic is the organization or individual primarily responsible for the maintenance and upkeep of the Topic. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the Topic. This item SHOULD be populated unless the information is available from context. | ||||
| Alternate Names | author | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 106. SubscriptionTopic.publisher.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 108. SubscriptionTopic.publisher.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.publisher.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 110. SubscriptionTopic.publisher.extension:publisher | |||||
| Slice Name | publisher | ||||
| Definition | R5: | ||||
| Short | R5: publisher | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Publisher) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 112. SubscriptionTopic.publisher.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Max Length: | 1048576 | ||||
| 114. SubscriptionTopic.contact | |||||
| Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||
| Short | Contact details for the publisher | ||||
| Comments | May be a web site, an email address, a telephone number, etc. | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 116. SubscriptionTopic.contact.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 118. SubscriptionTopic.contact.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 120. SubscriptionTopic.contact.extension:contact | |||||
| Slice Name | contact | ||||
| Definition | R5: | ||||
| Short | R5: contact | ||||
| Comments | Element See guidance around (not) making local changes to elements here. | ||||
| Control | 0..* | ||||
| Type | Extension(Artifact Contact) (Extension Type: ContactDetail) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 122. SubscriptionTopic.contact.name | |||||
| Definition | The name of an individual to contact. | ||||
| Short | Name of an individual to contact | ||||
| Comments | If there is no named individual, the telecom information is for the organization as a whole. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 124. SubscriptionTopic.contact.telecom | |||||
| Definition | The contact details for the individual (if a name was provided) or the organization. | ||||
| Short | Contact details for individual or organization | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 126. SubscriptionTopic.description | |||||
| Definition | A free text natural language description of the Topic from the consumer's perspective. | ||||
| Short | Natural language description of the SubscriptionTopic | ||||
| Comments | This description can be used to capture details such as why the Topic was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 128. SubscriptionTopic.description.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 130. SubscriptionTopic.description.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 132. SubscriptionTopic.description.extension:description | |||||
| Slice Name | description | ||||
| Definition | R5: | ||||
| Short | R5: description | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Description) (Extension Type: markdown) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 134. SubscriptionTopic.description.value | |||||
| Definition | Primitive value for markdown | ||||
| Short | Primitive value for markdown | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 136. SubscriptionTopic.useContext | |||||
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions. | ||||
| Short | Content intends to support these contexts | ||||
| Comments | When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply. | ||||
| Control | 0..* | ||||
| Type | UsageContext | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Assist in searching for appropriate content. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 138. SubscriptionTopic.useContext.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 140. SubscriptionTopic.useContext.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 142. SubscriptionTopic.useContext.extension:useContext | |||||
| Slice Name | useContext | ||||
| Definition | R5: | ||||
| Short | R5: useContext | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(Artifact use context) (Extension Type: UsageContext) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 144. SubscriptionTopic.useContext.code | |||||
| Definition | A code that identifies the type of context being specified by this usage context. | ||||
| Short | Type of context being specified | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from UsageContextType (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|4.3.0) | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 146. SubscriptionTopic.useContext.value[x] | |||||
| Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. | ||||
| Short | Value that defines the context | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see Context of Use ValueSet (example to http://hl7.org/fhir/ValueSet/use-context|4.3.0) | ||||
| Type | Choice of: CodeableConcept, Quantity, Range, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 148. SubscriptionTopic.jurisdiction | |||||
| Definition | A jurisdiction in which the Topic is intended to be used. | ||||
| Short | Intended jurisdiction of the SubscriptionTopic (if applicable) | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.3.0)Countries and regions within which this artifact is targeted for use. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 150. SubscriptionTopic.purpose | |||||
| Definition | Explains why this Topic is needed and why it has been designed as it has. | ||||
| Short | Why this SubscriptionTopic is defined | ||||
| Comments | This element does not describe the usage of the Topic. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Topic. | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 152. SubscriptionTopic.purpose.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 154. SubscriptionTopic.purpose.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.purpose.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 156. SubscriptionTopic.purpose.extension:purpose | |||||
| Slice Name | purpose | ||||
| Definition | R5: | ||||
| Short | R5: purpose | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Purpose) (Extension Type: markdown) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 158. SubscriptionTopic.purpose.value | |||||
| Definition | Primitive value for markdown | ||||
| Short | Primitive value for markdown | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 160. SubscriptionTopic.copyright | |||||
| Definition | A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic. | ||||
| Short | Use and/or publishing restrictions | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Consumers of the TSubscriptionTopicopic must be able to determine any legal restrictions on the use of the artifact and/or its content. | ||||
| Alternate Names | License, Restrictions | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 162. SubscriptionTopic.copyright.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 164. SubscriptionTopic.copyright.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.copyright.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 166. SubscriptionTopic.copyright.extension:copyright | |||||
| Slice Name | copyright | ||||
| Definition | R5: | ||||
| Short | R5: copyright | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Copyright) (Extension Type: markdown) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 168. SubscriptionTopic.copyright.value | |||||
| Definition | Primitive value for markdown | ||||
| Short | Primitive value for markdown | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 170. SubscriptionTopic.approvalDate | |||||
| Definition | The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||
| Short | When SubscriptionTopic is/was approved by publisher | ||||
| Comments | The date may be more recent than the approval date because of minor changes / editorial corrections. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 172. SubscriptionTopic.approvalDate.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 174. SubscriptionTopic.approvalDate.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.approvalDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 176. SubscriptionTopic.approvalDate.extension:approvalDate | |||||
| Slice Name | approvalDate | ||||
| Definition | R5: | ||||
| Short | R5: approvalDate | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Approval Date) (Extension Type: date) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 178. SubscriptionTopic.approvalDate.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for date | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 180. SubscriptionTopic.lastReviewDate | |||||
| Definition | The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. | ||||
| Short | Date the Subscription Topic was last reviewed by the publisher | ||||
| Comments | If specified, this is usually after the approval date. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 182. SubscriptionTopic.lastReviewDate.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 184. SubscriptionTopic.lastReviewDate.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.lastReviewDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 186. SubscriptionTopic.lastReviewDate.extension:lastReviewDate | |||||
| Slice Name | lastReviewDate | ||||
| Definition | R5: | ||||
| Short | R5: lastReviewDate | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Last Review Date) (Extension Type: date) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 188. SubscriptionTopic.lastReviewDate.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for date | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 190. SubscriptionTopic.effectivePeriod | |||||
| Definition | The period during which the SubscriptionTopic content was or is planned to be effective. | ||||
| Short | The effective date range for the SubscriptionTopic | ||||
| Comments | The effective period for a SubscriptionTopic determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 192. SubscriptionTopic.effectivePeriod.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 194. SubscriptionTopic.effectivePeriod.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.effectivePeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 196. SubscriptionTopic.effectivePeriod.extension:effectivePeriod | |||||
| Slice Name | effectivePeriod | ||||
| Definition | R5: | ||||
| Short | R5: effectivePeriod | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Effective Period) (Extension Type: Period) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 198. SubscriptionTopic.effectivePeriod.start | |||||
| Definition | The start of the period. The boundary is inclusive. | ||||
| Short | Starting time with inclusive boundary | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 200. SubscriptionTopic.effectivePeriod.end | |||||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
| Short | End time with inclusive boundary, if not ongoing | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 202. SubscriptionTopic.resourceTrigger | |||||
| Definition | A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification). | ||||
| Short | Definition of a resource-based trigger for the subscription topic | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | 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) | ||||
| 204. SubscriptionTopic.resourceTrigger.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 206. SubscriptionTopic.resourceTrigger.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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 208. SubscriptionTopic.resourceTrigger.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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 210. SubscriptionTopic.resourceTrigger.description | |||||
| Definition | The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state". | ||||
| Short | Text representation of the resource trigger | ||||
| Comments | Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition. | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 212. SubscriptionTopic.resourceTrigger.resource | |||||
| Definition | URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see <a href="elementdefinition-definitions.html#ElementDefinition.type.code">ElementDefinition.type.code</a>. | ||||
| Short | Data Type or Resource (reference to definition) for this trigger definition | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from FHIRDefinedType (extensible to http://hl7.org/fhir/ValueSet/defined-types|4.3.0)Either a resource or a data type, including logical model types. | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 214. SubscriptionTopic.resourceTrigger.supportedInteraction | |||||
| Definition | The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE). | ||||
| Short | create | update | delete | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from InteractionTrigger (required to http://hl7.org/fhir/ValueSet/interaction-trigger|4.3.0)FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 216. SubscriptionTopic.resourceTrigger.queryCriteria | |||||
| Definition | The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic. | ||||
| Short | Query based trigger rule | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | 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) | ||||
| 218. SubscriptionTopic.resourceTrigger.queryCriteria.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 220. SubscriptionTopic.resourceTrigger.queryCriteria.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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 222. SubscriptionTopic.resourceTrigger.queryCriteria.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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 224. SubscriptionTopic.resourceTrigger.queryCriteria.previous | |||||
| Definition | The FHIR query based rules are applied to the previous resource state (e.g., state before an update). | ||||
| Short | Rule applied to previous resource state | ||||
| Comments | The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/". | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 226. SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate | |||||
| Definition | For "create" interactions, should the "previous" criteria count as an automatic pass or an automatic fail. | ||||
| Short | test-passes | test-fails | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from CriteriaNotExistsBehavior (required to http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior|4.3.0)Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 228. SubscriptionTopic.resourceTrigger.queryCriteria.current | |||||
| Definition | The FHIR query based rules are applied to the current resource state (e.g., state after an update). | ||||
| Short | Rule applied to current resource state | ||||
| Comments | The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/". | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 230. SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete | |||||
| Definition | For "delete" interactions, should the "current" criteria count as an automatic pass or an automatic fail. | ||||
| Short | test-passes | test-fails | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from CriteriaNotExistsBehavior (required to http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior|4.3.0)Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 232. SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth | |||||
| Definition | If set to true, both current and previous criteria must evaluate true to trigger a notification for this topic. Otherwise a notification for this topic will be triggered if either one evaluates to true. | ||||
| Short | Both must be true flag | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 234. SubscriptionTopic.resourceTrigger.fhirPathCriteria | |||||
| Definition | The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic. | ||||
| Short | FHIRPath based trigger rule | ||||
| Comments | FHIRPath expression with %previous and %current vars. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 236. SubscriptionTopic.eventTrigger | |||||
| Definition | Event definition which can be used to trigger the SubscriptionTopic. | ||||
| Short | Event definitions the SubscriptionTopic | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | 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) | ||||
| 238. SubscriptionTopic.eventTrigger.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 240. SubscriptionTopic.eventTrigger.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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 242. SubscriptionTopic.eventTrigger.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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 244. SubscriptionTopic.eventTrigger.description | |||||
| Definition | The human readable description of an event to trigger a notification for the SubscriptionTopic - for example, "Patient Admission, as defined in HL7v2 via message ADT^A01". Multiple values are considered OR joined (e.g., matching any single event listed). | ||||
| Short | Text representation of the event trigger | ||||
| Comments | Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition. | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 246. SubscriptionTopic.eventTrigger.event | |||||
| Definition | A well-defined event which can be used to trigger notifications from the SubscriptionTopic. | ||||
| Short | Event which can trigger a notification from the SubscriptionTopic | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see Hl7VSEventCode (3.0.0) (example to http://terminology.hl7.org/ValueSet/v2-0003|3.0.0)FHIR Value set/code system definition for HL7 v2 table 0003 (EVENT TYPE CODE). | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 248. SubscriptionTopic.eventTrigger.resource | |||||
| Definition | URL of the Resource that is the focus type used in this event trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see <a href="elementdefinition-definitions.html#ElementDefinition.type.code">ElementDefinition.type.code</a>. | ||||
| Short | Data Type or Resource (reference to definition) for this trigger definition | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from FHIRDefinedType (extensible to http://hl7.org/fhir/ValueSet/defined-types|4.3.0)Either a resource or a data type, including logical model types. | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 250. SubscriptionTopic.canFilterBy | |||||
| Definition | List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event). | ||||
| Short | Properties by which a Subscription can filter notifications from the SubscriptionTopic | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | 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) | ||||
| 252. SubscriptionTopic.canFilterBy.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 254. SubscriptionTopic.canFilterBy.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.canFilterBy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 256. SubscriptionTopic.canFilterBy.extension:comparator | |||||
| Slice Name | comparator | ||||
| Definition | R5: | ||||
| Short | R5: eq | ne | gt | lt | ge | le | sa | eb | ap (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: eq | ne | gt | lt | ge | le | sa | eb | ap (new)) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 258. SubscriptionTopic.canFilterBy.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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 260. SubscriptionTopic.canFilterBy.description | |||||
| Definition | Description of how this filtering parameter is intended to be used. | ||||
| Short | Description of this filter parameter | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 262. SubscriptionTopic.canFilterBy.resource | |||||
| Definition | URL of the Resource that is the type used in this filter. This is the "focus" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present. | ||||
| Short | URL of the triggering Resource that this filter applies to | ||||
| Comments | URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see <a href="elementdefinition-definitions.html#ElementDefinition.type.code">ElementDefinition.type.code</a>. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from FHIRDefinedType (extensible to http://hl7.org/fhir/ValueSet/defined-types|4.3.0)Either a resource or a data type, including logical model types. | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 264. SubscriptionTopic.canFilterBy.filterParameter | |||||
| Definition | Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or topic-defined parameter (like "hub.event") which is a label for the filter. | ||||
| Short | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter | ||||
| Comments | Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 266. SubscriptionTopic.canFilterBy.filterDefinition | |||||
| Definition | Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or the officially-defined URI for a shared filter concept (like "http://example.org/concepts/shared-common-event"). | ||||
| Short | Canonical URL for a filterParameter definition | ||||
| Comments | Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 268. SubscriptionTopic.canFilterBy.modifier | |||||
| Definition | Allowable operators to apply when determining matches (Search Modifiers). If the filterParameter is a SearchParameter, this list of modifiers SHALL be a strict subset of the modifiers defined on that SearchParameter. | ||||
| Short | = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from SubscriptionSearchModifier (required to http://hl7.org/fhir/ValueSet/subscription-search-modifier|4.3.0)Operator to apply to filter label. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 270. SubscriptionTopic.canFilterBy.modifier.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 272. SubscriptionTopic.canFilterBy.modifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on SubscriptionTopic.canFilterBy.modifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 274. SubscriptionTopic.canFilterBy.modifier.extension:modifier | |||||
| Slice Name | modifier | ||||
| Definition | R5: | ||||
| Short | R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 276. SubscriptionTopic.canFilterBy.modifier.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 278. SubscriptionTopic.notificationShape | |||||
| Definition | List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic. | ||||
| Short | Properties for describing the shape of notifications generated by this topic | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | 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) | ||||
| 280. SubscriptionTopic.notificationShape.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 282. SubscriptionTopic.notificationShape.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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 284. SubscriptionTopic.notificationShape.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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 286. SubscriptionTopic.notificationShape.resource | |||||
| Definition | URL of the Resource that is the type used in this shape. This is the "focus" of the topic (or one of them if there are more than one) and the root resource for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present. | ||||
| Short | URL of the Resource that is the focus (main) resource in a notification shape | ||||
| Comments | URL of the Resource that is the type used in this shape. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see <a href="elementdefinition-definitions.html#ElementDefinition.type.code">ElementDefinition.type.code</a>. | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from FHIRDefinedType (extensible to http://hl7.org/fhir/ValueSet/defined-types|4.3.0)Either a resource or a data type, including logical model types. | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 288. SubscriptionTopic.notificationShape.include | |||||
| Definition | Search-style _include directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them. | ||||
| Short | Include directives, rooted in the resource for this shape | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 290. SubscriptionTopic.notificationShape.revInclude | |||||
| Definition | Search-style _revinclude directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them. | ||||
| Short | Reverse include directives, rooted in the resource for this shape | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change