StructureDefinition
for
subscription
<?xml version="1.0" encoding="UTF-8"?>
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgC
sPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAACC
ElEQVQ4y4XTv2sUQRTA8e9Mzt3kjoOLSXFgZ6GJQlALCysLC89OsLTXv0VFxE4stRAEQUghSWEXuM4qMZpATsUD70dyMdnduZ15z2
IvMV5IfDDNm5nPm59GVTkpms1mTVXvhxDuichlEZn03m+KyJL3/mWj0fiKqp7YVlZWXrfbbR2PTqeji4uLn1WVEqdECKFRr9eP5Wd
nZ/HeXwROB0TEA3S7XarVKiLC1tYW8/PzeO/5LxBCUABrLXEc02q1KJfLB30F0P144dPU9LVL1kwcrU06WP0ewhML4JwDYDgcHo7I
87wAjNq5ypU3Z8arT8F5u/xejw52zmGM+Rcg1wyIcc/BTYCdBlODyh3ElA1AHMekaUoURURRBECWZSNgaGzBxxAU9jfQ9jrJr2dcb
bXobRYHlQAzo9X1gDR9+KUArE6CwLefZD9WCW6P0uRZKreXqADkHXZ3dshzjwRholJH397AOXcTwHTfzQ1n7q6NnYEAy+DWQVNwKW
QJ6vcx557Se7HAzIN1M9rCwVteA/rAYDRRICQgSZEr7WLYO3bzJVJGQBu0D74PkoHkoBnIHvjfkO9AGABmDHCjFWgH8i7kPQh9yEe
YH4DfLhBJgA2A7BBQJ9uwXWY3rhJqFo1AaiB1CBngwKZQcqAeSFSduL9Akj7qPF64jnALS5VTPwdgPwwJ+uog9Qcx4kRZiPKqxgAA
AABJRU5ErkJggg==
Subscription : The subscription resource is used to define a push-based subscription from
a server to another system. Once a subscription is registered with the server, the server
checks every resource that is created or updated, and if the resource matches the given
criteria, it sends a message on the defined "channel" so that another system
can take an appropriate action.
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold; color:
black; background-color: #fff5e6
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4pxServer push subscription criteria
Elements defined in Ancestors:
The logical id of the resource, as used in the URL for the resource. Once assigned, this
value never changes.,
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.,
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.,
,
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.,
These resources do not have an independent existence apart from the resource that contains
them - they cannot be identified independently, and nor can they have their own independent
transaction scope.,
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 manageable, 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.,
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 manageable, 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).
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iV
BORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6
EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
Subscription.status : The status of the subscription, which marks the server state for
managing the subscription.
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4pxrequested | active | error | off
(
)
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgC
sPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,R0lGODlhEAAQAPZ/APrkusOiYvvfqbiXWaV2G+jGhdq1b8GgYf3v1frw3vTUlsWkZNewbcSjY/DQk
ad4Hb6dXv3u0f3v1ObEgfPTlerJiP3w1v79+e7OkPrfrfnjuNOtZPrpydaxa+/YrvvdpP779ZxvFPvnwKKBQaFyF/369M2vdaqHRP
z58/HNh/vowufFhfroxO3OkPrluv779tK0e6JzGProwvrow9m4eOnIifPTlPDPkP78+Naxaf3v0/zowfXRi+bFhLWUVv379/rnwPv
szv3rye3LiPvnv+3MjPDasKiIS/789/3x2f747eXDg+7Mifvu0tu7f+/QkfDTnPXWmPrjsvrjtPbPgrqZW+/QlPz48K2EMv36866O
UPvowat8Ivvgq/Pbrvzgq/PguvrgrqN0Gda2evfYm9+7d/rpw9q6e/LSku/Rl/XVl/LSlfrkt+zVqe7Wqv3x1/bNffbOf59wFdS6i
f3u0vrqyP3owPvepfXQivDQkO/PkKh9K7STVf779P///wD/ACH5BAEKAH8ALAAAAAAQABAAAAemgH+CgxeFF4OIhBdKGwFChYl/hY
wbdkoBPnaQkosbG3d3VEpSUlonUoY1Gzo6QkI8SrGxWBOFG4uySgY5ZWR3PFy2hnaWZXC/PHcPwkpJk1ShoHcxhQEXSUmtFy6+0iS
FVResrjoTPDzdcoU+F65CduVU6KAhhQa3F8Tx8nchBoYuqoTLZoAKFRIhqGwqJAULFx0GYpBQeChRIR4TJm6KJMhQRUSBAAA7
Subscription.contact : Contact details for a human to contact about the subscription.
The primary use of this for system administrator troubleshooting.
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4pxContact details for source (e.g. troubleshooting)
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iV
BORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6
EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgC
sPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iV
BORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6
EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
Subscription.criteria : The rules that the server should use to determine when to generate
notifications for this subscription.
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgC
sPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
Subscription.error : A record of the last error that occurred when the server processed
a notification.
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iV
BORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAI0lEQVR42u3QIQEAAAACIL/6/4MvTAQOkLYBAAB4kAAAANwMad9AqkR
jgNAAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUO
L+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC
data: image/png;base64,R0lGODlhEAAQAPQfAOvGUf7ztuvPMf/78/fkl/Pbg+u8Rvjqteu2Pf3zxPz36Pz0z+vTmPzurPvuw
/npofbjquvNefHVduuyN+uuMu3Oafbgjfnqvf/3zv/3xevPi+vRjP/20/bmsP///wD/ACH5BAEKAB8ALAAAAAAQABAAAAVl4CeOZG
me5qCqqDg8jyVJaz1876DsmAQAgqDgltspMEhMJoMZ4iy6I1AooFCIv+wKybziALVAoAEjYLwDgGIpJhMslgxaLR4/3rMAWoBp32V
5exg8Shl1ckRUQVaMVkQ2kCstKCEAOw==
Subscription.channel : Details where to send notifications when resources are received
that meet the criteria.
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALElEQVR42u3QwQkAMAwDsezq/WdIO4XJQwa9DTdJpulv258AAMANIgAAADUPYA
VAgAJ//usAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIZgEiYEgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAIElEQVQ4y2P8//8/AyWAiY
FCMGrAqAGjBowaMGoAAgAALL0DKYQ0DPIAAAAASUVORK5CYII=
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4pxrest-hook | websocket | email | sms | message
(
)
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iV
BORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALElEQVR42u3QwQkAMAwDsezq/WdIO4XJQwa9DTdJpulv258AAMANIgA
AADUPYAVAgAJ//usAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIZgEiYEgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAIElEQVQ4y2P8//8/AyWAiY
FCMGrAqAGjBowaMGoAAgAALL0DKYQ0DPIAAAAASUVORK5CYII=
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
Subscription.channel.endpoint : The url that describes the actual end-point to send messages
to.
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALElEQVR42u3QwQkAMAwDsezq/WdIO4XJQwa9DTdJpulv258AAMANIgAAADUPYA
VAgAJ//usAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIZgEiYEgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAIElEQVQ4y2P8//8/AyWAiY
FCMGrAqAGjBowaMGoAAgAALL0DKYQ0DPIAAAAASUVORK5CYII=
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
Subscription.channel.payload : The mime type to send the payload in - either application/fhir+xml,
or application/fhir+json. If the payload is not present, then there is no payload in the
notification, just a notification. The mime type "text/plain" may also be used
for Email and SMS subscriptions.
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4pxMIME type to send, or omit for no payload
(
)
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iV
BORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAI0lEQVR42u3QIQEAAAACIL/6/4MvTAQOkLYBAAB4kAAAANwMad9AqkR
jgNAAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIZgEiYEgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAIElEQVQ4y2P8//8/AyWAiY
FCMGrAqAGjBowaMGoAAgAALL0DKYQ0DPIAAAAASUVORK5CYII=
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUO
L+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
TRgwAAAABJRU5ErkJggg==
Subscription.channel.header : Additional headers / information to send as part of the
notification.
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
solid; padding:0px 4px 0px 4pxUsage depends on the channel type
Documentation for this format
The subscription resource is used to define a push-based subscription from a server to
another system. Once a subscription is registered with the server, the server checks every
resource that is created or updated, and if the resource matches the given criteria, it
sends a message on the defined "channel" so that another system can take an
appropriate action.
The subscription resource is used to define a push-based subscription from a server to
another system. Once a subscription is registered with the server, the server checks every
resource that is created or updated, and if the resource matches the given criteria, it
sends a message on the defined "channel" so that another system can take an
appropriate action.
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().as(canonica
l) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(refer
ence = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(c
anonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:refere
nce/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or
a meta.lastUpdated
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.
The logical id of the resource, as used in the URL for the resource. Once assigned, this
value never changes.
The only time that a resource does not have an id is when it is being submitted to the
server using a create operation.
<!-- Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic
(j) -->
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.
A reference to a set of rules that were followed when the resource was constructed, and
which must be understood when processing the content. Often, this is a reference to an
implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of
trading partners. This inherently limits the usefulness of the data in the long term.
However, the existing health eco-system is highly fractured, and not yet ready to define,
collect, and exchange data in a generally computable sense. Wherever possible, implementers
and/or specification writers should avoid using this element. Often, when used, the URL
is a reference to an implementation guide that defines these special rules as part of
it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional
knowledge about the resource that modifies it's meaning or interpretation
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).
A human-readable narrative that contains a summary of the resource and can be used to
represent the content of the resource to a human. The narrative need not encode all the
structured data, but is required to contain sufficient detail to make it "clinically
safe" for a human to just read the narrative. Resource definitions may define what
content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have
a narrative. In some cases, a resource may only have text with little or no additional
discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary
for data from legacy systems where information is captured as a "text blob"
or where text is additionally entered raw or narrated and encoded information is added
later.
These resources do not have an independent existence apart from the resource that contains
them - they cannot be identified independently, and nor can they have their own independent
transaction scope.
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.
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 manageable, there is a strict
set of governance applied to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL be met as part of the
definition of the extension.
There can be no stigma associated with the use of extensions by any application, project,
or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
The use of extensions is what allows the FHIR specification to retain a core level of
simplicity for everyone.
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 manageable, 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).
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.
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.ht
ml#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource
that contains them
A client can only submit subscription resources in the requested or off state. Only the
server can move a subscription from requested to active, and then to error. Either the
server or the client can turn a subscription off.
This element is labeled as a modifier because the status contains codes that mark the
resource as not currently valid.
This element is labelled as a modifier because it is a status element that contains status
entered-in-error which means that the resource should not be treated as valid
Contact details for a human to contact about the subscription. The primary use of this
for system administrator troubleshooting.
The rules that the server should use to determine when to generate notifications for this
subscription.
The rules are search criteria (without the [base] part). Like Bundle.entry.request.url,
it has no leading "/".
Unique id for the element within a resource (for internal references). This may be any
string value that does not contain spaces.
<!-- Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic
(j) -->
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 manageable, there is a strict set
of governance applied to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL be met as part of the
definition of the extension.
There can be no stigma associated with the use of extensions by any application, project,
or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
The use of extensions is what allows the FHIR specification to retain a core level of
simplicity for everyone.
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 manageable,
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).
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.
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.ht
ml#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element
that contains them
For rest-hook, and websocket, the end-point must be an http: or https: URL; for email,
a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of
url the server understands (usually, http: 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).
The mime type to send the payload in - either application/fhir+xml, or application/fhir+json.
If the payload is not present, then there is no payload in the notification, just a notification.
The mime type "text/plain" may also be used for Email and SMS subscriptions.
Sending the payload has obvious security implications. The server is responsible for ensuring
that the content is appropriately secured.
Exactly what these mean depend on the channel type. They can convey additional information
to the recipient and/or meet security requirements; for example, support of multiple headers
in the outgoing notifications for rest-hook type subscriptions.
The subscription resource is used to define a push-based subscription from a server to
another system. Once a subscription is registered with the server, the server checks every
resource that is created or updated, and if the resource matches the given criteria, it
sends a message on the defined "channel" so that another system can take an
appropriate action.
A client can only submit subscription resources in the requested or off state. Only the
server can move a subscription from requested to active, and then to error. Either the
server or the client can turn a subscription off.
This element is labeled as a modifier because the status contains codes that mark the
resource as not currently valid.
This element is labelled as a modifier because it is a status element that contains status
entered-in-error which means that the resource should not be treated as valid
Contact details for a human to contact about the subscription. The primary use of this
for system administrator troubleshooting.
The rules that the server should use to determine when to generate notifications for this
subscription.
The rules are search criteria (without the [base] part). Like Bundle.entry.request.url,
it has no leading "/".
For rest-hook, and websocket, the end-point must be an http: or https: URL; for email,
a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of
url the server understands (usually, http: 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).
The mime type to send the payload in - either application/fhir+xml, or application/fhir+json.
If the payload is not present, then there is no payload in the notification, just a notification.
The mime type "text/plain" may also be used for Email and SMS subscriptions.
Sending the payload has obvious security implications. The server is responsible for ensuring
that the content is appropriately secured.
Exactly what these mean depend on the channel type. They can convey additional information
to the recipient and/or meet security requirements; for example, support of multiple headers
in the outgoing notifications for rest-hook type subscriptions.
<?xml version="1.0" encoding="UTF-8"?>
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Subscription"/> <meta> <lastUpdated value="2025-12-18T07:07:42.170+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
top;">
<tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
top">
<th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px; width: 100px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a> <span style="float: right"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> </a> </span> </th> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAg
DsHd9/w4EQIOamFnaBgAA4MMKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Resource"/> <span title="Subscription : The subscription resource describes a particular client's request
to be notified about a SubscriptionTopic.">Subscription</span>
<a name="Subscription"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="versions.html#std-process" style="padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold;
color: black; background-color: #e6ffe6; padding-left: 3px; padding-right: 3px;
border: 1px grey solid; font-weight: bold; color: black; background-color: #e6ffe6" title="Standards Status = Normative">N</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="domainresource.html">DomainResource</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Information about a request for notifications to a client based on a SubscriptionTopic
<br/> <br/> Elements defined in Ancestors: <a href="resource.html#Resource" title="The logical id of the resource, as used in the URL for the resource. Once assigned,
this value never changes.">id</a> ,
<a href="resource.html#Resource" title="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.">meta</a> ,
<a href="resource.html#Resource" title="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. For DomainResources, if more than one implicitRules policy applies, additional
policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fh
ir-extensions/StructureDefinition-additionalImplicitRules.html) extension.">implicitRules</a> ,
<a href="resource.html#Resource" title="The base language in which the resource is written.">language</a> , <a href="domainresource.html#DomainResource" title="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.">text</a> ,
<a href="domainresource.html#DomainResource" title="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.">contained</a> ,
<a href="domainresource.html#DomainResource" title="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.">extension</a> ,
<a href="domainresource.html#DomainResource" title="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).">modifierExtension</a>
</td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Data Type"/> <span title="Subscription.identifier : A formal identifier that is used to identify this code
system when it is represented in other formats, or referenced in a specification,
model, design or an instance.">identifier</span>
<a name="Subscription.identifier"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..*</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#Identifier">Identifier</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Additional identifiers (business identifier)
<br/> <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.name : A natural language name identifying the subscription.">name</span> <a name="Subscription.name"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Human readable name for this subscription
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.status : The status of the subscription, which marks the server state
for managing the subscription.">status</span>
<a name="Subscription.status"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="conformance-rules.html#isModifier" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is a modifier element">?!</a>
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">1..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">requested | active | error | off | entered-in-error
<br/> Binding: <a href="valueset-subscription-status.html">Subscription Status</a> ( <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value
set.">Required</a> )
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Reference to another Resource"/> <span title="Subscription.topic : The reference to the subscription topic to be notified about.">topic</span> <a name="Subscription.topic"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">1..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#canonical">canonical</a> ( <a href="subscriptiontopic.html">SubscriptionTopic</a> ) </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Reference to the subscription topic being subscribed to
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Data Type"/> <span title="Subscription.contact : Contact details for a human to contact about the subscription.
The primary use of this for system administrator troubleshooting.">contact</span>
<a name="Subscription.contact"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..*</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#ContactPoint">ContactPoint</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Contact details for source (e.g. troubleshooting)
<br/> <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.end : The time for the server to turn the subscription off.">end</span> <a name="Subscription.end"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#instant">instant</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">When to automatically delete the subscription
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Reference to another Resource"/> <span title="Subscription.managingEntity : Entity with authorization to communicate with the
server about this Subscription, such as requesting changes (e.g., updating an endpoint
URL).">managingEntity</span>
<a name="Subscription.managingEntity"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="references.html#Reference">Reference</a> ( <a href="careteam.html">CareTeam</a> | <a href="device.html">Device</a> | <a href="group.html">Group</a> | <a href="healthcareservice.html">HealthcareService</a> | <a href="organization.html">Organization</a> | <a href="relatedperson.html">RelatedPerson</a> | <a href="patient.html">Patient</a> | <a href="practitioner.html">Practitioner</a> | <a href="practitionerrole.html">PractitionerRole</a> ) </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Entity responsible for Subscription changes
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.reason : A description of why this subscription is defined.">reason</span> <a name="Subscription.reason"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Description of why this subscription was created
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Element"/> <span title="Subscription.filterBy : 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).">filterBy</span>
<a name="Subscription.filterBy"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
<a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold;
color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px;
border: 1px maroon solid; font-weight: bold; color: #301212; background-color:
#fdf4f4;" title="This element has or is affected by some invariants">C</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..*</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="types.html#BackBoneElement">BackboneElement</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Criteria for narrowing the subscription topic stream
<br/> <span style="font-style: italic" title="scr-1">+ Rule: Subscription filters may only contain a modifier or a comparator</span> <br/> <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAMUlEQVR4Xu3LMQoAIBA
Dwftr/v8GtdbqEAthAtMspJJUx9rYW8ftHwAA+NcRAAAAXplLq0BWj/rZigAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.filterBy.resource : 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.">resource</span>
<a name="Subscription.filterBy.resource"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#uri">uri</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Allowed Resource (reference to definition) for this Subscription filter
<br/> Binding: <a href="valueset-subscription-types.html">Types used with Subscriptions</a> ( <a href="terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value
set if any of the codes within the value set can apply to the concept being communicated.
If the value set does not cover the concept (based on human review), alternate
codings (or, data type allowing, text) may be included instead.">Extensible</a> )
<table class="binding grid"> <tr> <td style="font-size: 11px"> <b> Additional Bindings</b> </td> <td style="font-size: 11px">Purpose</td> </tr> <tr> <td style="font-size: 11px"> <a href="valueset-all-resource-types.html">All Resource Types</a> </td> <td style="font-size: 11px"> <a href="valueset-additional-binding-purpose.html#additional-binding-purpose-ui" title="This value set is provided to user look up in a given context">UI Binding</a> </td> </tr> </table> <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAMUlEQVR4Xu3LMQoAIBA
Dwftr/v8GtdbqEAthAtMspJJUx9rYW8ftHwAA+NcRAAAAXplLq0BWj/rZigAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.filterBy.filterParameter : The filter as defined in the `SubscriptionTopic.canFi
lterBy.filterParameter` element.">filterParameter</span>
<a name="Subscription.filterBy.filterParameter"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">1..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Filter label defined in SubscriptionTopic
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAMUlEQVR4Xu3LMQoAIBA
Dwftr/v8GtdbqEAthAtMspJJUx9rYW8ftHwAA+NcRAAAAXplLq0BWj/rZigAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.filterBy.comparator : Comparator applied to this filter parameter.">comparator</span> <a name="Subscription.filterBy.comparator"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold;
color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px;
border: 1px maroon solid; font-weight: bold; color: #301212; background-color:
#fdf4f4;" title="This element has or is affected by some invariants">C</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">eq | ne | gt | lt | ge | le | sa | eb | ap
<br/> Binding: <a href="valueset-search-comparator.html">Search Comparator</a> ( <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value
set.">Required</a> )
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAMUlEQVR4Xu3LMQoAIBA
Dwftr/v8GtdbqEAthAtMspJJUx9rYW8ftHwAA+NcRAAAAXplLq0BWj/rZigAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.filterBy.modifier : Modifier applied to this filter parameter.">modifier</span> <a name="Subscription.filterBy.modifier"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold;
color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px;
border: 1px maroon solid; font-weight: bold; color: #301212; background-color:
#fdf4f4;" title="This element has or is affected by some invariants">C</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">missing | exact | contains | not | text | in | not-in | below | above | type |
identifier | of-type | code-text | text-advanced | iterate
<br/> Binding: <a href="valueset-search-modifier-code.html">Search Modifier Code</a> ( <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value
set.">Required</a> )
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAMUlEQVR4Xu3LMQoAIBA
Dwftr/v8GtdbqEAthAtMspJJUx9rYW8ftHwAA+NcRAAAAXplLq0BWj/rZigAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.filterBy.value : The literal value or resource path as is legal in
search - for example, `Patient/123` or `le1950`.">value</span>
<a name="Subscription.filterBy.value"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">1..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Literal value or resource path
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Data Type"/> <span title="Subscription.filterBy.event : 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.">event</span>
<a name="Subscription.filterBy.event"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..*</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#CodeableConcept">CodeableConcept</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Event to filter by
<br/> Binding: <a href="http://terminology.hl7.org/7.0.1/ValueSet-v2-0003.html">hl7VS-eventCode</a> ( <a href="terminologies.html#example" title="Instances are not expected or even encouraged to draw from the specified value
set. The value set merely provides examples of the types of concepts intended
to be included.">Example</a> )
<br/> <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Data Type"/> <span title="Subscription.channelType : The type of channel to send notifications on.">channelType</span> <a name="Subscription.channelType"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">1..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#Coding">Coding</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Channel type for notifications
<br/> Binding: <a href="valueset-subscription-channel-type.html">Subscription Channel Type</a> ( <a href="terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value
set if any of the codes within the value set can apply to the concept being communicated.
If the value set does not cover the concept (based on human review), alternate
codings (or, data type allowing, text) may be included instead.">Extensible</a> )
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.endpoint : Channel-specific URL that describes where notifications
are sent.">endpoint</span>
<a name="Subscription.endpoint"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#url">url</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">URL where the channel sends notifications
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Element"/> <span title="Subscription.parameter : Channel-dependent information to send as part of the notification
(e.g., HTTP Headers).">parameter</span>
<a name="Subscription.parameter"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..*</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="types.html#BackBoneElement">BackboneElement</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Channel type dependent information
<br/> <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAMUlEQVR4Xu3LMQoAIBA
Dwftr/v8GtdbqEAthAtMspJJUx9rYW8ftHwAA+NcRAAAAXplLq0BWj/rZigAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.parameter.name : 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.">name</span>
<a name="Subscription.parameter.name"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">1..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Name (key) of the parameter
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.parameter.value : 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...`.">value</span>
<a name="Subscription.parameter.value"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">1..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Value of the parameter to use or pass through
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.heartbeatPeriod : 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.">heartbeatPeriod</span>
<a name="Subscription.heartbeatPeriod"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#unsignedInt">unsignedInt</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Interval in seconds to send 'heartbeat' notification
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.timeout : If present, the maximum amount of time a server will allow
before failing a notification attempt.">timeout</span>
<a name="Subscription.timeout"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#unsignedInt">unsignedInt</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Timeout in seconds to attempt notification delivery
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.contentType : The MIME type to send the payload in - e.g., `application/fhir+xml
` or `application/fhir+json`. Note that:
* clients may request notifications in a specific FHIR version by using the [FHIR
Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json;
fhirVersion=4.0`.
* additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html`
are defined by the Email channel.">contentType</span>
<a name="Subscription.contentType"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">MIME type to send, or omit for no payload
<br/> Binding: <a href="valueset-mimetypes.html" title="The mime type of an attachment. Any valid mime type is allowed.">Mime Types</a> ( <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value
set.">Required</a> )
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.content : How much resource content to deliver in the notification
payloads. The choices are an empty payload, only the resource id, or the full resource
content.">content</span>
<a name="Subscription.content"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">empty | id-only | full-resource
<br/> Binding: <a href="valueset-subscription-payload-content.html">Subscription Payload Content</a> ( <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value
set.">Required</a> )
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAg
DsHd9/w4EQIOamFnaBgAA4MMKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <span title="Subscription.maxCount : 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.">maxCount</span>
<a name="Subscription.maxCount"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#positiveInt">positiveInt</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Maximum number of events that can be combined in a single notification
<br/> </td> </tr> <tr> <td class="hierarchy" colspan="5"> <br/> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> Documentation for this format </a> </td> </tr> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category"> <valueString value="Foundation.Other"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="3"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category"> <valueCode value="business"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/Subscription"/> <version value="6.0.0-ballot4"/> <name value="Subscription"/> <status value="active"/> <experimental value="false"/> <date value="2025-12-18T07:07:42+11:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <description value="The subscription resource describes a particular client's request to be notified
about a SubscriptionTopic."/>
<jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <fhirVersion value="6.0.0-ballot4"/> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="Subscription"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> <derivation value="specialization"/> <snapshot> <element id="Subscription"> <path value="Subscription"/> <short value="Information about a request for notifications to a client based on a SubscriptionTopic"/> <definition value="The subscription resource describes a particular client's request to be notified
about a SubscriptionTopic."/>
<alias value="WebHook"/> <alias value="Hook"/> <alias value="Routing Rule"/> <min value="0"/> <max value="*"/> <base> <path value="Subscription"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="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"/>
<expression value="contained.where((('#'+id.trace('id') in %resource.descendants().select(reference
| as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmat
ched', id).empty()"/>
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId
or a meta.lastUpdated"/>
<expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <key value="dom-5"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a security label"/> <expression value="contained.meta.security.empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="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."/>
</extension> <key value="dom-6"/> <severity value="warning"/> <human value="A resource should have narrative for robust management"/> <expression value="text.`div`.exists()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Entity, Role, or Act,N/A"/> </mapping> <mapping> <identity value="w5"/> <map value="infrastructure.exchange"/> </mapping> </element> <element id="Subscription.id"> <path value="Subscription.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned,
this value never changes."/>
<comment value="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."/>
<min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base>
<type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.meta"> <path value="Subscription.meta"/> <short value="Metadata about the resource"/> <definition value="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."/>
<min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.implicitRules"> <path value="Subscription.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="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. For DomainResources, if more than one implicitRules policy applies, additional
policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fh
ir-extensions/StructureDefinition-additionalImplicitRules.html) extension."/>
<comment value="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."/>
<min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="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 value="true"/> </element> <element id="Subscription.language"> <path value="Subscription.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="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)."/>
<min value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="IETF language tag for a human language"/> <valueSet value="http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot4"/> <additional> <purpose value="starter"/> <valueSet value="http://hl7.org/fhir/ValueSet/languages"/> </additional> </binding> </element> <element id="Subscription.text"> <path value="Subscription.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/>
<comment value="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."/>
<alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-6"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="Subscription.contained"> <path value="Subscription.contained"/> <short value="Contained, inline Resources"/> <definition value="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."/>
<comment value="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)."/>
<alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <condition value="dom-2"/> <condition value="dom-4"/> <condition value="dom-3"/> <condition value="dom-5"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Subscription.extension"> <path value="Subscription.extension"/> <short value="Additional content defined by implementations"/> <definition value="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."/>
<comment value="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."/>
<alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Subscription.modifierExtension"> <path value="Subscription.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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)."/>
<comment value="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."/>
<requirements value="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)."/>
<alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the
resource that contains them"/>
<isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Subscription.identifier"> <path value="Subscription.identifier"/> <short value="Additional identifiers (business identifier)"/> <definition value="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."/>
<min value="0"/> <max value="*"/> <base> <path value="Subscription.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> </element> <element id="Subscription.name"> <path value="Subscription.name"/> <short value="Human readable name for this subscription"/> <definition value="A natural language name identifying the subscription."/> <min value="0"/> <max value="1"/> <base> <path value="Subscription.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.status"> <path value="Subscription.status"/> <short value="requested | active | error | off | entered-in-error"/> <definition value="The status of the subscription, which marks the server state for managing the subscription."/> <comment value="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."/>
<min value="1"/> <max value="1"/> <base> <path value="Subscription.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="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 value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubscriptionStatusCodes"/> </extension> <strength value="required"/> <description value="The status of a subscription."/> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-status|6.0.0-ballot4"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.status"/> </mapping> </element> <element id="Subscription.topic"> <path value="Subscription.topic"/> <short value="Reference to the subscription topic being subscribed to"/> <definition value="The reference to the subscription topic to be notified about."/> <min value="1"/> <max value="1"/> <base> <path value="Subscription.topic"/> <min value="1"/> <max value="1"/> </base> <type> <code value="canonical"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> </element> <element id="Subscription.contact"> <path value="Subscription.contact"/> <short value="Contact details for source (e.g. troubleshooting)"/> <definition value="Contact details for a human to contact about the subscription. The primary use
of this for system administrator troubleshooting."/>
<min value="0"/> <max value="*"/> <base> <path value="Subscription.contact"/> <min value="0"/> <max value="*"/> </base> <type> <code value="ContactPoint"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.subject"/> </mapping> </element> <element id="Subscription.end"> <path value="Subscription.end"/> <short value="When to automatically delete the subscription"/> <definition value="The time for the server to turn the subscription off."/> <comment value="The server is permitted to deviate from this time but should observe it."/> <min value="0"/> <max value="1"/> <base> <path value="Subscription.end"/> <min value="0"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.done[x]"/> </mapping> </element> <element id="Subscription.managingEntity"> <path value="Subscription.managingEntity"/> <short value="Entity responsible for Subscription changes"/> <definition value="Entity with authorization to communicate with the server about this Subscription,
such as requesting changes (e.g., updating an endpoint URL)."/>
<comment value="Note that the managing entity for a subscription does not need to be the client
(e.g., in the case of server-managed Subscriptions)."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.managingEntity"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.author"/> </mapping> </element> <element id="Subscription.reason"> <path value="Subscription.reason"/> <short value="Description of why this subscription was created"/> <definition value="A description of why this subscription is defined."/> <min value="0"/> <max value="1"/> <base> <path value="Subscription.reason"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> </element> <element id="Subscription.filterBy"> <path value="Subscription.filterBy"/> <short value="Criteria for narrowing the subscription topic stream"/> <definition value="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)."/>
<min value="0"/> <max value="*"/> <base> <path value="Subscription.filterBy"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children or both"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="scr-1"/> <severity value="error"/> <human value="Subscription filters may only contain a modifier or a comparator"/> <expression value="(comparator.exists() and modifier.exists()).not()"/> <source value="http://hl7.org/fhir/StructureDefinition/Subscription"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.filterBy.id"> <path value="Subscription.filterBy.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <definition value="Unique id for the element within a resource (for internal references). This may
be any string value that does not contain spaces."/>
<min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base>
<type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Subscription.filterBy.extension"> <path value="Subscription.filterBy.extension"/> <short value="Additional content defined by implementations"/> <definition value="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."/>
<comment value="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."/>
<alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Subscription.filterBy.modifierExtension"> <path value="Subscription.filterBy.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <definition value="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)."/>
<comment value="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."/>
<requirements value="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)."/>
<alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the
element that contains them"/>
<isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Subscription.filterBy.resource"> <path value="Subscription.filterBy.resource"/> <short value="Allowed Resource (reference to definition) for this Subscription filter"/> <definition value="A resource listed in the `SubscriptionTopic` this `Subscription` references (`SubscriptionTop
ic.canFilterBy.resource`). This element can be used to differentiate filters for
topics that include more than one resource type."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.filterBy.resource"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="FHIRTypes"/> </extension> <strength value="extensible"/> <description value="A type of resource, or a Reference (from all versions)"/> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-types"/> <additional> <purpose value="ui"/> <valueSet value="http://hl7.org/fhir/ValueSet/all-resource-types"/> </additional> </binding> </element> <element id="Subscription.filterBy.filterParameter"> <path value="Subscription.filterBy.filterParameter"/> <short value="Filter label defined in SubscriptionTopic"/> <definition value="The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element."/> <min value="1"/> <max value="1"/> <base> <path value="Subscription.filterBy.filterParameter"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.filterBy.comparator"> <path value="Subscription.filterBy.comparator"/> <short value="eq | ne | gt | lt | ge | le | sa | eb | ap"/> <definition value="Comparator applied to this filter parameter."/> <comment value="Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription
filter."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.filterBy.comparator"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <condition value="scr-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SearchComparator"/> </extension> <strength value="required"/> <description value="Search Comparator Codes applied to this filter."/> <valueSet value="http://hl7.org/fhir/ValueSet/search-comparator|6.0.0-ballot4"/> </binding> </element> <element id="Subscription.filterBy.modifier"> <path value="Subscription.filterBy.modifier"/> <short value="missing | exact | contains | not | text | in | not-in | below | above | type |
identifier | of-type | code-text | text-advanced | iterate"/>
<definition value="Modifier applied to this filter parameter."/> <comment value="Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription
filter."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.filterBy.modifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <condition value="scr-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SearchModifierCode"/> </extension> <strength value="required"/> <description value="Search Modifier Code applied to this filter."/> <valueSet value="http://hl7.org/fhir/ValueSet/search-modifier-code|6.0.0-ballot4"/> </binding> </element> <element id="Subscription.filterBy.value"> <path value="Subscription.filterBy.value"/> <short value="Literal value or resource path"/> <definition value="The literal value or resource path as is legal in search - for example, `Patient/123`
or `le1950`."/>
<min value="1"/> <max value="1"/> <base> <path value="Subscription.filterBy.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.filterBy.event"> <path value="Subscription.filterBy.event"/> <short value="Event to filter by"/> <definition value="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."/>
<min value="0"/> <max value="*"/> <base> <path value="Subscription.filterBy.event"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubscriptionTopicEventTrigger"/> </extension> <strength value="example"/> <description value="FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE)."/> <valueSet value="http://terminology.hl7.org/ValueSet/v2-0003"/> </binding> </element> <element id="Subscription.channelType"> <path value="Subscription.channelType"/> <short value="Channel type for notifications"/> <definition value="The type of channel to send notifications on."/> <min value="1"/> <max value="1"/> <base> <path value="Subscription.channelType"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubscriptionChannelType"/> </extension> <strength value="extensible"/> <description value="The type of method used to execute a subscription."/> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-channel-type"/> </binding> </element> <element id="Subscription.endpoint"> <path value="Subscription.endpoint"/> <short value="URL where the channel sends notifications"/> <definition value="Channel-specific URL that describes where notifications are sent."/> <comment value="The URL requirements are based on channel type. For example, in a `rest-hook` channel,
the URL must use the `http` or `https` protocol and be supplied by the client;
in a `websocket` channel, the URL uses the `ws` or `wss` protocol and is supplied
by the server.
Note that the URI is allowed to be relative. Relative URLs are relative to the
FHIR server base URL (since there may be more than one, clients should avoid using
relative URIs)."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.endpoint"/> <min value="0"/> <max value="1"/> </base> <type> <code value="url"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.parameter"> <path value="Subscription.parameter"/> <short value="Channel type dependent information"/> <definition value="Channel-dependent information to send as part of the notification (e.g., HTTP Headers)."/> <comment value="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."/>
<min value="0"/> <max value="*"/> <base> <path value="Subscription.parameter"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children or both"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Subscription.parameter.id"> <path value="Subscription.parameter.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <definition value="Unique id for the element within a resource (for internal references). This may
be any string value that does not contain spaces."/>
<min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base>
<type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Subscription.parameter.extension"> <path value="Subscription.parameter.extension"/> <short value="Additional content defined by implementations"/> <definition value="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."/>
<comment value="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."/>
<alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Subscription.parameter.modifierExtension"> <path value="Subscription.parameter.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <definition value="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)."/>
<comment value="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."/>
<requirements value="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)."/>
<alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the
element that contains them"/>
<isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Subscription.parameter.name"> <path value="Subscription.parameter.name"/> <short value="Name (key) of the parameter"/> <definition value="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."/>
<min value="1"/> <max value="1"/> <base> <path value="Subscription.parameter.name"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Subscription.parameter.value"> <path value="Subscription.parameter.value"/> <short value="Value of the parameter to use or pass through"/> <definition value="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...`."/>
<min value="1"/> <max value="1"/> <base> <path value="Subscription.parameter.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Subscription.heartbeatPeriod"> <path value="Subscription.heartbeatPeriod"/> <short value="Interval in seconds to send 'heartbeat' notification"/> <definition value="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."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.heartbeatPeriod"/> <min value="0"/> <max value="1"/> </base> <type> <code value="unsignedInt"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.timeout"> <path value="Subscription.timeout"/> <short value="Timeout in seconds to attempt notification delivery"/> <definition value="If present, the maximum amount of time a server will allow before failing a notification
attempt."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.timeout"/> <min value="0"/> <max value="1"/> </base> <type> <code value="unsignedInt"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.contentType"> <path value="Subscription.contentType"/> <short value="MIME type to send, or omit for no payload"/> <definition value="The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json
`. Note that:
* clients may request notifications in a specific FHIR version by using the [FHIR
Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json;
fhirVersion=4.0`.
* additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html`
are defined by the Email channel."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.contentType"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="The mime type of an attachment. Any valid mime type is allowed."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="MimeType"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)"/> <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|6.0.0-ballot4"/> </binding> </element> <element id="Subscription.content"> <path value="Subscription.content"/> <short value="empty | id-only | full-resource"/> <definition value="How much resource content to deliver in the notification payloads. The choices
are an empty payload, only the resource id, or the full resource content."/>
<comment value="Sending the payload has obvious security implications. The server is responsible
for ensuring that the content is appropriately secured. For additional information,
see [Notification Content](subscription.html#payloads)."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.content"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubscriptionPayloadContent"/> </extension> <strength value="required"/> <description value="Codes to represent how much resource content to send in the notification payload."/> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-payload-content|6.0.0-ballot4"/> </binding> </element> <element id="Subscription.maxCount"> <path value="Subscription.maxCount"/> <short value="Maximum number of events that can be combined in a single notification"/> <definition value="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."/>
<min value="0"/> <max value="1"/> <base> <path value="Subscription.maxCount"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> </snapshot> <differential> <element id="Subscription"> <path value="Subscription"/> <short value="Information about a request for notifications to a client based on a SubscriptionTopic"/> <definition value="The subscription resource describes a particular client's request to be notified
about a SubscriptionTopic."/>
<alias value="WebHook"/> <alias value="Hook"/> <alias value="Routing Rule"/> <min value="0"/> <max value="*"/> <mustSupport value="false"/> <isModifier value="false"/> <mapping> <identity value="w5"/> <map value="infrastructure.exchange"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Subscription.identifier"> <path value="Subscription.identifier"/> <short value="Additional identifiers (business identifier)"/> <definition value="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."/>
<min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> </element> <element id="Subscription.name"> <path value="Subscription.name"/> <short value="Human readable name for this subscription"/> <definition value="A natural language name identifying the subscription."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.status"> <path value="Subscription.status"/> <short value="requested | active | error | off | entered-in-error"/> <definition value="The status of the subscription, which marks the server state for managing the subscription."/> <comment value="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."/>
<min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="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 value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubscriptionStatusCodes"/> </extension> <strength value="required"/> <description value="The status of a subscription."/> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-status|6.0.0-ballot4"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.status"/> </mapping> </element> <element id="Subscription.topic"> <path value="Subscription.topic"/> <short value="Reference to the subscription topic being subscribed to"/> <definition value="The reference to the subscription topic to be notified about."/> <min value="1"/> <max value="1"/> <type> <code value="canonical"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> </element> <element id="Subscription.contact"> <path value="Subscription.contact"/> <short value="Contact details for source (e.g. troubleshooting)"/> <definition value="Contact details for a human to contact about the subscription. The primary use
of this for system administrator troubleshooting."/>
<min value="0"/> <max value="*"/> <type> <code value="ContactPoint"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.subject"/> </mapping> </element> <element id="Subscription.end"> <path value="Subscription.end"/> <short value="When to automatically delete the subscription"/> <definition value="The time for the server to turn the subscription off."/> <comment value="The server is permitted to deviate from this time but should observe it."/> <min value="0"/> <max value="1"/> <type> <code value="instant"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.done[x]"/> </mapping> </element> <element id="Subscription.managingEntity"> <path value="Subscription.managingEntity"/> <short value="Entity responsible for Subscription changes"/> <definition value="Entity with authorization to communicate with the server about this Subscription,
such as requesting changes (e.g., updating an endpoint URL)."/>
<comment value="Note that the managing entity for a subscription does not need to be the client
(e.g., in the case of server-managed Subscriptions)."/>
<min value="0"/> <max value="1"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.author"/> </mapping> </element> <element id="Subscription.reason"> <path value="Subscription.reason"/> <short value="Description of why this subscription was created"/> <definition value="A description of why this subscription is defined."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> </element> <element id="Subscription.filterBy"> <path value="Subscription.filterBy"/> <short value="Criteria for narrowing the subscription topic stream"/> <definition value="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)."/>
<min value="0"/> <max value="*"/> <type> <code value="BackboneElement"/> </type> <constraint> <key value="scr-1"/> <severity value="error"/> <human value="Subscription filters may only contain a modifier or a comparator"/> <expression value="(comparator.exists() and modifier.exists()).not()"/> <source value="http://hl7.org/fhir/StructureDefinition/Subscription"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.filterBy.resource"> <path value="Subscription.filterBy.resource"/> <short value="Allowed Resource (reference to definition) for this Subscription filter"/> <definition value="A resource listed in the `SubscriptionTopic` this `Subscription` references (`SubscriptionTop
ic.canFilterBy.resource`). This element can be used to differentiate filters for
topics that include more than one resource type."/>
<min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="FHIRTypes"/> </extension> <strength value="extensible"/> <description value="A type of resource, or a Reference (from all versions)"/> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-types"/> <additional> <purpose value="ui"/> <valueSet value="http://hl7.org/fhir/ValueSet/all-resource-types"/> </additional> </binding> </element> <element id="Subscription.filterBy.filterParameter"> <path value="Subscription.filterBy.filterParameter"/> <short value="Filter label defined in SubscriptionTopic"/> <definition value="The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.filterBy.comparator"> <path value="Subscription.filterBy.comparator"/> <short value="eq | ne | gt | lt | ge | le | sa | eb | ap"/> <definition value="Comparator applied to this filter parameter."/> <comment value="Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription
filter."/>
<min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <condition value="scr-1"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SearchComparator"/> </extension> <strength value="required"/> <description value="Search Comparator Codes applied to this filter."/> <valueSet value="http://hl7.org/fhir/ValueSet/search-comparator|6.0.0-ballot4"/> </binding> </element> <element id="Subscription.filterBy.modifier"> <path value="Subscription.filterBy.modifier"/> <short value="missing | exact | contains | not | text | in | not-in | below | above | type |
identifier | of-type | code-text | text-advanced | iterate"/>
<definition value="Modifier applied to this filter parameter."/> <comment value="Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription
filter."/>
<min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <condition value="scr-1"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SearchModifierCode"/> </extension> <strength value="required"/> <description value="Search Modifier Code applied to this filter."/> <valueSet value="http://hl7.org/fhir/ValueSet/search-modifier-code|6.0.0-ballot4"/> </binding> </element> <element id="Subscription.filterBy.value"> <path value="Subscription.filterBy.value"/> <short value="Literal value or resource path"/> <definition value="The literal value or resource path as is legal in search - for example, `Patient/123`
or `le1950`."/>
<min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.filterBy.event"> <path value="Subscription.filterBy.event"/> <short value="Event to filter by"/> <definition value="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."/>
<min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubscriptionTopicEventTrigger"/> </extension> <strength value="example"/> <description value="FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE)."/> <valueSet value="http://terminology.hl7.org/ValueSet/v2-0003"/> </binding> </element> <element id="Subscription.channelType"> <path value="Subscription.channelType"/> <short value="Channel type for notifications"/> <definition value="The type of channel to send notifications on."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubscriptionChannelType"/> </extension> <strength value="extensible"/> <description value="The type of method used to execute a subscription."/> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-channel-type"/> </binding> </element> <element id="Subscription.endpoint"> <path value="Subscription.endpoint"/> <short value="URL where the channel sends notifications"/> <definition value="Channel-specific URL that describes where notifications are sent."/> <comment value="The URL requirements are based on channel type. For example, in a `rest-hook` channel,
the URL must use the `http` or `https` protocol and be supplied by the client;
in a `websocket` channel, the URL uses the `ws` or `wss` protocol and is supplied
by the server.
Note that the URI is allowed to be relative. Relative URLs are relative to the
FHIR server base URL (since there may be more than one, clients should avoid using
relative URIs)."/>
<min value="0"/> <max value="1"/> <type> <code value="url"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.parameter"> <path value="Subscription.parameter"/> <short value="Channel type dependent information"/> <definition value="Channel-dependent information to send as part of the notification (e.g., HTTP Headers)."/> <comment value="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."/>
<min value="0"/> <max value="*"/> <type> <code value="BackboneElement"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Subscription.parameter.name"> <path value="Subscription.parameter.name"/> <short value="Name (key) of the parameter"/> <definition value="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."/>
<min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Subscription.parameter.value"> <path value="Subscription.parameter.value"/> <short value="Value of the parameter to use or pass through"/> <definition value="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...`."/>
<min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Subscription.heartbeatPeriod"> <path value="Subscription.heartbeatPeriod"/> <short value="Interval in seconds to send 'heartbeat' notification"/> <definition value="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."/>
<min value="0"/> <max value="1"/> <type> <code value="unsignedInt"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.timeout"> <path value="Subscription.timeout"/> <short value="Timeout in seconds to attempt notification delivery"/> <definition value="If present, the maximum amount of time a server will allow before failing a notification
attempt."/>
<min value="0"/> <max value="1"/> <type> <code value="unsignedInt"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Subscription.contentType"> <path value="Subscription.contentType"/> <short value="MIME type to send, or omit for no payload"/> <definition value="The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json
`. Note that:
* clients may request notifications in a specific FHIR version by using the [FHIR
Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json;
fhirVersion=4.0`.
* additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html`
are defined by the Email channel."/>
<min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="The mime type of an attachment. Any valid mime type is allowed."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="MimeType"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)"/> <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|6.0.0-ballot4"/> </binding> </element> <element id="Subscription.content"> <path value="Subscription.content"/> <short value="empty | id-only | full-resource"/> <definition value="How much resource content to deliver in the notification payloads. The choices
are an empty payload, only the resource id, or the full resource content."/>
<comment value="Sending the payload has obvious security implications. The server is responsible
for ensuring that the content is appropriately secured. For additional information,
see [Notification Content](subscription.html#payloads)."/>
<min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubscriptionPayloadContent"/> </extension> <strength value="required"/> <description value="Codes to represent how much resource content to send in the notification payload."/> <valueSet value="http://hl7.org/fhir/ValueSet/subscription-payload-content|6.0.0-ballot4"/> </binding> </element> <element id="Subscription.maxCount"> <path value="Subscription.maxCount"/> <short value="Maximum number of events that can be combined in a single notification"/> <definition value="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."/>
<min value="0"/> <max value="1"/> <type> <code value="positiveInt"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> </differential>
</
StructureDefinition
>
Usage
note:
every
effort
has
been
made
to
ensure
that
the
examples
are
correct
and
useful,
but
they
are
not
a
normative
part
of
the
specification.
Foundation
|
Propose
a
change