This page is part of the Da Vinci Unsolicited Notifications (v1.0.0: STU1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
JSON Format: OperationDefinition-notify
Download Raw json
{
"resourceType" : "OperationDefinition",
"id" : "notify",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<h2>Notify</h2>\n\t\t\t<p>OPERATION: Notify</p>\n\t\t\t<p>The official URL for this operation definition is: </p>\n\t\t\t<pre>http://hl7.org/fhir/us/davinci-alerts/OperationDefinition/notify</pre>\n\t\t\t<div>\n\t\t\t\t<p>The notify operation is used to alert the recipient of a specific patient event (e.g. admission, discharge, change in treatment, new diagnosis). There is no expectation that the data submitted represents all the data required by the the recipient, only that the data is known to be relevant to the triggering event.</p>\n\t\t\t</div>\n\t\t\t<p>URL: [base]/Communication/$notify</p>\n\t\t\t<p>Parameters</p>\n\t\t\t<table class=\"grid\">\n\t\t\t\t<tr>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Use</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Name</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Cardinality</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Type</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Binding</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Documentation</b>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t\t<tr>\n\t\t\t\t\t<td>IN</td>\n\t\t\t\t\t<td>alert</td>\n\t\t\t\t\t<td>1..*</td>\n\t\t\t\t\t<td/>\n\t\t\t\t\t<td/>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<div>\n\t\t\t\t\t\t\t<p>One or more Vinci Alerts composed of the Alert Bundle profile and optionally an Alert Endpoint</p>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t\t<tr>\n\t\t\t\t\t<td>IN</td>\n\t\t\t\t\t<td>alert.alert-endpoint</td>\n\t\t\t\t\t<td>0..1</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\tcanonical(<a href=\"StructureDefinition-alerts-endpoint.html\">Da Vinci Alerts Endpoint Profile</a>)\n\t\t\t\t\t</td>\n\t\t\t\t\t<td/>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<div>\n\t\t\t\t\t\t\t<p>The Da Vinci Alert Endpoint which contains the technical details of an endpoint for getting additional information from the medical record for the event</p>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t\t<tr>\n\t\t\t\t\t<td>IN</td>\n\t\t\t\t\t<td>alert.alert-bundle</td>\n\t\t\t\t\t<td>1..1</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\tcanonical(<a href=\"StructureDefinition-alerts-bundle.html\">Da Vinci Alerts Bundle Profile</a>)\n\t\t\t\t\t</td>\n\t\t\t\t\t<td/>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<div>\n\t\t\t\t\t\t\t<p>The Da Vinci Alert Bundle which contains the individual resources that make up the data-of-interest for the event</p>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t</table>\n\t\t\t<div>\n\t\t\t\t<p>The effect of invoking this operation is that the submitted data is posted to the receiving system and can be used by the recipient to take subsequent actions</p>\n\t\t\t</div>\n\t\t</div>"
},
"url" : "http://hl7.org/fhir/us/davinci-alerts/OperationDefinition/notify",
"version" : "0.1.0",
"name" : "Notify",
"title" : "Da Vinci Notify Operation",
"status" : "active",
"kind" : "operation",
"date" : "2019-07-21T18:36:22-04:00",
"publisher" : "HL7 International - Clinical Decision Support Work Group",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cds/index.cfm"
}
]
}
],
"description" : "The notify operation is used to alert the recipient of a specific patient event (e.g. admission, discharge, change in treatment, new diagnosis). There is no expectation that the data submitted represents all the data required by the the recipient, only that the data is known to be relevant to the triggering event.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"code" : "notify",
"comment" : "The effect of invoking this operation is that the submitted data is posted to the receiving system and can be used by the recipient to take subsequent actions",
"resource" : [
"Communication"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "alert",
"use" : "in",
"min" : 1,
"max" : "*",
"documentation" : "One or more Vinci Alerts composed of the Alert Bundle profile and optionally an Alert Endpoint",
"part" : [
{
"name" : "alert-endpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The Da Vinci Alert Endpoint which contains the technical details of an alert for getting additional information from the medical record for the event",
"type" : "canonical",
"targetProfile" : [
"http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/alerts-endpoint"
]
},
{
"name" : "alert-bundle",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The Da Vinci Alert Bundle which contains the individual resources that make up the data-of-interest for the event",
"type" : "canonical",
"targetProfile" : [
"http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/alerts-bundle"
]
}
]
}
]
}
