{
"description": "The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.",
"_filename": "StructureDefinition-Subscription.json",
"package_name": "hl7.fhir.r6.examples",
"date": "2025-04-01T12:16:37+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2025-04-01T12:16:37.966+11:00"
},
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot3",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "Subscription",
"mapping": [ {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Subscription",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Foundation.Other"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "business"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "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",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "Subscription",
"min": 0,
"definition": "The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.",
"isModifier": false,
"short": "Notification about a SubscriptionTopic",
"mapping": [ {
"map": "Entity, Role, or Act,N/A",
"identity": "rim"
}, {
"map": "infrastructure.exchange",
"identity": "w5"
} ],
"mustSupport": false,
"alias": [ "WebHook", "Hook", "Routing Rule" ],
"max": "*",
"id": "Subscription",
"base": {
"max": "*",
"min": 0,
"path": "Subscription"
},
"isSummary": false
}, {
"path": "Subscription.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.id",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.implicitRules",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "Subscription.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.text",
"min": 0,
"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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Subscription.text",
"condition": [ "dom-6" ],
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Subscription.contained",
"min": 0,
"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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Subscription.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"comment": "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. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](resource.html#additional).",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Subscription.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.modifierExtension",
"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](extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Subscription.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.identifier",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional identifiers (business identifier)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Subscription.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Subscription.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.name",
"min": 0,
"definition": "A natural language name identifying the subscription.",
"isModifier": false,
"short": "Human readable name for this subscription",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.name",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.status",
"min": 1,
"definition": "The status of the subscription, which marks the server state for managing the subscription.",
"isModifier": true,
"short": "requested | active | error | off | entered-in-error",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-status|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionStatusCodes"
} ],
"description": "The status of a subscription."
},
"max": "1",
"id": "Subscription.status",
"comment": "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.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "Subscription.status"
},
"isModifierReason": "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",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.topic",
"min": 1,
"definition": "The reference to the subscription topic to be notified about.",
"isModifier": false,
"short": "Reference to the subscription topic being subscribed to",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubscriptionTopic" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.topic",
"base": {
"max": "1",
"min": 1,
"path": "Subscription.topic"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.contact",
"min": 0,
"definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"isModifier": false,
"short": "Contact details for source (e.g. troubleshooting)",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": false,
"max": "*",
"id": "Subscription.contact",
"base": {
"max": "*",
"min": 0,
"path": "Subscription.contact"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.end",
"min": 0,
"definition": "The time for the server to turn the subscription off.",
"isModifier": false,
"short": "When to automatically delete the subscription",
"mapping": [ {
"map": "FiveWs.done[x]",
"identity": "w5"
} ],
"type": [ {
"code": "instant"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.end",
"comment": "The server is permitted to deviate from this time but should observe it.",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.end"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.managingEntity",
"min": 0,
"definition": "Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.",
"isModifier": false,
"short": "Entity responsible for Subscription changes",
"mapping": [ {
"map": "FiveWs.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.managingEntity",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.managingEntity"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.reason",
"min": 0,
"definition": "A description of why this subscription is defined.",
"isModifier": false,
"short": "Description of why this subscription was created",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.reason",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.reason"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "scr-1",
"human": "Subscription filters may only contain a modifier or a comparator",
"source": "http://hl7.org/fhir/StructureDefinition/Subscription",
"severity": "error",
"expression": "(comparator.exists() and modifier.exists()).not()"
} ],
"path": "Subscription.filterBy",
"min": 0,
"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).",
"isModifier": false,
"short": "Criteria for narrowing the subscription topic stream",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Subscription.filterBy",
"base": {
"max": "*",
"min": 0,
"path": "Subscription.filterBy"
},
"isSummary": true
}, {
"path": "Subscription.filterBy.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Subscription.filterBy.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.filterBy.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Subscription.filterBy.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.filterBy.modifierExtension",
"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](extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Subscription.filterBy.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.filterBy.resource",
"min": 0,
"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.",
"isModifier": false,
"short": "Allowed Resource (reference to definition) for this Subscription filter",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRTypes"
} ],
"additional": [ {
"purpose": "ui",
"valueSet": "http://hl7.org/fhir/ValueSet/all-resource-types"
} ],
"description": "A type of resource, or a Reference (from all versions)"
},
"max": "1",
"id": "Subscription.filterBy.resource",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.filterBy.resource"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.filterBy.filterParameter",
"min": 1,
"definition": "The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element.",
"isModifier": false,
"short": "Filter label defined in SubscriptionTopic",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.filterBy.filterParameter",
"base": {
"max": "1",
"min": 1,
"path": "Subscription.filterBy.filterParameter"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.filterBy.comparator",
"min": 0,
"definition": "Comparator applied to this filter parameter.",
"isModifier": false,
"short": "eq | ne | gt | lt | ge | le | sa | eb | ap",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/search-comparator|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchComparator"
} ],
"description": "Search Comparator Codes applied to this filter."
},
"max": "1",
"id": "Subscription.filterBy.comparator",
"condition": [ "scr-1" ],
"comment": "Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.filterBy.comparator"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.filterBy.modifier",
"min": 0,
"definition": "Modifier applied to this filter parameter.",
"isModifier": false,
"short": "missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/search-modifier-code|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchModifierCode"
} ],
"description": "Search Modifier Code applied to this filter."
},
"max": "1",
"id": "Subscription.filterBy.modifier",
"condition": [ "scr-1" ],
"comment": "Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.filterBy.modifier"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.filterBy.value",
"min": 1,
"definition": "The literal value or resource path as is legal in search - for example, `Patient/123` or `le1950`.",
"isModifier": false,
"short": "Literal value or resource path",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.filterBy.value",
"base": {
"max": "1",
"min": 1,
"path": "Subscription.filterBy.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.filterBy.event",
"min": 0,
"definition": "An event filter to be applied to the topic - e.g., if a topic defined multiple event triggers, this can be used to specify a single one. Multiple values are or-joined, multiple codings within a value are and-joined.",
"isModifier": false,
"short": "Event to filter by",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0003",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionTopicEventTrigger"
} ],
"description": "FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE)."
},
"max": "*",
"id": "Subscription.filterBy.event",
"base": {
"max": "*",
"min": 0,
"path": "Subscription.filterBy.event"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.channelType",
"min": 1,
"definition": "The type of channel to send notifications on.",
"isModifier": false,
"short": "Channel type for notifications",
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-channel-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionChannelType"
} ],
"description": "The type of method used to execute a subscription."
},
"max": "1",
"id": "Subscription.channelType",
"base": {
"max": "1",
"min": 1,
"path": "Subscription.channelType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.endpoint",
"min": 0,
"definition": "The url that describes the actual end-point to send notifications to.",
"isModifier": false,
"short": "Where the channel points to",
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.endpoint",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.endpoint"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.parameter",
"min": 0,
"definition": "Channel-dependent information to send as part of the notification (e.g., HTTP Headers).",
"isModifier": false,
"short": "Channel type dependent information",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Subscription.parameter",
"comment": "Exactly what these mean depends 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.",
"base": {
"max": "*",
"min": 0,
"path": "Subscription.parameter"
},
"isSummary": false
}, {
"path": "Subscription.parameter.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Subscription.parameter.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.parameter.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Subscription.parameter.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.parameter.modifierExtension",
"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](extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Subscription.parameter.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.parameter.name",
"min": 1,
"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.",
"isModifier": false,
"short": "Name (key) of the parameter",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.parameter.name",
"base": {
"max": "1",
"min": 1,
"path": "Subscription.parameter.name"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.parameter.value",
"min": 1,
"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...`.",
"isModifier": false,
"short": "Value of the parameter to use or pass through",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.parameter.value",
"base": {
"max": "1",
"min": 1,
"path": "Subscription.parameter.value"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.heartbeatPeriod",
"min": 0,
"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.",
"isModifier": false,
"short": "Interval in seconds to send 'heartbeat' notification",
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.heartbeatPeriod",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.heartbeatPeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.timeout",
"min": 0,
"definition": "If present, the maximum amount of time a server will allow before failing a notification attempt.",
"isModifier": false,
"short": "Timeout in seconds to attempt notification delivery",
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.timeout",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.timeout"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.contentType",
"min": 0,
"definition": "The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json`. Note that:\n\n* clients may request notifications in a specific FHIR version by using the [FHIR Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json; fhirVersion=4.0`.\n\n* additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html` are defined by the Email channel.",
"isModifier": false,
"short": "MIME type to send, or omit for no payload",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The mime type of an attachment. Any valid mime type is allowed."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)"
},
"max": "1",
"id": "Subscription.contentType",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.contentType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.content",
"min": 0,
"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.",
"isModifier": false,
"short": "empty | id-only | full-resource",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-payload-content|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionPayloadContent"
} ],
"description": "Codes to represent how much resource content to send in the notification payload."
},
"max": "1",
"id": "Subscription.content",
"comment": "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.content"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Subscription.maxCount",
"min": 0,
"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.",
"isModifier": false,
"short": "Maximum number of events that can be combined in a single notification",
"type": [ {
"code": "positiveInt"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.maxCount",
"base": {
"max": "1",
"min": 0,
"path": "Subscription.maxCount"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "39df39b2-fb64-4724-986a-5ff2ca812e5a",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/Subscription",
"version": "6.0.0-ballot3",
"differential": {
"element": [ {
"path": "Subscription",
"min": 0,
"definition": "The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.",
"isModifier": false,
"short": "Notification about a SubscriptionTopic",
"mapping": [ {
"map": "infrastructure.exchange",
"identity": "w5"
}, {
"map": "N/A",
"identity": "rim"
} ],
"mustSupport": false,
"alias": [ "WebHook", "Hook", "Routing Rule" ],
"max": "*",
"id": "Subscription"
}, {
"path": "Subscription.identifier",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional identifiers (business identifier)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Subscription.identifier",
"isSummary": true
}, {
"path": "Subscription.name",
"min": 0,
"definition": "A natural language name identifying the subscription.",
"isModifier": false,
"short": "Human readable name for this subscription",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.name",
"isSummary": true
}, {
"path": "Subscription.status",
"min": 1,
"definition": "The status of the subscription, which marks the server state for managing the subscription.",
"isModifier": true,
"short": "requested | active | error | off | entered-in-error",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-status|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionStatusCodes"
} ],
"description": "The status of a subscription."
},
"max": "1",
"id": "Subscription.status",
"comment": "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.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"isModifierReason": "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",
"isSummary": true
}, {
"path": "Subscription.topic",
"min": 1,
"definition": "The reference to the subscription topic to be notified about.",
"isModifier": false,
"short": "Reference to the subscription topic being subscribed to",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubscriptionTopic" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.topic",
"isSummary": true
}, {
"path": "Subscription.contact",
"min": 0,
"definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"isModifier": false,
"short": "Contact details for source (e.g. troubleshooting)",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": false,
"max": "*",
"id": "Subscription.contact",
"isSummary": true
}, {
"path": "Subscription.end",
"min": 0,
"definition": "The time for the server to turn the subscription off.",
"isModifier": false,
"short": "When to automatically delete the subscription",
"mapping": [ {
"map": "FiveWs.done[x]",
"identity": "w5"
} ],
"type": [ {
"code": "instant"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.end",
"comment": "The server is permitted to deviate from this time but should observe it.",
"isSummary": true
}, {
"path": "Subscription.managingEntity",
"min": 0,
"definition": "Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.",
"isModifier": false,
"short": "Entity responsible for Subscription changes",
"mapping": [ {
"map": "FiveWs.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.managingEntity",
"isSummary": true
}, {
"path": "Subscription.reason",
"min": 0,
"definition": "A description of why this subscription is defined.",
"isModifier": false,
"short": "Description of why this subscription was created",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.reason",
"isSummary": true
}, {
"constraint": [ {
"key": "scr-1",
"human": "Subscription filters may only contain a modifier or a comparator",
"source": "http://hl7.org/fhir/StructureDefinition/Subscription",
"severity": "error",
"expression": "(comparator.exists() and modifier.exists()).not()"
} ],
"path": "Subscription.filterBy",
"min": 0,
"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).",
"isModifier": false,
"short": "Criteria for narrowing the subscription topic stream",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Subscription.filterBy",
"isSummary": true
}, {
"path": "Subscription.filterBy.resource",
"min": 0,
"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.",
"isModifier": false,
"short": "Allowed Resource (reference to definition) for this Subscription filter",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRTypes"
} ],
"additional": [ {
"purpose": "ui",
"valueSet": "http://hl7.org/fhir/ValueSet/all-resource-types"
} ],
"description": "A type of resource, or a Reference (from all versions)"
},
"max": "1",
"id": "Subscription.filterBy.resource",
"isSummary": true
}, {
"path": "Subscription.filterBy.filterParameter",
"min": 1,
"definition": "The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element.",
"isModifier": false,
"short": "Filter label defined in SubscriptionTopic",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.filterBy.filterParameter",
"isSummary": true
}, {
"path": "Subscription.filterBy.comparator",
"min": 0,
"definition": "Comparator applied to this filter parameter.",
"isModifier": false,
"short": "eq | ne | gt | lt | ge | le | sa | eb | ap",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/search-comparator|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchComparator"
} ],
"description": "Search Comparator Codes applied to this filter."
},
"max": "1",
"id": "Subscription.filterBy.comparator",
"condition": [ "scr-1" ],
"comment": "Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.",
"isSummary": false
}, {
"path": "Subscription.filterBy.modifier",
"min": 0,
"definition": "Modifier applied to this filter parameter.",
"isModifier": false,
"short": "missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/search-modifier-code|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchModifierCode"
} ],
"description": "Search Modifier Code applied to this filter."
},
"max": "1",
"id": "Subscription.filterBy.modifier",
"condition": [ "scr-1" ],
"comment": "Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.",
"isSummary": false
}, {
"path": "Subscription.filterBy.value",
"min": 1,
"definition": "The literal value or resource path as is legal in search - for example, `Patient/123` or `le1950`.",
"isModifier": false,
"short": "Literal value or resource path",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.filterBy.value",
"isSummary": true
}, {
"path": "Subscription.filterBy.event",
"min": 0,
"definition": "An event filter to be applied to the topic - e.g., if a topic defined multiple event triggers, this can be used to specify a single one. Multiple values are or-joined, multiple codings within a value are and-joined.",
"isModifier": false,
"short": "Event to filter by",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0003",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionTopicEventTrigger"
} ],
"description": "FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE)."
},
"max": "*",
"id": "Subscription.filterBy.event",
"isSummary": true
}, {
"path": "Subscription.channelType",
"min": 1,
"definition": "The type of channel to send notifications on.",
"isModifier": false,
"short": "Channel type for notifications",
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-channel-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionChannelType"
} ],
"description": "The type of method used to execute a subscription."
},
"max": "1",
"id": "Subscription.channelType",
"isSummary": true
}, {
"path": "Subscription.endpoint",
"min": 0,
"definition": "The url that describes the actual end-point to send notifications to.",
"isModifier": false,
"short": "Where the channel points to",
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.endpoint",
"comment": "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).",
"isSummary": true
}, {
"path": "Subscription.parameter",
"min": 0,
"definition": "Channel-dependent information to send as part of the notification (e.g., HTTP Headers).",
"isModifier": false,
"short": "Channel type dependent information",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Subscription.parameter",
"comment": "Exactly what these mean depends 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.",
"isSummary": false
}, {
"path": "Subscription.parameter.name",
"min": 1,
"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.",
"isModifier": false,
"short": "Name (key) of the parameter",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.parameter.name",
"isSummary": false
}, {
"path": "Subscription.parameter.value",
"min": 1,
"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...`.",
"isModifier": false,
"short": "Value of the parameter to use or pass through",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.parameter.value",
"isSummary": false
}, {
"path": "Subscription.heartbeatPeriod",
"min": 0,
"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.",
"isModifier": false,
"short": "Interval in seconds to send 'heartbeat' notification",
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.heartbeatPeriod",
"isSummary": true
}, {
"path": "Subscription.timeout",
"min": 0,
"definition": "If present, the maximum amount of time a server will allow before failing a notification attempt.",
"isModifier": false,
"short": "Timeout in seconds to attempt notification delivery",
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.timeout",
"isSummary": true
}, {
"path": "Subscription.contentType",
"min": 0,
"definition": "The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json`. Note that:\n\n* clients may request notifications in a specific FHIR version by using the [FHIR Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json; fhirVersion=4.0`.\n\n* additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html` are defined by the Email channel.",
"isModifier": false,
"short": "MIME type to send, or omit for no payload",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The mime type of an attachment. Any valid mime type is allowed."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)"
},
"max": "1",
"id": "Subscription.contentType",
"isSummary": true
}, {
"path": "Subscription.content",
"min": 0,
"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.",
"isModifier": false,
"short": "empty | id-only | full-resource",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-payload-content|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubscriptionPayloadContent"
} ],
"description": "Codes to represent how much resource content to send in the notification payload."
},
"max": "1",
"id": "Subscription.content",
"comment": "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
"isSummary": true
}, {
"path": "Subscription.maxCount",
"min": 0,
"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.",
"isModifier": false,
"short": "Maximum number of events that can be combined in a single notification",
"type": [ {
"code": "positiveInt"
} ],
"mustSupport": false,
"max": "1",
"id": "Subscription.maxCount",
"isSummary": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}