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
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-SubscriptionTopic | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_SubscriptionTopic_R4B | ||
This cross-version profile allows R5 SubscriptionTopic content to be represented via FHIR R4B SubscriptionTopic resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  SubscriptionTopic |
0..* | SubscriptionTopic(4.3.0) | The definition of a specific topic for triggering events within the Subscriptions framework | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |
| extension:name |
0..1 | string | R5: Name for this subscription topic (computer friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |
 extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
Σ | 1..1 | uri | Canonical identifier for this subscription topic definition, represented as a URI (globally unique) |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
 extension:url |
0..1 | uri | R5: Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url Constraints: ext-1 | |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
?!Σ | 0..1 | boolean | If for testing purposes, not real usage |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:experimental |
0..1 | boolean | R5: experimental URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental Constraints: ext-1 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| SubscriptionTopic.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SubscriptionTopic | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SubscriptionTopic | 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 | error | SubscriptionTopic | 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 | error | SubscriptionTopic | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SubscriptionTopic | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | SubscriptionTopic.implicitRules, SubscriptionTopic.extension, SubscriptionTopic.extension:versionAlgorithm, SubscriptionTopic.extension:name, SubscriptionTopic.extension:copyrightLabel, SubscriptionTopic.modifierExtension, SubscriptionTopic.url, SubscriptionTopic.url.extension, SubscriptionTopic.url.extension:url, SubscriptionTopic.status, SubscriptionTopic.experimental, SubscriptionTopic.experimental.extension, SubscriptionTopic.experimental.extension:experimental | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SubscriptionTopic.extension, SubscriptionTopic.extension:versionAlgorithm, SubscriptionTopic.extension:name, SubscriptionTopic.extension:copyrightLabel, SubscriptionTopic.modifierExtension, SubscriptionTopic.url.extension, SubscriptionTopic.url.extension:url, SubscriptionTopic.experimental.extension, SubscriptionTopic.experimental.extension:experimental | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SubscriptionTopic
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| SubscriptionTopic |
0..* | SubscriptionTopic(4.3.0) | The definition of a specific topic for triggering events within the Subscriptions framework | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:name |
0..1 | string | R5: Name for this subscription topic (computer friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 1..1 | uri | Canonical identifier for this subscription topic definition, represented as a URI (globally unique) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:url |
0..1 | uri | R5: Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url Constraints: ext-1 | |||||
 value |
0..1 | uri | Primitive value for uri | |||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for this subscription topic | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | R5: Business identifier for subscription topic URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the subscription topic | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:version |
0..1 | string | R5: version URL: http://hl7.org/fhir/StructureDefinition/artifact-version Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| title |
Σ | 0..1 | string | Name for this subscription topic (Human friendly) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: Name for this subscription topic (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| derivedFrom |
Σ | 0..* | canonical(SubscriptionTopic) | Based on FHIR protocol or definition | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| experimental |
?!Σ | 0..1 | boolean | If for testing purposes, not real usage | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:experimental |
0..1 | boolean | R5: experimental URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental Constraints: ext-1 | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| date |
Σ | 0..1 | dateTime | Date status first applied | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:date |
0..1 | dateTime | R5: date URL: http://hl7.org/fhir/StructureDefinition/artifact-date Constraints: ext-1 | |||||
| value |
0..1 | dateTime | Primitive value for dateTime | |||||
| publisher |
Σ | 0..1 | string | The name of the individual or organization that published the SubscriptionTopic | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:publisher |
0..1 | string | R5: publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | R5: contact URL: http://hl7.org/fhir/StructureDefinition/artifact-contact Constraints: ext-1 | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| description |
0..1 | markdown | Natural language description of the SubscriptionTopic | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:description |
0..1 | markdown | R5: description URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
| value |
0..1 | markdown | Primitive value for markdown | |||||
| useContext |
Σ | 0..* | UsageContext | Content intends to support these contexts | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | R5: useContext URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext Constraints: ext-1 | |||||
| code |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
 value[x] |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction of the SubscriptionTopic (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this SubscriptionTopic is defined | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:purpose |
0..1 | markdown | R5: purpose URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose Constraints: ext-1 | |||||
| value |
0..1 | markdown | Primitive value for markdown | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:copyright |
0..1 | markdown | R5: copyright URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright Constraints: ext-1 | |||||
| value |
0..1 | markdown | Primitive value for markdown | |||||
| approvalDate |
0..1 | date | When SubscriptionTopic is/was approved by publisher | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:approvalDate |
0..1 | date | R5: approvalDate URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate Constraints: ext-1 | |||||
| value |
0..1 | date | Primitive value for date | |||||
| lastReviewDate |
0..1 | date | Date the Subscription Topic was last reviewed by the publisher | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:lastReviewDate |
0..1 | date | R5: lastReviewDate URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate Constraints: ext-1 | |||||
| value |
0..1 | date | Primitive value for date | |||||
| effectivePeriod |
Σ | 0..1 | Period | The effective date range for the SubscriptionTopic | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:effectivePeriod |
0..1 | Period | R5: effectivePeriod URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| resourceTrigger |
Σ | 0..* | BackboneElement | Definition of a resource-based trigger for the subscription topic | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| description |
Σ | 0..1 | markdown | Text representation of the resource trigger | ||||
| resource |
Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| supportedInteraction |
Σ | 0..* | code | create | update | delete Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. | ||||
| queryCriteria |
Σ | 0..1 | BackboneElement | Query based trigger rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| previous |
Σ | 0..1 | string | Rule applied to previous resource state | ||||
| resultForCreate |
Σ | 0..1 | code | test-passes | test-fails Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). | ||||
| current |
Σ | 0..1 | string | Rule applied to current resource state | ||||
| resultForDelete |
Σ | 0..1 | code | test-passes | test-fails Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). | ||||
| requireBoth |
Σ | 0..1 | boolean | Both must be true flag | ||||
| fhirPathCriteria |
Σ | 0..1 | string | FHIRPath based trigger rule | ||||
| eventTrigger |
Σ | 0..* | BackboneElement | Event definitions the SubscriptionTopic | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| description |
Σ | 0..1 | markdown | Text representation of the event trigger | ||||
| event |
Σ | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: Hl7VSEventCode (3.0.0) (example): FHIR Value set/code system definition for HL7 v2 table 0003 (EVENT TYPE CODE). | ||||
| resource |
Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| canFilterBy |
Σ | 0..* | BackboneElement | Properties by which a Subscription can filter notifications from the SubscriptionTopic | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:comparator |
0..* | code | R5: eq | ne | gt | lt | ge | le | sa | eb | ap (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.canFilterBy.comparator Binding: SearchComparator (required): Search Comparator Codes supported in this filter. Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| description |
Σ | 0..1 | markdown | Description of this filter parameter | ||||
| resource |
Σ | 0..1 | uri | URL of the triggering Resource that this filter applies to Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| filterParameter |
Σ | 1..1 | string | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter | ||||
| filterDefinition |
Σ | 0..1 | uri | Canonical URL for a filterParameter definition | ||||
| modifier |
Σ | 0..* | code | = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type Binding: SubscriptionSearchModifier (required): Operator to apply to filter label. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:modifier |
0..* | code | R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.canFilterBy.modifier Binding: R5SearchModifierCodeForR4B (0.1.0) (required): Search Modifier Codes supported in this filter. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| notificationShape |
Σ | 0..* | BackboneElement | Properties for describing the shape of notifications generated by this topic | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| resource |
Σ | 1..1 | uri | URL of the Resource that is the focus (main) resource in a notification shape Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| include |
Σ | 0..* | string | Include directives, rooted in the resource for this shape | ||||
| revInclude |
Σ | 0..* | string | Reverse include directives, rooted in the resource for this shape | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SubscriptionTopic.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.resourceTrigger.resource | Base | extensible | FHIRDefinedType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.resourceTrigger.supportedInteraction | Base | required | Interaction Trigger | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate | Base | required | CriteriaNotExistsBehavior | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete | Base | required | CriteriaNotExistsBehavior | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.eventTrigger.event | Base | example | hl7VS-eventCode | 📍3.0.0 | THO v7.1 |
| SubscriptionTopic.eventTrigger.resource | Base | extensible | FHIRDefinedType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.canFilterBy.resource | Base | extensible | FHIRDefinedType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.canFilterBy.modifier | Base | required | Subscription Search Modifier | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.notificationShape.resource | Base | extensible | FHIRDefinedType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SubscriptionTopic | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SubscriptionTopic | 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 | error | SubscriptionTopic | 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 | error | SubscriptionTopic | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SubscriptionTopic | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | SubscriptionTopic.contained | 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)
|
| ele-1 | error | SubscriptionTopic.meta, SubscriptionTopic.implicitRules, SubscriptionTopic.language, SubscriptionTopic.text, SubscriptionTopic.extension, SubscriptionTopic.extension:versionAlgorithm, SubscriptionTopic.extension:name, SubscriptionTopic.extension:copyrightLabel, SubscriptionTopic.modifierExtension, SubscriptionTopic.url, SubscriptionTopic.url.extension, SubscriptionTopic.url.extension:url, SubscriptionTopic.identifier, SubscriptionTopic.identifier.extension, SubscriptionTopic.identifier.extension:identifier, SubscriptionTopic.identifier.use, SubscriptionTopic.identifier.type, SubscriptionTopic.identifier.system, SubscriptionTopic.identifier.value, SubscriptionTopic.identifier.period, SubscriptionTopic.identifier.assigner, SubscriptionTopic.version, SubscriptionTopic.version.extension, SubscriptionTopic.version.extension:version, SubscriptionTopic.title, SubscriptionTopic.title.extension, SubscriptionTopic.title.extension:title, SubscriptionTopic.derivedFrom, SubscriptionTopic.status, SubscriptionTopic.status.extension, SubscriptionTopic.experimental, SubscriptionTopic.experimental.extension, SubscriptionTopic.experimental.extension:experimental, SubscriptionTopic.date, SubscriptionTopic.date.extension, SubscriptionTopic.date.extension:date, SubscriptionTopic.publisher, SubscriptionTopic.publisher.extension, SubscriptionTopic.publisher.extension:publisher, SubscriptionTopic.contact, SubscriptionTopic.contact.extension, SubscriptionTopic.contact.extension:contact, SubscriptionTopic.contact.name, SubscriptionTopic.contact.telecom, SubscriptionTopic.description, SubscriptionTopic.description.extension, SubscriptionTopic.description.extension:description, SubscriptionTopic.useContext, SubscriptionTopic.useContext.extension, SubscriptionTopic.useContext.extension:useContext, SubscriptionTopic.useContext.code, SubscriptionTopic.useContext.value[x], SubscriptionTopic.jurisdiction, SubscriptionTopic.purpose, SubscriptionTopic.purpose.extension, SubscriptionTopic.purpose.extension:purpose, SubscriptionTopic.copyright, SubscriptionTopic.copyright.extension, SubscriptionTopic.copyright.extension:copyright, SubscriptionTopic.approvalDate, SubscriptionTopic.approvalDate.extension, SubscriptionTopic.approvalDate.extension:approvalDate, SubscriptionTopic.lastReviewDate, SubscriptionTopic.lastReviewDate.extension, SubscriptionTopic.lastReviewDate.extension:lastReviewDate, SubscriptionTopic.effectivePeriod, SubscriptionTopic.effectivePeriod.extension, SubscriptionTopic.effectivePeriod.extension:effectivePeriod, SubscriptionTopic.effectivePeriod.start, SubscriptionTopic.effectivePeriod.end, SubscriptionTopic.resourceTrigger, SubscriptionTopic.resourceTrigger.extension, SubscriptionTopic.resourceTrigger.modifierExtension, SubscriptionTopic.resourceTrigger.description, SubscriptionTopic.resourceTrigger.resource, SubscriptionTopic.resourceTrigger.supportedInteraction, SubscriptionTopic.resourceTrigger.queryCriteria, SubscriptionTopic.resourceTrigger.queryCriteria.extension, SubscriptionTopic.resourceTrigger.queryCriteria.modifierExtension, SubscriptionTopic.resourceTrigger.queryCriteria.previous, SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate, SubscriptionTopic.resourceTrigger.queryCriteria.current, SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete, SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth, SubscriptionTopic.resourceTrigger.fhirPathCriteria, SubscriptionTopic.eventTrigger, SubscriptionTopic.eventTrigger.extension, SubscriptionTopic.eventTrigger.modifierExtension, SubscriptionTopic.eventTrigger.description, SubscriptionTopic.eventTrigger.event, SubscriptionTopic.eventTrigger.resource, SubscriptionTopic.canFilterBy, SubscriptionTopic.canFilterBy.extension, SubscriptionTopic.canFilterBy.extension:comparator, SubscriptionTopic.canFilterBy.modifierExtension, SubscriptionTopic.canFilterBy.description, SubscriptionTopic.canFilterBy.resource, SubscriptionTopic.canFilterBy.filterParameter, SubscriptionTopic.canFilterBy.filterDefinition, SubscriptionTopic.canFilterBy.modifier, SubscriptionTopic.canFilterBy.modifier.extension, SubscriptionTopic.canFilterBy.modifier.extension:modifier, SubscriptionTopic.notificationShape, SubscriptionTopic.notificationShape.extension, SubscriptionTopic.notificationShape.modifierExtension, SubscriptionTopic.notificationShape.resource, SubscriptionTopic.notificationShape.include, SubscriptionTopic.notificationShape.revInclude | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SubscriptionTopic.extension, SubscriptionTopic.extension:versionAlgorithm, SubscriptionTopic.extension:name, SubscriptionTopic.extension:copyrightLabel, SubscriptionTopic.modifierExtension, SubscriptionTopic.url.extension, SubscriptionTopic.url.extension:url, SubscriptionTopic.identifier.extension, SubscriptionTopic.identifier.extension:identifier, SubscriptionTopic.version.extension, SubscriptionTopic.version.extension:version, SubscriptionTopic.title.extension, SubscriptionTopic.title.extension:title, SubscriptionTopic.status.extension, SubscriptionTopic.experimental.extension, SubscriptionTopic.experimental.extension:experimental, SubscriptionTopic.date.extension, SubscriptionTopic.date.extension:date, SubscriptionTopic.publisher.extension, SubscriptionTopic.publisher.extension:publisher, SubscriptionTopic.contact.extension, SubscriptionTopic.contact.extension:contact, SubscriptionTopic.description.extension, SubscriptionTopic.description.extension:description, SubscriptionTopic.useContext.extension, SubscriptionTopic.useContext.extension:useContext, SubscriptionTopic.purpose.extension, SubscriptionTopic.purpose.extension:purpose, SubscriptionTopic.copyright.extension, SubscriptionTopic.copyright.extension:copyright, SubscriptionTopic.approvalDate.extension, SubscriptionTopic.approvalDate.extension:approvalDate, SubscriptionTopic.lastReviewDate.extension, SubscriptionTopic.lastReviewDate.extension:lastReviewDate, SubscriptionTopic.effectivePeriod.extension, SubscriptionTopic.effectivePeriod.extension:effectivePeriod, SubscriptionTopic.resourceTrigger.extension, SubscriptionTopic.resourceTrigger.modifierExtension, SubscriptionTopic.resourceTrigger.queryCriteria.extension, SubscriptionTopic.resourceTrigger.queryCriteria.modifierExtension, SubscriptionTopic.eventTrigger.extension, SubscriptionTopic.eventTrigger.modifierExtension, SubscriptionTopic.canFilterBy.extension, SubscriptionTopic.canFilterBy.extension:comparator, SubscriptionTopic.canFilterBy.modifierExtension, SubscriptionTopic.canFilterBy.modifier.extension, SubscriptionTopic.canFilterBy.modifier.extension:modifier, SubscriptionTopic.notificationShape.extension, SubscriptionTopic.notificationShape.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SubscriptionTopic
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SubscriptionTopic |
0..* | SubscriptionTopic(4.3.0) | The definition of a specific topic for triggering events within the Subscriptions framework | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |
| extension:name |
0..1 | string | R5: Name for this subscription topic (computer friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
Σ | 1..1 | uri | Canonical identifier for this subscription topic definition, represented as a URI (globally unique) |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:url |
0..1 | uri | R5: Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url Constraints: ext-1 | |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
?!Σ | 0..1 | boolean | If for testing purposes, not real usage |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:experimental |
0..1 | boolean | R5: experimental URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental Constraints: ext-1 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| SubscriptionTopic.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SubscriptionTopic | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SubscriptionTopic | 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 | error | SubscriptionTopic | 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 | error | SubscriptionTopic | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SubscriptionTopic | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | SubscriptionTopic.implicitRules, SubscriptionTopic.extension, SubscriptionTopic.extension:versionAlgorithm, SubscriptionTopic.extension:name, SubscriptionTopic.extension:copyrightLabel, SubscriptionTopic.modifierExtension, SubscriptionTopic.url, SubscriptionTopic.url.extension, SubscriptionTopic.url.extension:url, SubscriptionTopic.status, SubscriptionTopic.experimental, SubscriptionTopic.experimental.extension, SubscriptionTopic.experimental.extension:experimental | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SubscriptionTopic.extension, SubscriptionTopic.extension:versionAlgorithm, SubscriptionTopic.extension:name, SubscriptionTopic.extension:copyrightLabel, SubscriptionTopic.modifierExtension, SubscriptionTopic.url.extension, SubscriptionTopic.url.extension:url, SubscriptionTopic.experimental.extension, SubscriptionTopic.experimental.extension:experimental | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from SubscriptionTopic
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| SubscriptionTopic |
0..* | SubscriptionTopic(4.3.0) | The definition of a specific topic for triggering events within the Subscriptions framework | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:name |
0..1 | string | R5: Name for this subscription topic (computer friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 1..1 | uri | Canonical identifier for this subscription topic definition, represented as a URI (globally unique) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:url |
0..1 | uri | R5: Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url Constraints: ext-1 | |||||
| value |
0..1 | uri | Primitive value for uri | |||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for this subscription topic | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | R5: Business identifier for subscription topic URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the subscription topic | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:version |
0..1 | string | R5: version URL: http://hl7.org/fhir/StructureDefinition/artifact-version Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| title |
Σ | 0..1 | string | Name for this subscription topic (Human friendly) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: Name for this subscription topic (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| derivedFrom |
Σ | 0..* | canonical(SubscriptionTopic) | Based on FHIR protocol or definition | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| experimental |
?!Σ | 0..1 | boolean | If for testing purposes, not real usage | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:experimental |
0..1 | boolean | R5: experimental URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental Constraints: ext-1 | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| date |
Σ | 0..1 | dateTime | Date status first applied | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:date |
0..1 | dateTime | R5: date URL: http://hl7.org/fhir/StructureDefinition/artifact-date Constraints: ext-1 | |||||
| value |
0..1 | dateTime | Primitive value for dateTime | |||||
| publisher |
Σ | 0..1 | string | The name of the individual or organization that published the SubscriptionTopic | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:publisher |
0..1 | string | R5: publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | R5: contact URL: http://hl7.org/fhir/StructureDefinition/artifact-contact Constraints: ext-1 | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| description |
0..1 | markdown | Natural language description of the SubscriptionTopic | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:description |
0..1 | markdown | R5: description URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
| value |
0..1 | markdown | Primitive value for markdown | |||||
| useContext |
Σ | 0..* | UsageContext | Content intends to support these contexts | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | R5: useContext URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext Constraints: ext-1 | |||||
| code |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
| value[x] |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction of the SubscriptionTopic (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this SubscriptionTopic is defined | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:purpose |
0..1 | markdown | R5: purpose URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose Constraints: ext-1 | |||||
| value |
0..1 | markdown | Primitive value for markdown | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:copyright |
0..1 | markdown | R5: copyright URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright Constraints: ext-1 | |||||
| value |
0..1 | markdown | Primitive value for markdown | |||||
| approvalDate |
0..1 | date | When SubscriptionTopic is/was approved by publisher | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:approvalDate |
0..1 | date | R5: approvalDate URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate Constraints: ext-1 | |||||
| value |
0..1 | date | Primitive value for date | |||||
| lastReviewDate |
0..1 | date | Date the Subscription Topic was last reviewed by the publisher | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:lastReviewDate |
0..1 | date | R5: lastReviewDate URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate Constraints: ext-1 | |||||
| value |
0..1 | date | Primitive value for date | |||||
| effectivePeriod |
Σ | 0..1 | Period | The effective date range for the SubscriptionTopic | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:effectivePeriod |
0..1 | Period | R5: effectivePeriod URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| resourceTrigger |
Σ | 0..* | BackboneElement | Definition of a resource-based trigger for the subscription topic | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| description |
Σ | 0..1 | markdown | Text representation of the resource trigger | ||||
| resource |
Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| supportedInteraction |
Σ | 0..* | code | create | update | delete Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. | ||||
| queryCriteria |
Σ | 0..1 | BackboneElement | Query based trigger rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| previous |
Σ | 0..1 | string | Rule applied to previous resource state | ||||
| resultForCreate |
Σ | 0..1 | code | test-passes | test-fails Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). | ||||
| current |
Σ | 0..1 | string | Rule applied to current resource state | ||||
| resultForDelete |
Σ | 0..1 | code | test-passes | test-fails Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). | ||||
| requireBoth |
Σ | 0..1 | boolean | Both must be true flag | ||||
| fhirPathCriteria |
Σ | 0..1 | string | FHIRPath based trigger rule | ||||
| eventTrigger |
Σ | 0..* | BackboneElement | Event definitions the SubscriptionTopic | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| description |
Σ | 0..1 | markdown | Text representation of the event trigger | ||||
| event |
Σ | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: Hl7VSEventCode (3.0.0) (example): FHIR Value set/code system definition for HL7 v2 table 0003 (EVENT TYPE CODE). | ||||
| resource |
Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| canFilterBy |
Σ | 0..* | BackboneElement | Properties by which a Subscription can filter notifications from the SubscriptionTopic | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:comparator |
0..* | code | R5: eq | ne | gt | lt | ge | le | sa | eb | ap (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.canFilterBy.comparator Binding: SearchComparator (required): Search Comparator Codes supported in this filter. Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| description |
Σ | 0..1 | markdown | Description of this filter parameter | ||||
| resource |
Σ | 0..1 | uri | URL of the triggering Resource that this filter applies to Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| filterParameter |
Σ | 1..1 | string | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter | ||||
| filterDefinition |
Σ | 0..1 | uri | Canonical URL for a filterParameter definition | ||||
| modifier |
Σ | 0..* | code | = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type Binding: SubscriptionSearchModifier (required): Operator to apply to filter label. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:modifier |
0..* | code | R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.canFilterBy.modifier Binding: R5SearchModifierCodeForR4B (0.1.0) (required): Search Modifier Codes supported in this filter. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| notificationShape |
Σ | 0..* | BackboneElement | Properties for describing the shape of notifications generated by this topic | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| resource |
Σ | 1..1 | uri | URL of the Resource that is the focus (main) resource in a notification shape Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| include |
Σ | 0..* | string | Include directives, rooted in the resource for this shape | ||||
| revInclude |
Σ | 0..* | string | Reverse include directives, rooted in the resource for this shape | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SubscriptionTopic.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.resourceTrigger.resource | Base | extensible | FHIRDefinedType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.resourceTrigger.supportedInteraction | Base | required | Interaction Trigger | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate | Base | required | CriteriaNotExistsBehavior | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete | Base | required | CriteriaNotExistsBehavior | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.eventTrigger.event | Base | example | hl7VS-eventCode | 📍3.0.0 | THO v7.1 |
| SubscriptionTopic.eventTrigger.resource | Base | extensible | FHIRDefinedType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.canFilterBy.resource | Base | extensible | FHIRDefinedType | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.canFilterBy.modifier | Base | required | Subscription Search Modifier | 📍4.3.0 | FHIR Std. |
| SubscriptionTopic.notificationShape.resource | Base | extensible | FHIRDefinedType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SubscriptionTopic | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SubscriptionTopic | 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 | error | SubscriptionTopic | 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 | error | SubscriptionTopic | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SubscriptionTopic | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | SubscriptionTopic.contained | 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)
|
| ele-1 | error | SubscriptionTopic.meta, SubscriptionTopic.implicitRules, SubscriptionTopic.language, SubscriptionTopic.text, SubscriptionTopic.extension, SubscriptionTopic.extension:versionAlgorithm, SubscriptionTopic.extension:name, SubscriptionTopic.extension:copyrightLabel, SubscriptionTopic.modifierExtension, SubscriptionTopic.url, SubscriptionTopic.url.extension, SubscriptionTopic.url.extension:url, SubscriptionTopic.identifier, SubscriptionTopic.identifier.extension, SubscriptionTopic.identifier.extension:identifier, SubscriptionTopic.identifier.use, SubscriptionTopic.identifier.type, SubscriptionTopic.identifier.system, SubscriptionTopic.identifier.value, SubscriptionTopic.identifier.period, SubscriptionTopic.identifier.assigner, SubscriptionTopic.version, SubscriptionTopic.version.extension, SubscriptionTopic.version.extension:version, SubscriptionTopic.title, SubscriptionTopic.title.extension, SubscriptionTopic.title.extension:title, SubscriptionTopic.derivedFrom, SubscriptionTopic.status, SubscriptionTopic.status.extension, SubscriptionTopic.experimental, SubscriptionTopic.experimental.extension, SubscriptionTopic.experimental.extension:experimental, SubscriptionTopic.date, SubscriptionTopic.date.extension, SubscriptionTopic.date.extension:date, SubscriptionTopic.publisher, SubscriptionTopic.publisher.extension, SubscriptionTopic.publisher.extension:publisher, SubscriptionTopic.contact, SubscriptionTopic.contact.extension, SubscriptionTopic.contact.extension:contact, SubscriptionTopic.contact.name, SubscriptionTopic.contact.telecom, SubscriptionTopic.description, SubscriptionTopic.description.extension, SubscriptionTopic.description.extension:description, SubscriptionTopic.useContext, SubscriptionTopic.useContext.extension, SubscriptionTopic.useContext.extension:useContext, SubscriptionTopic.useContext.code, SubscriptionTopic.useContext.value[x], SubscriptionTopic.jurisdiction, SubscriptionTopic.purpose, SubscriptionTopic.purpose.extension, SubscriptionTopic.purpose.extension:purpose, SubscriptionTopic.copyright, SubscriptionTopic.copyright.extension, SubscriptionTopic.copyright.extension:copyright, SubscriptionTopic.approvalDate, SubscriptionTopic.approvalDate.extension, SubscriptionTopic.approvalDate.extension:approvalDate, SubscriptionTopic.lastReviewDate, SubscriptionTopic.lastReviewDate.extension, SubscriptionTopic.lastReviewDate.extension:lastReviewDate, SubscriptionTopic.effectivePeriod, SubscriptionTopic.effectivePeriod.extension, SubscriptionTopic.effectivePeriod.extension:effectivePeriod, SubscriptionTopic.effectivePeriod.start, SubscriptionTopic.effectivePeriod.end, SubscriptionTopic.resourceTrigger, SubscriptionTopic.resourceTrigger.extension, SubscriptionTopic.resourceTrigger.modifierExtension, SubscriptionTopic.resourceTrigger.description, SubscriptionTopic.resourceTrigger.resource, SubscriptionTopic.resourceTrigger.supportedInteraction, SubscriptionTopic.resourceTrigger.queryCriteria, SubscriptionTopic.resourceTrigger.queryCriteria.extension, SubscriptionTopic.resourceTrigger.queryCriteria.modifierExtension, SubscriptionTopic.resourceTrigger.queryCriteria.previous, SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate, SubscriptionTopic.resourceTrigger.queryCriteria.current, SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete, SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth, SubscriptionTopic.resourceTrigger.fhirPathCriteria, SubscriptionTopic.eventTrigger, SubscriptionTopic.eventTrigger.extension, SubscriptionTopic.eventTrigger.modifierExtension, SubscriptionTopic.eventTrigger.description, SubscriptionTopic.eventTrigger.event, SubscriptionTopic.eventTrigger.resource, SubscriptionTopic.canFilterBy, SubscriptionTopic.canFilterBy.extension, SubscriptionTopic.canFilterBy.extension:comparator, SubscriptionTopic.canFilterBy.modifierExtension, SubscriptionTopic.canFilterBy.description, SubscriptionTopic.canFilterBy.resource, SubscriptionTopic.canFilterBy.filterParameter, SubscriptionTopic.canFilterBy.filterDefinition, SubscriptionTopic.canFilterBy.modifier, SubscriptionTopic.canFilterBy.modifier.extension, SubscriptionTopic.canFilterBy.modifier.extension:modifier, SubscriptionTopic.notificationShape, SubscriptionTopic.notificationShape.extension, SubscriptionTopic.notificationShape.modifierExtension, SubscriptionTopic.notificationShape.resource, SubscriptionTopic.notificationShape.include, SubscriptionTopic.notificationShape.revInclude | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SubscriptionTopic.extension, SubscriptionTopic.extension:versionAlgorithm, SubscriptionTopic.extension:name, SubscriptionTopic.extension:copyrightLabel, SubscriptionTopic.modifierExtension, SubscriptionTopic.url.extension, SubscriptionTopic.url.extension:url, SubscriptionTopic.identifier.extension, SubscriptionTopic.identifier.extension:identifier, SubscriptionTopic.version.extension, SubscriptionTopic.version.extension:version, SubscriptionTopic.title.extension, SubscriptionTopic.title.extension:title, SubscriptionTopic.status.extension, SubscriptionTopic.experimental.extension, SubscriptionTopic.experimental.extension:experimental, SubscriptionTopic.date.extension, SubscriptionTopic.date.extension:date, SubscriptionTopic.publisher.extension, SubscriptionTopic.publisher.extension:publisher, SubscriptionTopic.contact.extension, SubscriptionTopic.contact.extension:contact, SubscriptionTopic.description.extension, SubscriptionTopic.description.extension:description, SubscriptionTopic.useContext.extension, SubscriptionTopic.useContext.extension:useContext, SubscriptionTopic.purpose.extension, SubscriptionTopic.purpose.extension:purpose, SubscriptionTopic.copyright.extension, SubscriptionTopic.copyright.extension:copyright, SubscriptionTopic.approvalDate.extension, SubscriptionTopic.approvalDate.extension:approvalDate, SubscriptionTopic.lastReviewDate.extension, SubscriptionTopic.lastReviewDate.extension:lastReviewDate, SubscriptionTopic.effectivePeriod.extension, SubscriptionTopic.effectivePeriod.extension:effectivePeriod, SubscriptionTopic.resourceTrigger.extension, SubscriptionTopic.resourceTrigger.modifierExtension, SubscriptionTopic.resourceTrigger.queryCriteria.extension, SubscriptionTopic.resourceTrigger.queryCriteria.modifierExtension, SubscriptionTopic.eventTrigger.extension, SubscriptionTopic.eventTrigger.modifierExtension, SubscriptionTopic.canFilterBy.extension, SubscriptionTopic.canFilterBy.extension:comparator, SubscriptionTopic.canFilterBy.modifierExtension, SubscriptionTopic.canFilterBy.modifier.extension, SubscriptionTopic.canFilterBy.modifier.extension:modifier, SubscriptionTopic.notificationShape.extension, SubscriptionTopic.notificationShape.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SubscriptionTopic
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
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
