Generated Narrative: StructureDefinition profile-base-subscription Name Flags Card. Type Description & Constraints Subscription 0..* Subscription Notification about a SubscriptionTopic name 1..1 string 订阅的人读名称 status 1..1 code 订阅的状态 topic 1..1 canonical(SubscriptionTopic) 订阅的主题 end 0..1 instant 订阅的结束时间 filterBy 0..* BackboneElement 订阅的过滤参数 channelType 1..1 Coding 发送通知的通道类型 endpoint 0..1 url 接收通知的服务端点 parameter 0..* BackboneElement 接收通知的服务端点的相关连接参数 heartbeatPeriod 0..1 unsignedInt 心跳通知发送的间隔时间，以秒为单位 timeout 0..1 unsignedInt 通知递送的超时时间，以秒为单位 content 1..1 code 通知发送内容的载体类型: empty | id-only | full-resource maxCount 0..1 positiveInt 在单个通知中可以合并转发的最大事件数量 Documentation for this format
由HL7中国设计的适用于中国健康信息化的通用订阅本地化定义。
The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
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()
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Additional identifiers (business identifier)
A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
A natural language name identifying the subscription.
The status of the subscription, which marks the server state for managing the subscription.
A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
The reference to the subscription topic to be notified about.
Contact details for source (e.g. troubleshooting)
Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
The time for the server to turn the subscription off.
The server is permitted to deviate from this time but should observe it.
Entity responsible for Subscription changes
Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.
Description of why this subscription was created
A description of why this subscription is defined.
The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).
Subscription filters may only contain a modifier or a comparator
(comparator.exists() and modifier.exists()).not()
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Allowed Resource (reference to definition) for this Subscription filter
A resource listed in the `SubscriptionTopic` this `Subscription` references (`SubscriptionTopic.canFilterBy.resource`). This element can be used to differentiate filters for topics that include more than one resource type.
A type of resource, or a Reference (from all versions)
Filter label defined in SubscriptionTopic
The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element.
eq | ne | gt | lt | ge | le | sa | eb | ap
Comparator applied to this filter parameter.
Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.
Search Comparator Codes applied to this filter.
missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Modifier applied to this filter parameter.
Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.
Search Modifier Code applied to this filter.
The literal value or resource path as is legal in search - for example, `Patient/123` or `le1950`.
The type of channel to send notifications on.
The type of method used to execute a subscription.
The url that describes the actual end-point to send notifications to.
For rest-hook the end-point must be an `http:` or `https:` URL; for websockets, `ws:` or `wss:`; for email, a `mailto:` url; and for message the endpoint can be in any form of url the server understands (usually, `http/s`: or `mllp:`). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).
接收通知的服务端点的相关连接参数
Channel-dependent information to send as part of the notification (e.g., HTTP Headers).
Exactly what these mean depend on the channel type. They can convey additional information to the server or recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Note that names are not required to be unique, but channel definitions can impose restrictions.
Parameter name for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the name would be Authorization.
Value of the parameter to use or pass through
Parameter value for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the value would be `Bearer 0193...`.
心跳通知发送的间隔时间，以秒为单位
If present, a 'heartbeat' notification (keep-alive) is sent via this channel with an interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.
If present, the maximum amount of time a server will allow before failing a notification attempt.
MIME type to send, or omit for no payload
The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json`. Note that: * clients may request notifications in a specific FHIR version by using the [FHIR Version Parameter](http://hl7.org/fhir/R5/http.html#version-parameter) - e.g., `application/fhir+json; fhirVersion=4.0`. * additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html` are defined by the Email channel.
通知发送内容的载体类型: empty | id-only | full-resource
How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.
Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Codes to represent how much resource content to send in the notification payload.
在单个通知中可以合并转发的最大事件数量
If present, the maximum number of events that will be included in a notification bundle. Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.