Subscription

Official URL: https://roche.com/fhir/iop/StructureDefinition/rdc-Subscription				Version: 1.0.0
Parent: http://hl7.org/fhir/StructureDefinition/Subscription				Computable Name: RdcSubscription

RDC Subscription profile describes custom rules how to create a valid Subscription resource to be able to subscribe to receive notifications about created/updated resources from Roche.

It is mandatory to include this and only this profile url in the meta.profile section of the Subscription JSON (see the examples).

Formal Views of Profile Content

RdcSubscription (Subscription)	I		Subscription	There are no (further) constraints on this element Element id Subscription Short description Notification about a SubscriptionTopic Alternate names WebHook, Hook, Routing Rule Definition The subscription resource describes a particular client's request to be notified about a SubscriptionTopic. Data type Subscription Constraints 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() Mappings rim: Entity, Role, or Act,N/A w5: infrastructure.exchange
id	Σ	0..1	id	There are no (further) constraints on this element Element id Subscription.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. Data type id
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Subscription.meta Short description Metadata about the resource 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Subscription.implicitRules Short description A set of rules under which this content was created 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. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Subscription.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding IETF language tag for a human language AllLanguages (required) Additional bindings: CommonLanguages (starter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text	I	0..1	Narrative	There are no (further) constraints on this element Element id Subscription.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained	I	0..*	Resource	There are no (further) constraints on this element Element id Subscription.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources 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. 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. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Subscription.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints 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()` Mappings rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Subscription.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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). 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. 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. Data type Extension Constraints 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()` Mappings rim: N/A
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id Subscription.identifier Short description Additional identifiers (business 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. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier
name	Σ	0..1	string	Element id Subscription.name Short description Human readable name for this subscription Definition A natural language name identifying the subscription. Comments Cannot exceed 255 characters in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element id Subscription.status Short description requested \| active \| error \| off \| entered-in-error Definition The status of the subscription, which marks the server state for managing the subscription. 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. Data type code Binding The status of a subscription. SubscriptionStatusCodes (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status
topic	Σ	1..1	canonical(SubscriptionTopic)	There are no (further) constraints on this element Element id Subscription.topic Short description Reference to the subscription topic being subscribed to Definition The reference to the subscription topic to be notified about. Data type canonical(SubscriptionTopic) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x]
contact	Σ	0..0	ContactPoint	There are no (further) constraints on this element Element id Subscription.contact Short description Contact details for source (e.g. troubleshooting) Definition Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.subject[x]
end	Σ	0..0	instant	There are no (further) constraints on this element Element id Subscription.end Short description When to automatically delete the subscription Definition The time for the server to turn the subscription off. Comments The server is permitted to deviate from this time but should observe it. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.done[x]
managingEntity	Σ	0..0	Reference(CareTeam \| HealthcareService \| Organization \| RelatedPerson \| Patient \| Practitioner \| PractitionerRole)	There are no (further) constraints on this element Element id Subscription.managingEntity Short description Entity responsible for Subscription changes Definition Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose. Data type Reference(CareTeam \| HealthcareService \| Organization \| RelatedPerson \| Patient \| Practitioner \| PractitionerRole) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.author
reason	Σ	0..1	string	Element id Subscription.reason Short description Description of why this subscription was created Definition A description of why this subscription is defined. Comments Cannot exceed 2048 characters in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.why[x]
filterBy	Σ I	1..1	BackboneElement	There are no (further) constraints on this element Element id Subscription.filterBy Short description Criteria for narrowing the subscription topic stream 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). Data type BackboneElement Constraints 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()`
id		0..1	string	There are no (further) constraints on this element Element id Subscription.filterBy.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Subscription.filterBy.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints 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()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Subscription.filterBy.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints 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()` Mappings rim: N/A
resourceType	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id Subscription.filterBy.resourceType Short description Allowed Resource (reference to definition) for this Subscription filter 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. Data type uri Binding A type of resource, or a Reference (from all versions) SubscriptionTypes (extensible) Additional bindings: AllResourceTypes (ui) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
filterParameter	Σ	1..1	stringBinding	Element id Subscription.filterBy.filterParameter Short description Filter label defined in SubscriptionTopic Definition The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element. Data type string Binding Can be either "patient" or "organization" (unbound) (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
comparator	I	0..1	codeBinding	There are no (further) constraints on this element Element id Subscription.filterBy.comparator Short description eq \| ne \| gt \| lt \| ge \| le \| sa \| eb \| ap Definition Comparator applied to this filter parameter. Comments Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter. Data type code Binding Search Comparator Codes applied to this filter. SearchComparator (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
modifier	I	0..1	codeBinding	There are no (further) constraints on this element Element id Subscription.filterBy.modifier Short description missing \| exact \| contains \| not \| text \| in \| not-in \| below \| above \| type \| identifier \| of-type \| code-text \| text-advanced \| iterate Definition Modifier applied to this filter parameter. Comments Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter. Data type code Binding Search Modifier Code applied to this filter. SearchModifierCode (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
value	Σ	1..1	string	Element id Subscription.filterBy.value Short description ID of the resource Definition For filterParameter having value "organization", the value must correspond to the ID of the managing organization. For filterParameter having value "patient", the value must correspond to ID of a patient within the managing organization. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
channelType	Σ	1..1	CodingBindingFixed Value	Element id Subscription.channelType Short description Channel type for notifications Definition The type of channel to send notifications on. Only rest-hook is allowed. Data type Coding Binding The type of method used to execute a subscription. SubscriptionChannelType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value { "code": "rest-hook" }
id		0..1	id	There are no (further) constraints on this element Element id Subscription.channelType.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Subscription.channelType.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a
system	Σ	0..0	uri	There are no (further) constraints on this element Element id Subscription.channelType.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..0	string	There are no (further) constraints on this element Element id Subscription.channelType.version Short description Version of the system - if relevant 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ I	0..1	codeFixed Value	There are no (further) constraints on this element Element id Subscription.channelType.code Short description Symbol in syntax defined by the system 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). Requirements Need to refer to a particular code in the system. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value rest-hook Mappings v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ I	0..0	string	There are no (further) constraints on this element Element id Subscription.channelType.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..0	boolean	There are no (further) constraints on this element Element id Subscription.channelType.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
endpoint	Σ	1..1	url	Element id Subscription.endpoint Short description Where the channel points to Definition The url that describes the actual end-point to send notifications to. Comments Absolute URL to the endpoint to receive notifications. Must start with https:// Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
parameter		0..*	BackboneElement	There are no (further) constraints on this element Element id Subscription.parameter Short description Channel type Definition Channel-dependent information to send as part of the notification (e.g., HTTP Headers). 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id Subscription.parameter.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Subscription.parameter.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints 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()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Subscription.parameter.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints 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()` Mappings rim: N/A
name		1..1	string	There are no (further) constraints on this element Element id Subscription.parameter.name Short description Name (key) of the parameter 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
value		1..1	string	There are no (further) constraints on this element Element id Subscription.parameter.value Short description Value of the parameter to use or pass through 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...`. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
heartbeatPeriod	Σ	0..0	unsignedInt	There are no (further) constraints on this element Element id Subscription.heartbeatPeriod Short description Interval in seconds to send 'heartbeat' notification 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. Data type unsignedInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
timeout	Σ	0..1	unsignedInt	Element id Subscription.timeout Short description Timeout in seconds to attempt notification delivery Definition If present, the maximum amount of time a server will allow before failing a notification attempt. Comments Number between 10 and 20. Default is 10. Data type unsignedInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
contentType	Σ	1..1	codeBinding	Element id Subscription.contentType Short description MIME type to send, or omit for no payload Definition The MIME type to send the payload in . Only values `application/json` and `application/fhir+json` are allowed. Data type code Binding BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) MimeTypes (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
content	Σ	1..1	codeBindingFixed Value	Element id Subscription.content Short description empty \| id-only \| full-resource Definition How much of the resource content to deliver in the notification payload. Only id-only is supported Comments Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured. Data type code Binding Codes to represent how much resource content to send in the notification payload. SubscriptionPayloadContent (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value id-only
maxCount	Σ	0..1	positiveInt	Element id Subscription.maxCount Short description Maximum number of events that can be combined in a single notification 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. Comments By default this value is set to 100. You can change the value to a number higher than 100. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

Subscription
Definition	The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
Cardinality	0...*
Alias	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()
Mappings	rim: Entity, Role, or Act,N/A w5: infrastructure.exchange
Subscription.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	id
Summary	True
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.
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.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
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.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	IETF language tag for a human language AllLanguages (required)
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).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
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.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
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.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained 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.
Mappings	rim: N/A
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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
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()`
Mappings	rim: N/A
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).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content
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.
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.
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()`
Mappings	rim: N/A
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.
Cardinality	0...*
Type	Identifier
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier
Subscription.name
Definition	A natural language name identifying the subscription.
Cardinality	0...1
Type	string
Summary	True
Comments	Cannot exceed 255 characters in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.status
Definition	The status of the subscription, which marks the server state for managing the subscription.
Cardinality	1...1
Type	code
Binding	The status of a subscription. SubscriptionStatusCodes (required)
Modifier	True
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status
Subscription.topic
Definition	The reference to the subscription topic to be notified about.
Cardinality	1...1
Type	canonical(SubscriptionTopic)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.what[x]
Subscription.contact
Definition	Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Cardinality	0...0
Type	ContactPoint
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.subject[x]
Subscription.end
Definition	The time for the server to turn the subscription off.
Cardinality	0...0
Type	instant
Summary	True
Comments	The server is permitted to deviate from this time but should observe it.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.done[x]
Subscription.managingEntity
Definition	Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.
Cardinality	0...0
Type	Reference(CareTeam \| HealthcareService \| Organization \| RelatedPerson \| Patient \| Practitioner \| PractitionerRole)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.author
Subscription.reason
Definition	A description of why this subscription is defined.
Cardinality	0...1
Type	string
Summary	True
Comments	Cannot exceed 2048 characters in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.why[x]
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).
Cardinality	1...1
Type	BackboneElement
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()`
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.
Cardinality	0...1
Type	string
Mappings	rim: n/a
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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
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()`
Mappings	rim: n/a
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).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
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()`
Mappings	rim: N/A
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.
Cardinality	0...1
Type	uri
Binding	A type of resource, or a Reference (from all versions) SubscriptionTypes (extensible)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.filterBy.filterParameter
Definition	The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element.
Cardinality	1...1
Type	string
Binding	Can be either "patient" or "organization" (unbound) (required)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.filterBy.comparator
Definition	Comparator applied to this filter parameter.
Cardinality	0...1
Type	code
Binding	Search Comparator Codes applied to this filter. SearchComparator (required)
Comments	Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.filterBy.modifier
Definition	Modifier applied to this filter parameter.
Cardinality	0...1
Type	code
Binding	Search Modifier Code applied to this filter. SearchModifierCode (required)
Comments	Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.filterBy.value
Definition	For filterParameter having value "organization", the value must correspond to the ID of the managing organization. For filterParameter having value "patient", the value must correspond to ID of a patient within the managing organization.
Cardinality	1...1
Type	string
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.channelType
Definition	The type of channel to send notifications on. Only rest-hook is allowed.
Cardinality	1...1
Type	Coding
Binding	The type of method used to execute a subscription. SubscriptionChannelType (extensible)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	{ "code": "rest-hook" }
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.
Cardinality	0...1
Type	id
Mappings	rim: n/a
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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
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()`
Mappings	rim: n/a
Subscription.channelType.system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	0...0
Type	uri
Summary	True
Requirements	Need to be unambiguous about the source of the definition of the symbol.
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
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.
Cardinality	0...0
Type	string
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
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).
Cardinality	0...1
Type	code
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())`
Fixed Value	rest-hook
Mappings	v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Subscription.channelType.display
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0...0
Type	string
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())`
Mappings	v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
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).
Cardinality	0...0
Type	boolean
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.
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Subscription.endpoint
Definition	The url that describes the actual end-point to send notifications to.
Cardinality	1...1
Type	url
Summary	True
Comments	Absolute URL to the endpoint to receive notifications. Must start with https://
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.parameter
Definition	Channel-dependent information to send as part of the notification (e.g., HTTP Headers).
Cardinality	0...*
Type	BackboneElement
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
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.
Cardinality	0...1
Type	string
Mappings	rim: n/a
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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
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()`
Mappings	rim: n/a
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).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
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()`
Mappings	rim: N/A
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.
Cardinality	1...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
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...`.
Cardinality	1...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
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.
Cardinality	0...0
Type	unsignedInt
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.timeout
Definition	If present, the maximum amount of time a server will allow before failing a notification attempt.
Cardinality	0...1
Type	unsignedInt
Summary	True
Comments	Number between 10 and 20. Default is 10.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.contentType
Definition	The MIME type to send the payload in . Only values `application/json` and `application/fhir+json` are allowed.
Cardinality	1...1
Type	code
Binding	BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) MimeTypes (required)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Subscription.content
Definition	How much of the resource content to deliver in the notification payload. Only id-only is supported
Cardinality	1...1
Type	code
Binding	Codes to represent how much resource content to send in the notification payload. SubscriptionPayloadContent (required)
Summary	True
Comments	Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	id-only
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.
Cardinality	0...1
Type	positiveInt
Summary	True
Comments	By default this value is set to 100. You can change the value to a number higher than 100.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

rdc-Subscription-examples

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="rdc-Subscription" />
    <url value="https://roche.com/fhir/iop/StructureDefinition/rdc-Subscription" />
    <name value="RdcSubscription" />
    <title value="RDC Subscription" />
    <status value="active" />
    <publisher value="F. Hoffmann-La Roche AG" />
    <description value="RDC Subscription profile describes custom rules how to create a valid Subscription resource to be able to subscribe to receive notifications about created/updated resources from Roche." />
    <copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
    <fhirVersion value="5.0.0" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Subscription" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Subscription" />
    <derivation value="constraint" />
    <differential>
        <element id="Subscription.name">
            <path value="Subscription.name" />
            <comment value="Cannot exceed 255 characters in size" />
        </element>
        <element id="Subscription.contact">
            <path value="Subscription.contact" />
            <max value="0" />
        </element>
        <element id="Subscription.end">
            <path value="Subscription.end" />
            <max value="0" />
        </element>
        <element id="Subscription.managingEntity">
            <path value="Subscription.managingEntity" />
            <max value="0" />
        </element>
        <element id="Subscription.reason">
            <path value="Subscription.reason" />
            <comment value="Cannot exceed 2048 characters in size" />
        </element>
        <element id="Subscription.filterBy">
            <path value="Subscription.filterBy" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Subscription.filterBy.filterParameter">
            <path value="Subscription.filterBy.filterParameter" />
            <binding>
                <strength value="required" />
                <description value="Can be either &quot;patient&quot; or &quot;organization&quot;" />
            </binding>
        </element>
        <element id="Subscription.filterBy.value">
            <path value="Subscription.filterBy.value" />
            <short value="ID of the resource" />
            <definition value="For filterParameter having value &quot;organization&quot;, the value must correspond to the ID of the managing organization. For filterParameter having value &quot;patient&quot;, the value must correspond to ID of a patient within the managing organization." />
        </element>
        <element id="Subscription.channelType">
            <path value="Subscription.channelType" />
            <definition value="The type of channel to send notifications on. Only rest-hook is allowed." />
            <fixedCoding>
                <code value="rest-hook" />
            </fixedCoding>
        </element>
        <element id="Subscription.channelType.system">
            <path value="Subscription.channelType.system" />
            <max value="0" />
        </element>
        <element id="Subscription.channelType.version">
            <path value="Subscription.channelType.version" />
            <max value="0" />
        </element>
        <element id="Subscription.channelType.display">
            <path value="Subscription.channelType.display" />
            <max value="0" />
        </element>
        <element id="Subscription.channelType.userSelected">
            <path value="Subscription.channelType.userSelected" />
            <max value="0" />
        </element>
        <element id="Subscription.endpoint">
            <path value="Subscription.endpoint" />
            <comment value="Absolute URL to the endpoint to receive notifications. Must start with https://" />
            <min value="1" />
        </element>
        <element id="Subscription.heartbeatPeriod">
            <path value="Subscription.heartbeatPeriod" />
            <max value="0" />
        </element>
        <element id="Subscription.timeout">
            <path value="Subscription.timeout" />
            <comment value="Number between 10 and 20. Default is 10." />
        </element>
        <element id="Subscription.contentType">
            <path value="Subscription.contentType" />
            <definition value="The MIME type to send the payload in . Only values `application/json` and `application/fhir+json` are allowed." />
            <min value="1" />
        </element>
        <element id="Subscription.content">
            <path value="Subscription.content" />
            <definition value="How much of the resource content to deliver in the notification payload. Only id-only is supported" />
            <min value="1" />
            <fixedCode value="id-only" />
        </element>
        <element id="Subscription.maxCount">
            <path value="Subscription.maxCount" />
            <comment value="By default this value is set to 100. You can change the value to a number higher than 100." />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "rdc-Subscription",
    "url": "https://roche.com/fhir/iop/StructureDefinition/rdc-Subscription",
    "name": "RdcSubscription",
    "title": "RDC Subscription",
    "status": "active",
    "publisher": "F. Hoffmann-La Roche AG",
    "description": "RDC Subscription profile describes custom rules how to create a valid Subscription resource to be able to subscribe to receive notifications about created/updated resources from Roche.",
    "copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
    "fhirVersion": "5.0.0",
    "kind": "resource",
    "abstract": false,
    "type": "Subscription",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Subscription",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Subscription.name",
                "path": "Subscription.name",
                "comment": "Cannot exceed 255 characters in size"
            },
            {
                "id": "Subscription.contact",
                "path": "Subscription.contact",
                "max": "0"
            },
            {
                "id": "Subscription.end",
                "path": "Subscription.end",
                "max": "0"
            },
            {
                "id": "Subscription.managingEntity",
                "path": "Subscription.managingEntity",
                "max": "0"
            },
            {
                "id": "Subscription.reason",
                "path": "Subscription.reason",
                "comment": "Cannot exceed 2048 characters in size"
            },
            {
                "id": "Subscription.filterBy",
                "path": "Subscription.filterBy",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Subscription.filterBy.filterParameter",
                "path": "Subscription.filterBy.filterParameter",
                "binding": {
                    "strength": "required",
                    "description": "Can be either \"patient\" or \"organization\""
                }
            },
            {
                "id": "Subscription.filterBy.value",
                "path": "Subscription.filterBy.value",
                "short": "ID of the resource",
                "definition": "For filterParameter having value \"organization\", the value must correspond to the ID of the managing organization. For filterParameter having value \"patient\", the value must correspond to ID of a patient within the managing organization."
            },
            {
                "id": "Subscription.channelType",
                "path": "Subscription.channelType",
                "definition": "The type of channel to send notifications on. Only rest-hook is allowed.",
                "fixedCoding": {
                    "code": "rest-hook"
                }
            },
            {
                "id": "Subscription.channelType.system",
                "path": "Subscription.channelType.system",
                "max": "0"
            },
            {
                "id": "Subscription.channelType.version",
                "path": "Subscription.channelType.version",
                "max": "0"
            },
            {
                "id": "Subscription.channelType.display",
                "path": "Subscription.channelType.display",
                "max": "0"
            },
            {
                "id": "Subscription.channelType.userSelected",
                "path": "Subscription.channelType.userSelected",
                "max": "0"
            },
            {
                "id": "Subscription.endpoint",
                "path": "Subscription.endpoint",
                "comment": "Absolute URL to the endpoint to receive notifications. Must start with https://",
                "min": 1
            },
            {
                "id": "Subscription.heartbeatPeriod",
                "path": "Subscription.heartbeatPeriod",
                "max": "0"
            },
            {
                "id": "Subscription.timeout",
                "path": "Subscription.timeout",
                "comment": "Number between 10 and 20. Default is 10."
            },
            {
                "id": "Subscription.contentType",
                "path": "Subscription.contentType",
                "definition": "The MIME type to send the payload in . Only values `application/json` and `application/fhir+json` are allowed.",
                "min": 1
            },
            {
                "id": "Subscription.content",
                "path": "Subscription.content",
                "definition": "How much of the resource content to deliver in the notification payload. Only id-only is supported",
                "min": 1,
                "fixedCode": "id-only"
            },
            {
                "id": "Subscription.maxCount",
                "path": "Subscription.maxCount",
                "comment": "By default this value is set to 100. You can change the value to a number higher than 100."
            }
        ]
    }
}

Attribute description

Attribute	Description	Terminology reference
identifier	System/value pairs identifying the subscription. Not used by the server. Stored for the convenience of the subscriber.
name	Name of the subscription
status	Status of the subscription. For subscription creation, only the value `requested` is allowed. For subscription update, the allowed values are: `active`, `requested`, `off`. When fetching a subscription, server might also return subscription with status `error`.	status
topic	Canonical URL of the subscription topic. The subscription topic determines the resources about which the subscriber will be notified.
filterBy	Enables to filter
channelType	Only `rest-hook` is supported by the server.
endpoint	URL to which the notifications will be sent by the server. Must start with https://
parameter	Collection of name/value pairs to be added as the headers to the notification.
timeout	The maximum amount of time (in seconds) a server will allow before failing a notification attempt. Default value is 10 seconds. Allowed values are integers between 10 and 20.
contentType	`application/json` or `application/fhir+json`
content	Only `id-only` is supported by the server.
maxCount	Maximum amount of resources that can be bundled together in a single notification. Default is 100, the client can only increase this number.

Resource examples

rdc-Subscription-examples