HL7中国发布订阅框架实施指南
2025.03.10 - release

HL7中国发布订阅框架实施指南 - Local Development build (v2025.03.10) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: 通用订阅主题本地化定义

官方URL: http://hl7.org.cn/fhir-ig/pubsub/StructureDefinition/profile-base-subscriptiontopic 版本: 2025.03.10
Draft as of 2025-03-10 机读名称: BaseSubscriptionTopic

由HL7中国设计的适用于中国健康信息化的通用订阅主题本地化定义。

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..* SubscriptionTopic 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
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... version Σ 1..1 string 主题的业务版本号
ele-1: All FHIR elements must have a @value or children
... name Σ 1..1 string 订阅主题的机读名称
ele-1: All FHIR elements must have a @value or children
... title Σ 1..1 string 订阅主题的人读名称
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code 订阅主题的状态
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... publisher Σ 1..1 string 发布者，该主题的所属组织名称
ele-1: All FHIR elements must have a @value or children
... description 0..1 markdown 关于该主题的详细描述
ele-1: All FHIR elements must have a @value or children
... approvalDate 1..1 date 该主题的批准日期
ele-1: All FHIR elements must have a @value or children
... resourceTrigger SΣ 0..1 BackboneElement 资源触发器
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... resource Σ 1..1 uri 触发通知的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding

ele-1: All FHIR elements must have a @value or children
.... supportedInteraction Σ 1..* code 触发事件通知的资源动作: create | update | delete
Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.


ele-1: All FHIR elements must have a @value or children
... eventTrigger SΣ 0..1 BackboneElement 事件触发器
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... event Σ 1..1 CodeableConcept 触发通知的事件
Binding: hl7VS-eventTypeCode (example): FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE).


ele-1: All FHIR elements must have a @value or children
.... resource Σ 1..1 uri 事件关注的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding

ele-1: All FHIR elements must have a @value or children
... canFilterBy Σ 0..* BackboneElement 可用的过滤参数
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... resource Σ 1..1 uri 过滤针对的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding

ele-1: All FHIR elements must have a @value or children
.... filterParameter Σ 1..1 string 过滤参数
ele-1: All FHIR elements must have a @value or children
.... comparator 0..* code 该过滤参数的可用比较符
Binding: SearchComparator (required): Search Comparator Codes supported in this filter.


ele-1: All FHIR elements must have a @value or children
.... modifier 0..* code 该过滤参数的可用修饰词
Binding: SearchModifierCode (required): Search Modifier Codes supported in this filter.


ele-1: All FHIR elements must have a @value or children
... notificationShape Σ 0..* BackboneElement 根据该主题生成的通知中该携带哪些资源
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... resource Σ 1..1 uri 资源类型
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding

ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SubscriptionTopic.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
SubscriptionTopic.resourceTrigger.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.resourceTrigger.supportedInteractionrequiredInteractionTrigger
http://hl7.org/fhir/ValueSet/interaction-trigger|5.0.0
from the FHIR Standard
SubscriptionTopic.eventTrigger.eventexampleHl7VSEventTypeCode
http://terminology.hl7.org/ValueSet/v2-0003
SubscriptionTopic.eventTrigger.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.canFilterBy.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.canFilterBy.comparatorrequiredSearchComparator
http://hl7.org/fhir/ValueSet/search-comparator|5.0.0
from the FHIR Standard
SubscriptionTopic.canFilterBy.modifierrequiredSearchModifierCode
http://hl7.org/fhir/ValueSet/search-modifier-code|5.0.0
from the FHIR Standard
SubscriptionTopic.notificationShape.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

该结构继承自 SubscriptionTopic 。

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..* SubscriptionTopic The definition of a specific topic for triggering events within the Subscriptions framework
... url 1..1 uri 订阅主题的全球唯一官方标识符
... version 1..1 string 主题的业务版本号
... name 1..1 string 订阅主题的机读名称
... status 1..1 code 订阅主题的状态
... publisher 1..1 string 发布者，该主题的所属组织名称
... description 0..1 markdown 关于该主题的详细描述
... approvalDate 1..1 date 该主题的批准日期
... resourceTrigger S 0..1 BackboneElement 资源触发器
.... resource 1..1 uri 触发通知的资源
.... supportedInteraction 1..* code 触发事件通知的资源动作: create | update | delete
... eventTrigger S 0..1 BackboneElement 事件触发器
.... event 1..1 CodeableConcept 触发通知的事件
.... resource 1..1 uri 事件关注的资源
... canFilterBy 0..* BackboneElement 可用的过滤参数
.... resource 1..1 uri 过滤针对的资源
.... filterParameter 1..1 string 过滤参数
.... comparator 0..* code 该过滤参数的可用比较符
.... modifier 0..* code 该过滤参数的可用修饰词
... notificationShape 0..* BackboneElement 根据该主题生成的通知中该携带哪些资源
.... resource 1..1 uri 资源类型

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..* SubscriptionTopic 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri 订阅主题的全球唯一官方标识符
... identifier Σ 0..* Identifier Business identifier for subscription topic
... version Σ 1..1 string 主题的业务版本号
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name Σ 1..1 string 订阅主题的机读名称
... title Σ 1..1 string 订阅主题的人读名称
... derivedFrom Σ 0..* canonical(SubscriptionTopic) Based on FHIR protocol or definition
... status ?!Σ 1..1 code 订阅主题的状态
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean If for testing purposes, not real usage
... date Σ 0..1 dateTime Date status first applied
... publisher Σ 1..1 string 发布者，该主题的所属组织名称
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown 关于该主题的详细描述
... useContext Σ 0..* UsageContext Content intends to support these contexts
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this SubscriptionTopic is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 1..1 date 该主题的批准日期
... lastReviewDate 0..1 date Date the Subscription Topic was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period The effective date range for the SubscriptionTopic
... resourceTrigger SΣ 0..1 BackboneElement 资源触发器
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Text representation of the resource trigger
.... resource Σ 1..1 uri 触发通知的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
.... supportedInteraction Σ 1..* 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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 SΣ 0..1 BackboneElement 事件触发器
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Text representation of the event trigger
.... event Σ 1..1 CodeableConcept 触发通知的事件
Binding: hl7VS-eventTypeCode (example): FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE).

.... resource Σ 1..1 uri 事件关注的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
... canFilterBy Σ 0..* BackboneElement 可用的过滤参数
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Description of this filter parameter
.... resource Σ 1..1 uri 过滤针对的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
.... filterParameter Σ 1..1 string 过滤参数
.... filterDefinition Σ 0..1 uri Canonical URL for a filterParameter definition
.... comparator 0..* code 该过滤参数的可用比较符
Binding: SearchComparator (required): Search Comparator Codes supported in this filter.


.... modifier 0..* code 该过滤参数的可用修饰词
Binding: SearchModifierCode (required): Search Modifier Codes supported in this filter.


... notificationShape Σ 0..* BackboneElement 根据该主题生成的通知中该携带哪些资源
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource Σ 1..1 uri 资源类型
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SubscriptionTopic.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubscriptionTopic.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
SubscriptionTopic.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
SubscriptionTopic.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubscriptionTopic.resourceTrigger.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.resourceTrigger.supportedInteractionrequiredInteractionTrigger
http://hl7.org/fhir/ValueSet/interaction-trigger|5.0.0
from the FHIR Standard
SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreaterequiredCriteriaNotExistsBehavior
http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior|5.0.0
from the FHIR Standard
SubscriptionTopic.resourceTrigger.queryCriteria.resultForDeleterequiredCriteriaNotExistsBehavior
http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior|5.0.0
from the FHIR Standard
SubscriptionTopic.eventTrigger.eventexampleHl7VSEventTypeCode
http://terminology.hl7.org/ValueSet/v2-0003
SubscriptionTopic.eventTrigger.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.canFilterBy.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.canFilterBy.comparatorrequiredSearchComparator
http://hl7.org/fhir/ValueSet/search-comparator|5.0.0
from the FHIR Standard
SubscriptionTopic.canFilterBy.modifierrequiredSearchModifierCode
http://hl7.org/fhir/ValueSet/search-modifier-code|5.0.0
from the FHIR Standard
SubscriptionTopic.notificationShape.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

该结构继承自 SubscriptionTopic 。

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 2 elements

关键元素视图

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..* SubscriptionTopic 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
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... version Σ 1..1 string 主题的业务版本号
ele-1: All FHIR elements must have a @value or children
... name Σ 1..1 string 订阅主题的机读名称
ele-1: All FHIR elements must have a @value or children
... title Σ 1..1 string 订阅主题的人读名称
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code 订阅主题的状态
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... publisher Σ 1..1 string 发布者，该主题的所属组织名称
ele-1: All FHIR elements must have a @value or children
... description 0..1 markdown 关于该主题的详细描述
ele-1: All FHIR elements must have a @value or children
... approvalDate 1..1 date 该主题的批准日期
ele-1: All FHIR elements must have a @value or children
... resourceTrigger SΣ 0..1 BackboneElement 资源触发器
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... resource Σ 1..1 uri 触发通知的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding

ele-1: All FHIR elements must have a @value or children
.... supportedInteraction Σ 1..* code 触发事件通知的资源动作: create | update | delete
Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.


ele-1: All FHIR elements must have a @value or children
... eventTrigger SΣ 0..1 BackboneElement 事件触发器
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... event Σ 1..1 CodeableConcept 触发通知的事件
Binding: hl7VS-eventTypeCode (example): FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE).


ele-1: All FHIR elements must have a @value or children
.... resource Σ 1..1 uri 事件关注的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding

ele-1: All FHIR elements must have a @value or children
... canFilterBy Σ 0..* BackboneElement 可用的过滤参数
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... resource Σ 1..1 uri 过滤针对的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding

ele-1: All FHIR elements must have a @value or children
.... filterParameter Σ 1..1 string 过滤参数
ele-1: All FHIR elements must have a @value or children
.... comparator 0..* code 该过滤参数的可用比较符
Binding: SearchComparator (required): Search Comparator Codes supported in this filter.


ele-1: All FHIR elements must have a @value or children
.... modifier 0..* code 该过滤参数的可用修饰词
Binding: SearchModifierCode (required): Search Modifier Codes supported in this filter.


ele-1: All FHIR elements must have a @value or children
... notificationShape Σ 0..* BackboneElement 根据该主题生成的通知中该携带哪些资源
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... resource Σ 1..1 uri 资源类型
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding

ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SubscriptionTopic.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
SubscriptionTopic.resourceTrigger.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.resourceTrigger.supportedInteractionrequiredInteractionTrigger
http://hl7.org/fhir/ValueSet/interaction-trigger|5.0.0
from the FHIR Standard
SubscriptionTopic.eventTrigger.eventexampleHl7VSEventTypeCode
http://terminology.hl7.org/ValueSet/v2-0003
SubscriptionTopic.eventTrigger.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.canFilterBy.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.canFilterBy.comparatorrequiredSearchComparator
http://hl7.org/fhir/ValueSet/search-comparator|5.0.0
from the FHIR Standard
SubscriptionTopic.canFilterBy.modifierrequiredSearchModifierCode
http://hl7.org/fhir/ValueSet/search-modifier-code|5.0.0
from the FHIR Standard
SubscriptionTopic.notificationShape.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

差异视图

该结构继承自 SubscriptionTopic 。

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..* SubscriptionTopic The definition of a specific topic for triggering events within the Subscriptions framework
... url 1..1 uri 订阅主题的全球唯一官方标识符
... version 1..1 string 主题的业务版本号
... name 1..1 string 订阅主题的机读名称
... status 1..1 code 订阅主题的状态
... publisher 1..1 string 发布者，该主题的所属组织名称
... description 0..1 markdown 关于该主题的详细描述
... approvalDate 1..1 date 该主题的批准日期
... resourceTrigger S 0..1 BackboneElement 资源触发器
.... resource 1..1 uri 触发通知的资源
.... supportedInteraction 1..* code 触发事件通知的资源动作: create | update | delete
... eventTrigger S 0..1 BackboneElement 事件触发器
.... event 1..1 CodeableConcept 触发通知的事件
.... resource 1..1 uri 事件关注的资源
... canFilterBy 0..* BackboneElement 可用的过滤参数
.... resource 1..1 uri 过滤针对的资源
.... filterParameter 1..1 string 过滤参数
.... comparator 0..* code 该过滤参数的可用比较符
.... modifier 0..* code 该过滤参数的可用修饰词
... notificationShape 0..* BackboneElement 根据该主题生成的通知中该携带哪些资源
.... resource 1..1 uri 资源类型

doco Documentation for this format

快照视图

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..* SubscriptionTopic 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri 订阅主题的全球唯一官方标识符
... identifier Σ 0..* Identifier Business identifier for subscription topic
... version Σ 1..1 string 主题的业务版本号
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name Σ 1..1 string 订阅主题的机读名称
... title Σ 1..1 string 订阅主题的人读名称
... derivedFrom Σ 0..* canonical(SubscriptionTopic) Based on FHIR protocol or definition
... status ?!Σ 1..1 code 订阅主题的状态
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean If for testing purposes, not real usage
... date Σ 0..1 dateTime Date status first applied
... publisher Σ 1..1 string 发布者，该主题的所属组织名称
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown 关于该主题的详细描述
... useContext Σ 0..* UsageContext Content intends to support these contexts
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this SubscriptionTopic is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 1..1 date 该主题的批准日期
... lastReviewDate 0..1 date Date the Subscription Topic was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period The effective date range for the SubscriptionTopic
... resourceTrigger SΣ 0..1 BackboneElement 资源触发器
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Text representation of the resource trigger
.... resource Σ 1..1 uri 触发通知的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
.... supportedInteraction Σ 1..* 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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 SΣ 0..1 BackboneElement 事件触发器
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Text representation of the event trigger
.... event Σ 1..1 CodeableConcept 触发通知的事件
Binding: hl7VS-eventTypeCode (example): FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE).

.... resource Σ 1..1 uri 事件关注的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
... canFilterBy Σ 0..* BackboneElement 可用的过滤参数
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Description of this filter parameter
.... resource Σ 1..1 uri 过滤针对的资源
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
.... filterParameter Σ 1..1 string 过滤参数
.... filterDefinition Σ 0..1 uri Canonical URL for a filterParameter definition
.... comparator 0..* code 该过滤参数的可用比较符
Binding: SearchComparator (required): Search Comparator Codes supported in this filter.


.... modifier 0..* code 该过滤参数的可用修饰词
Binding: SearchModifierCode (required): Search Modifier Codes supported in this filter.


... notificationShape Σ 0..* BackboneElement 根据该主题生成的通知中该携带哪些资源
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource Σ 1..1 uri 资源类型
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SubscriptionTopic.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubscriptionTopic.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
SubscriptionTopic.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
SubscriptionTopic.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubscriptionTopic.resourceTrigger.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.resourceTrigger.supportedInteractionrequiredInteractionTrigger
http://hl7.org/fhir/ValueSet/interaction-trigger|5.0.0
from the FHIR Standard
SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreaterequiredCriteriaNotExistsBehavior
http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior|5.0.0
from the FHIR Standard
SubscriptionTopic.resourceTrigger.queryCriteria.resultForDeleterequiredCriteriaNotExistsBehavior
http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior|5.0.0
from the FHIR Standard
SubscriptionTopic.eventTrigger.eventexampleHl7VSEventTypeCode
http://terminology.hl7.org/ValueSet/v2-0003
SubscriptionTopic.eventTrigger.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.canFilterBy.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard
SubscriptionTopic.canFilterBy.comparatorrequiredSearchComparator
http://hl7.org/fhir/ValueSet/search-comparator|5.0.0
from the FHIR Standard
SubscriptionTopic.canFilterBy.modifierrequiredSearchModifierCode
http://hl7.org/fhir/ValueSet/search-modifier-code|5.0.0
from the FHIR Standard
SubscriptionTopic.notificationShape.resourceextensibleSubscriptionTypes
http://hl7.org/fhir/ValueSet/subscription-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

该结构继承自 SubscriptionTopic 。

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 2 elements

 

本 Profile 的其它表示法: CSV, Excel, Schematron