{
"resourceType": "StructureDefinition",
"id": "SubscriptionTopic",
"meta": {
"lastUpdated": "2021-01-01T21:58:31.578+00:00"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Foundation.Other"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "business"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
"valueCode": ".status = off (just turn it off, maybe update the error message)"
},
{
"url": "http://hl7.org/fhir/build/StructureDefinition/template",
"valueString": "CanonicalResource"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/SubscriptionTopic",
"version": "4.6.0",
"name": "SubscriptionTopic",
"status": "draft",
"date": "2021-01-01T21:58:31+00:00",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"description": "Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.",
"fhirVersion": "4.6.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "SubscriptionTopic",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/CanonicalResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "CanonicalResource"
}
]
},
"derivation": "specialization",
"differential": {
"element": [
{
"id": "SubscriptionTopic",
"path": "SubscriptionTopic",
"short": "The definition of a specific topic for triggering events within the Subscriptions framework",
"definition": "Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "workflow",
"map": "Definition"
},
{
"identity": "rim",
"map": "Act[moodCode<=DEFN]"
},
{
"identity": "w5",
"map": "infrastructure.exchange"
}
]
},
{
"id": "SubscriptionTopic.url",
"path": "SubscriptionTopic.url",
"short": "Canonical identifier for this subscription topic definition, represented as a URI (globally unique)",
"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.",
"comment": "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.\n\nThe 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](resource.html#versions). \n\nIn 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](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements": "Allows the subscription topic to be referenced by a single globally unique identifier.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "SubscriptionTopic.identifier",
"path": "SubscriptionTopic.identifier",
"short": "Business Identifier for this subscription topic",
"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.",
"comment": "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). 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.",
"requirements": "Allows identification of the subscription topic as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "SubscriptionTopic.version",
"path": "SubscriptionTopic.version",
"short": "Business version of the subscription topic",
"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.",
"comment": "There may be multiple different instances of a subscription topic that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
},
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.title",
"path": "SubscriptionTopic.title",
"short": "Name for this subscription topic (Human friendly)",
"definition": "A short, descriptive, user-friendly title for the SubscriptionTopic, for example, \"admission\".",
"alias": [
"Name",
"SubscriptionTopic Name"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.title"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"id": "SubscriptionTopic.derivedFrom",
"path": "SubscriptionTopic.derivedFrom",
"short": "Based on FHIR protocol or definition",
"definition": "The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.",
"requirements": "SubscriptionTopics may be refinements of more generic topics.",
"min": 0,
"max": "*",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.derivedFromCanonical"
},
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "SubscriptionTopic.status",
"path": "SubscriptionTopic.status",
"short": "draft | active | retired | unknown",
"definition": "The current state of the SubscriptionTopic.",
"comment": "A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation\n\nUnknown 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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired SubscriptionTopic without due consideration",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": ".status"
}
]
},
{
"id": "SubscriptionTopic.experimental",
"path": "SubscriptionTopic.experimental",
"short": "If for testing purposes, not real usage",
"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.",
"comment": "Allows filtering of SubscriptionTopic that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level SubscriptionTopic would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use an experimental SubscriptionTopic in production.",
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.date",
"path": "SubscriptionTopic.date",
"short": "Date status first applied",
"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.",
"alias": [
"created"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"id": "SubscriptionTopic.publisher",
"path": "SubscriptionTopic.publisher",
"short": "The name of the individual or organization that published the SubscriptionTopic",
"definition": "Helps establish the \"authority/credibility\" of the SubscriptionTopic. May also allow for contact.",
"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.",
"alias": [
"author"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher {as string instead of CodeableConcept}"
},
{
"identity": "w5",
"map": "FiveWs.author"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"id": "SubscriptionTopic.contact",
"path": "SubscriptionTopic.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
},
{
"identity": "rim",
"map": ".participation[typeCode=CALLBCK].role"
}
]
},
{
"id": "SubscriptionTopic.description",
"path": "SubscriptionTopic.description",
"short": "Natural language description of the SubscriptionTopic",
"definition": "A free text natural language description of the Topic from the consumer's perspective.",
"comment": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "SubscriptionTopic.useContext",
"path": "SubscriptionTopic.useContext",
"short": "Content intends to support these contexts",
"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.",
"comment": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
},
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.jurisdiction",
"path": "SubscriptionTopic.jurisdiction",
"short": "Intended jurisdiction of the SubscriptionTopic (if applicable)",
"definition": "A jurisdiction in which the Topic is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use.",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
},
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.purpose",
"path": "SubscriptionTopic.purpose",
"short": "Why this SubscriptionTopic is defined",
"definition": "Explains why this Topic is needed and why it has been designed as it has.",
"comment": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode.text"
}
]
},
{
"id": "SubscriptionTopic.copyright",
"path": "SubscriptionTopic.copyright",
"short": "Use and/or publishing restrictions",
"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.",
"requirements": "Consumers of the TSubscriptionTopicopic must be able to determine any legal restrictions on the use of the artifact and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.copyright"
},
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.approvalDate",
"path": "SubscriptionTopic.approvalDate",
"short": "When SubscriptionTopic is/was approved by publisher",
"definition": "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment": "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.approvalDate"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime"
}
]
},
{
"id": "SubscriptionTopic.lastReviewDate",
"path": "SubscriptionTopic.lastReviewDate",
"short": "Date the Subscription Topic was last reviewed by the publisher",
"definition": "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comment": "If specified, this is usually after the approval date.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.lastReviewDate"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime"
}
]
},
{
"id": "SubscriptionTopic.effectivePeriod",
"path": "SubscriptionTopic.effectivePeriod",
"short": "The effective date range for the SubscriptionTopic",
"definition": "The period during which the SubscriptionTopic content was or is planned to be effective.",
"comment": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.effectivePeriod"
},
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.resourceTrigger",
"path": "SubscriptionTopic.resourceTrigger",
"short": "Definition of a resource-based trigger for the subscription topic",
"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).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.resourceTrigger.description",
"path": "SubscriptionTopic.resourceTrigger.description",
"short": "Text representation of the resource trigger",
"definition": "The human readable description of this resource trigger for the SubscriptionTopic - for example, \"An Encounter enters the 'in-progress' state\".",
"comment": "Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.resourceTrigger.resource",
"path": "SubscriptionTopic.resourceTrigger.resource",
"short": "Data Type or Resource (reference to definition) for this trigger definition",
"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 ElementDefinition.type.code.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRDefinedTypeExt"
}
],
"strength": "extensible",
"description": "Either a resource or a data type, including logical model types.",
"valueSet": "http://hl7.org/fhir/ValueSet/defined-types"
}
},
{
"id": "SubscriptionTopic.resourceTrigger.supportedInteraction",
"path": "SubscriptionTopic.resourceTrigger.supportedInteraction",
"short": "create | update | delete",
"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).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MethodCode"
}
],
"strength": "required",
"description": "FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.",
"valueSet": "http://hl7.org/fhir/ValueSet/interaction-trigger"
}
},
{
"id": "SubscriptionTopic.resourceTrigger.queryCriteria",
"path": "SubscriptionTopic.resourceTrigger.queryCriteria",
"short": "Query based trigger rule",
"definition": "The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.resourceTrigger.queryCriteria.previous",
"path": "SubscriptionTopic.resourceTrigger.queryCriteria.previous",
"short": "Rule applied to previous resource state",
"definition": "The FHIR query based rules are applied to the previous resource state (e.g., state before an update).",
"comment": "The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate",
"path": "SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate",
"short": "test-passes | test-fails",
"definition": "For \"create\" interactions, should the \"previous\" criteria count as an automatic pass or an automatic fail.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CriteriaNotExistsBehavior"
}
],
"strength": "required",
"description": "Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).",
"valueSet": "http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior"
}
},
{
"id": "SubscriptionTopic.resourceTrigger.queryCriteria.current",
"path": "SubscriptionTopic.resourceTrigger.queryCriteria.current",
"short": "Rule applied to current resource state",
"definition": "The FHIR query based rules are applied to the current resource state (e.g., state after an update).",
"comment": "The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete",
"path": "SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete",
"short": "test-passes | test-fails",
"definition": "For \"delete\" interactions, should the \"current\" criteria count as an automatic pass or an automatic fail.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CriteriaNotExistsBehavior"
}
],
"strength": "required",
"description": "Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).",
"valueSet": "http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior"
}
},
{
"id": "SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth",
"path": "SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth",
"short": "Both must be true flag",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.resourceTrigger.fhirPathCriteria",
"path": "SubscriptionTopic.resourceTrigger.fhirPathCriteria",
"short": "FHIRPath based trigger rule",
"definition": "The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.",
"comment": "FHIRPath expression with %previous and %current vars.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.eventTrigger",
"path": "SubscriptionTopic.eventTrigger",
"short": "Event definitions the SubscriptionTopic",
"definition": "Event definition which can be used to trigger the SubscriptionTopic.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.eventTrigger.description",
"path": "SubscriptionTopic.eventTrigger.description",
"short": "Text representation of the event trigger",
"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).",
"comment": "Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.eventTrigger.event",
"path": "SubscriptionTopic.eventTrigger.event",
"short": "Event which can trigger a notification from the SubscriptionTopic",
"definition": "A well-defined event which can be used to trigger notifications from the SubscriptionTopic.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionTopicEventTrigger"
}
],
"strength": "example",
"description": "FHIR Value set/code system definition for HL7 v2 table 0003 (EVENT TYPE CODE).",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0003"
}
},
{
"id": "SubscriptionTopic.eventTrigger.resource",
"path": "SubscriptionTopic.eventTrigger.resource",
"short": "Data Type or Resource (reference to definition) for this trigger definition",
"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 ElementDefinition.type.code.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRDefinedTypeExt"
}
],
"strength": "extensible",
"description": "Either a resource or a data type, including logical model types.",
"valueSet": "http://hl7.org/fhir/ValueSet/defined-types"
}
},
{
"id": "SubscriptionTopic.canFilterBy",
"path": "SubscriptionTopic.canFilterBy",
"short": "Properties by which a Subscription can filter notifications from the SubscriptionTopic",
"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).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.canFilterBy.description",
"path": "SubscriptionTopic.canFilterBy.description",
"short": "Description of this filter parameter",
"definition": "Description of how this filtering parameter is intended to be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.canFilterBy.resource",
"path": "SubscriptionTopic.canFilterBy.resource",
"short": "URL of the triggering Resource that this filter applies to",
"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.",
"comment": "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 ElementDefinition.type.code.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRDefinedTypeExt"
}
],
"strength": "extensible",
"description": "Either a resource or a data type, including logical model types.",
"valueSet": "http://hl7.org/fhir/ValueSet/defined-types"
}
},
{
"id": "SubscriptionTopic.canFilterBy.filterParameter",
"path": "SubscriptionTopic.canFilterBy.filterParameter",
"short": "Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.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.",
"comment": "Chained parameters are allowed (like \"patient.gender\") - but can not use colons or modifiers.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.canFilterBy.filterDefinition",
"path": "SubscriptionTopic.canFilterBy.filterDefinition",
"short": "Canonical URL for a filterParameter definition",
"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\").",
"comment": "Chained parameters are allowed (like \"patient.gender\") - but can not use colons or modifiers.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "SubscriptionTopic.canFilterBy.modifier",
"path": "SubscriptionTopic.canFilterBy.modifier",
"short": "= | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionTopicFilterBySearchModifier"
}
],
"strength": "required",
"description": "Operator to apply to filter label.",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-search-modifier"
},
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.notificationShape",
"path": "SubscriptionTopic.notificationShape",
"short": "Properties for describing the shape of notifications generated by this topic",
"definition": "List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.notificationShape.resource",
"path": "SubscriptionTopic.notificationShape.resource",
"short": "URL of the Resource that is the focus (main) resource in a notification shape",
"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.",
"comment": "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 ElementDefinition.type.code.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRDefinedTypeExt"
}
],
"strength": "extensible",
"description": "Either a resource or a data type, including logical model types.",
"valueSet": "http://hl7.org/fhir/ValueSet/defined-types"
},
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.notificationShape.include",
"path": "SubscriptionTopic.notificationShape.include",
"short": "Include directives, rooted in the resource for this shape",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "SubscriptionTopic.notificationShape.revInclude",
"path": "SubscriptionTopic.notificationShape.revInclude",
"short": "Reverse include directives, rooted in the resource for this shape",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
}
]
}
}