Foundation
This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : No defined compartments |
Raw JSON ( canonical form + also see JSON Format Specification )
Example Topic with Modifiers
{
"resourceType" : "SubscriptionTopic",
"id" : "example",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: SubscriptionTopic</b><a name=\"example\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource SubscriptionTopic "example" </p></div><p><b>url</b>: <code>http://example.org/FHIR/R5/SubscriptionTopic/example</code></p><p><b>identifier</b>: id:\u00a0urn:uuid:1caa02ba-051b-4602-8856-65921748ae76</p><p><b>version</b>: 1.0.0-beta.1</p><p><b>title</b>: example</p><p><b>status</b>: draft</p><p><b>date</b>: 2019-01-01</p><p><b>description</b>: Example topic for completed encounters</p><blockquote><p><b>resourceTrigger</b></p><p><b>description</b>: An Encounter has been completed</p><p><b>resource</b>: <a href=\"encounter.html\">Encounter</a></p><p><b>supportedInteraction</b>: update</p><h3>QueryCriteria</h3><table class=\"grid\"><tr><td>-</td><td><b>Previous</b></td><td><b>ResultForCreate</b></td><td><b>Current</b></td><td><b>ResultForDelete</b></td><td><b>RequireBoth</b></td></tr><tr><td>*</td><td>status:not=completed</td><td>test-passes</td><td>status=completed</td><td>test-fails</td><td>true</td></tr></table><p><b>fhirPathCriteria</b>: (%previous.empty() | (%previous.status != 'completed')) and (%current.status = 'completed')</p></blockquote><blockquote><p><b>canFilterBy</b></p><p><b>description</b>: Filter based on the subject of an encounter.</p><p><b>resource</b>: <a href=\"encounter.html\">Encounter</a></p><p><b>filterParameter</b>: subject</p></blockquote><blockquote><p><b>canFilterBy</b></p><p><b>description</b>: Filter based on the group membership of the subject of an encounter.</p><p><b>resource</b>: <a href=\"encounter.html\">Encounter</a></p><p><b>filterParameter</b>: _in</p></blockquote><blockquote><p><b>canFilterBy</b></p><p><b>description</b>: Filter based on the length of an encounter.</p><p><b>resource</b>: <a href=\"encounter.html\">Encounter</a></p><p><b>filterParameter</b>: length</p><p><b>comparator</b>: gt, lt, ge, le</p></blockquote><blockquote><p><b>canFilterBy</b></p><p><b>description</b>: Filter based on the account for billing an encounter.</p><p><b>resource</b>: <a href=\"encounter.html\">Encounter</a></p><p><b>filterParameter</b>: account</p><p><b>modifier</b>: missing, not, identifier</p></blockquote><h3>NotificationShapes</h3><table class=\"grid\"><tr><td>-</td><td><b>Resource</b></td><td><b>Include</b></td></tr><tr><td>*</td><td><a href=\"encounter.html\">Encounter</a></td><td>Encounter:patient&iterate=Patient.link, Encounter:practitioner, Encounter:service-provider, Encounter:account, Encounter:diagnosis, Encounter:observation, Encounter:location</td></tr></table></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://example.org/FHIR/R5/SubscriptionTopic/example",
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:uuid:1caa02ba-051b-4602-8856-65921748ae76"
}],
"version" : "1.0.0-beta.1",
"title" : "example",
"status" : "draft",
"date" : "2019-01-01",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}]
}],
"description" : "Example topic for completed encounters",
"resourceTrigger" : [{
"trigger" : [{
"description" : "An Encounter has been completed",
"resource" : "http://hl7.org/fhir/StructureDefinition/Encounter",
"supportedInteraction" : ["update"],
"queryCriteria" : {
"previous" : "status:not=completed",
"resultForCreate" : "test-passes",
"current" : "status=completed",
"resultForDelete" : "test-fails",
"requireBoth" : true
},
"fhirPathCriteria" : "(%previous.empty() | (%previous.status != 'completed')) and (%current.status = 'completed')"
}],
"canFilterBy" : [{
"description" : "Filter based on the subject of an encounter.",
"resource" : "Encounter",
"filterParameter" : "subject"
},
{
"description" : "Filter based on the group membership of the subject of an encounter.",
"resource" : "Encounter",
"filterParameter" : "_in"
},
{
"description" : "Filter based on the length of an encounter.",
"resource" : "Encounter",
"filterParameter" : "length",
"comparator" : ["gt",
"lt",
"ge",
"le"]
},
{
"description" : "Filter based on the account for billing an encounter.",
"resource" : "Encounter",
"filterParameter" : "account",
"modifier" : ["missing",
"not",
"identifier"]
}],
"notificationShape" : [{
"resource" : "Encounter",
"include" : ["Encounter:patient&iterate=Patient.link",
"Encounter:practitioner",
"Encounter:service-provider",
"Encounter:account",
"Encounter:diagnosis",
"Encounter:observation",
"Encounter:location"]
"fhirPathCriteria" : "(%previous.empty() | (%previous.status != 'completed')) and (%current.status = 'completed')",
"canFilterBy" : [{
"description" : "Filter based on the subject of an encounter.",
"resource" : "Encounter",
"filterParameter" : "subject"
},
{
"description" : "Filter based on the group membership of the subject of an encounter.",
"resource" : "Encounter",
"filterParameter" : "_in"
},
{
"description" : "Filter based on the length of an encounter.",
"resource" : "Encounter",
"filterParameter" : "length",
"comparator" : ["gt",
"lt",
"ge",
"le"]
},
{
"description" : "Filter based on the account for billing an encounter.",
"resource" : "Encounter",
"filterParameter" : "account",
"modifier" : ["missing",
"not",
"identifier"]
}],
"notificationShape" : [{
"resource" : "Encounter",
"include" : ["Encounter:patient&iterate=Patient.link",
"Encounter:practitioner",
"Encounter:service-provider",
"Encounter:account",
"Encounter:diagnosis",
"Encounter:observation",
"Encounter:location"],
"relatedQuery" : [{
"query" : "Patient?_include:iterate=Patient:link"
},
{
"query" : "$current-providers"
}]
}]
}]
}
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.
FHIR
®©
HL7.org
2011+.
FHIR
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot2
generated
on
Sun,
Mar
26,
2023
15:26+1100.
Mon,
Aug
12,
2024
16:59+0800.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
|
Propose
a
change