UMC IDMP Request and Publish API
0.1.0 - CI Build

UMC IDMP Request and Publish API, published by Uppsala Monitoring Centre. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/ and changes regularly. See the Directory of published versions

## Resource Profile: SubscriptionIdmpEvent - Detailed Descriptions

Active as of 2025-11-19

Definitions for the Subscription-IdmpEvent resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Subscription
Definition | The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
Short | Notification about a SubscriptionTopic
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | WebHook, Hook, Routing Rule
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id 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()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Subscription.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Subscription.contained
Definition | 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.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
6. Subscription.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Subscription.status
Definition | The status of the subscription, which marks the server state for managing the subscription.
Short | requested | active | error | off | entered-in-error
Comments | 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.
Control | 1..1
Binding | The codes SHALL be taken from SubscriptionStatusCodes http://hl7.org/fhir/ValueSet/subscription-status|5.0.0 (required to `http://hl7.org/fhir/ValueSet/subscription-status|5.0.0` ) The status of a subscription.
Type | code
Is Modifier | true because 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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Subscription.topic
Definition | The reference to the subscription topic to be notified about.
Short | Available topics are found at https://idmp.who-umc.org/fhir/SubscriptionTopicReference to the subscription topic being subscribed to
Control | 1..1
Type | canonical(SubscriptionTopic)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Subscription.channelType
Definition | The type of channel to send notifications on.
Short | Channel type for notifications
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from SubscriptionChannelType http://hl7.org/fhir/ValueSet/subscription-channel-type|5.0.0 (extensible to `http://hl7.org/fhir/ValueSet/subscription-channel-type|5.0.0` ) The type of method used to execute a subscription.
Type | Coding
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Subscription.channelType.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Pattern Value | `http://terminology.hl7.org/CodeSystem/subscription-channel-type`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Subscription.channelType.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1 This element is affected by the following invariants: cod-1
Binding | The codes SHALL be taken from For codes, see Channel Type Value Set (required to `http://who-umc.org/idmp/ValueSet/channelType` )
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Subscription.endpoint
Definition | The url that describes the actual end-point to send notifications to.
Short | Where the channel points to
Comments | 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).
Control | 10..1
Type | url
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Subscription.content
Definition | 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.
Short | id-onlyempty | id-only | full-resource
Comments | Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Control | 10..1
Binding | The codes SHALL be taken from SubscriptionPayloadContent http://hl7.org/fhir/ValueSet/subscription-payload-content|5.0.0 (required to `http://hl7.org/fhir/ValueSet/subscription-payload-content|5.0.0` ) Codes to represent how much resource content to send in the notification payload.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Subscription
2. Subscription.topic
Short | Available topics are found at https://idmp.who-umc.org/fhir/SubscriptionTopic
4. Subscription.channelType
6. Subscription.channelType.system
Pattern Value | `http://terminology.hl7.org/CodeSystem/subscription-channel-type`
8. Subscription.channelType.code
Binding | The codes SHALL be taken from Channel Type Value Set (required to `http://who-umc.org/idmp/ValueSet/channelType` )
10. Subscription.endpoint
Control | 1..?
12. Subscription.content
Short | id-only
Control | 1..?

Guidance on how to interpret the contents of this table can be foundhere

0. Subscription
Definition | The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
Short | Notification about a SubscriptionTopic
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | WebHook, Hook, Routing Rule
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where((('#'+id 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()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. Subscription.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | 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.
Control | 0..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. Subscription.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Subscription.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Subscription.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Subscription.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have 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.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Subscription.contained
Definition | 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.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Subscription.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. Subscription.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Subscription.identifier
Definition | 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.
Short | Additional identifiers (business identifier)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Subscription.name
Definition | A natural language name identifying the subscription.
Short | Human readable name for this subscription
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Subscription.status
Definition | The status of the subscription, which marks the server state for managing the subscription.
Short | requested | active | error | off | entered-in-error
Comments | 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.
Control | 1..1
Binding | The codes SHALL be taken from SubscriptionStatusCodes (required to `http://hl7.org/fhir/ValueSet/subscription-status|5.0.0` ) The status of a subscription.
Type | code
Is Modifier | true because 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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Subscription.topic
Definition | The reference to the subscription topic to be notified about.
Short | Available topics are found at https://idmp.who-umc.org/fhir/SubscriptionTopic
Control | 1..1
Type | canonical(SubscriptionTopic)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Subscription.contact
Definition | Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Short | Contact details for source (e.g. troubleshooting)
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Subscription.end
Definition | The time for the server to turn the subscription off.
Short | When to automatically delete the subscription
Comments | The server is permitted to deviate from this time but should observe it.
Control | 0..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Subscription.managingEntity
Definition | Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.
Short | Entity responsible for Subscription changes
Control | 0..1
Type | Reference(CareTeam, HealthcareService, Organization, RelatedPerson, Patient, Practitioner, PractitionerRole)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Subscription.reason
Definition | A description of why this subscription is defined.
Short | Description of why this subscription was created
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Subscription.filterBy
Definition | 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).
Short | Criteria for narrowing the subscription topic stream
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) scr-1: Subscription filters may only contain a modifier or a comparator (`(comparator.exists() and modifier.exists()).not()`)
36. Subscription.filterBy.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
38. Subscription.filterBy.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
40. Subscription.filterBy.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
42. Subscription.filterBy.resourceType
Definition | 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.
Short | Allowed Resource (reference to definition) for this Subscription filter
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubscriptionTypes (extensible to `http://hl7.org/fhir/ValueSet/subscription-types|5.0.0` ) A type of resource, or a Reference (from all versions)
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Subscription.filterBy.filterParameter
Definition | The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element.
Short | Filter label defined in SubscriptionTopic
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Subscription.filterBy.comparator
Definition | Comparator applied to this filter parameter.
Short | eq | ne | gt | lt | ge | le | sa | eb | ap
Comments | Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.
Control | 0..1 This element is affected by the following invariants: scr-1
Binding | The codes SHALL be taken from SearchComparator (required to `http://hl7.org/fhir/ValueSet/search-comparator|5.0.0` ) Search Comparator Codes applied to this filter.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Subscription.filterBy.modifier
Definition | Modifier applied to this filter parameter.
Short | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Comments | Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.
Control | 0..1 This element is affected by the following invariants: scr-1
Binding | The codes SHALL be taken from SearchModifierCode (required to `http://hl7.org/fhir/ValueSet/search-modifier-code|5.0.0` ) Search Modifier Code applied to this filter.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Subscription.filterBy.value
Definition | The literal value or resource path as is legal in search - for example, `Patient/123` or `le1950`.
Short | Literal value or resource path
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Subscription.channelType
Definition | The type of channel to send notifications on.
Short | Channel type for notifications
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from SubscriptionChannelType (extensible to `http://hl7.org/fhir/ValueSet/subscription-channel-type|5.0.0` ) The type of method used to execute a subscription.
Type | Coding
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Subscription.channelType.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
56. Subscription.channelType.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Subscription.channelType.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
58. Subscription.channelType.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Pattern Value | `http://terminology.hl7.org/CodeSystem/subscription-channel-type`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Subscription.channelType.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Subscription.channelType.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1 This element is affected by the following invariants: cod-1
Binding | The codes SHALL be taken from Channel Type Value Set (required to `http://who-umc.org/idmp/ValueSet/channelType` )
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Subscription.channelType.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1 This element is affected by the following invariants: cod-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Subscription.channelType.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Subscription.endpoint
Definition | The url that describes the actual end-point to send notifications to.
Short | Where the channel points to
Comments | 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).
Control | 1..1
Type | url
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Subscription.parameter
Definition | Channel-dependent information to send as part of the notification (e.g., HTTP Headers).
Short | Channel type
Comments | 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.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Subscription.parameter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
74. Subscription.parameter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
76. Subscription.parameter.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
78. Subscription.parameter.name
Definition | 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.
Short | Name (key) of the parameter
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. Subscription.parameter.value
Definition | 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...`.
Short | Value of the parameter to use or pass through
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. Subscription.heartbeatPeriod
Definition | 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.
Short | Interval in seconds to send 'heartbeat' notification
Control | 0..1
Type | unsignedInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. Subscription.timeout
Definition | If present, the maximum amount of time a server will allow before failing a notification attempt.
Short | Timeout in seconds to attempt notification delivery
Control | 0..1
Type | unsignedInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. Subscription.contentType
Definition | 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 - 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.
Short | MIME type to send, or omit for no payload
Control | 0..1
Binding | The codes SHALL be taken from MimeTypes (required to `http://hl7.org/fhir/ValueSet/mimetypes|5.0.0` ) BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. Subscription.content
Definition | 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.
Short | id-only
Comments | Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Control | 1..1
Binding | The codes SHALL be taken from SubscriptionPayloadContent (required to `http://hl7.org/fhir/ValueSet/subscription-payload-content|5.0.0` ) Codes to represent how much resource content to send in the notification payload.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. Subscription.maxCount
Definition | 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.
Short | Maximum number of events that can be combined in a single notification
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)