This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Care Coordination Alerts (v0.1.0: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
XML Format: OperationDefinition-notify
Download Raw xml
<OperationDefinition xmlns="http://hl7.org/fhir"> <id value="notify"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2>Notify</h2> <p>OPERATION: Notify</p> <p>The official URL for this operation definition is: </p> <pre>http://hl7.org/fhir/us/davinci-alerts/OperationDefinition/notify</pre> <div> <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> </div> <p>URL: [base]/Communication/$notify</p> <p>Parameters</p> <table class="grid"> <tr> <td> <b>Use</b> </td> <td> <b>Name</b> </td> <td> <b>Cardinality</b> </td> <td> <b>Type</b> </td> <td> <b>Binding</b> </td> <td> <b>Documentation</b> </td> </tr> <tr> <td>IN</td> <td>alert</td> <td>1..*</td> <td/> <td/> <td> <div> <p>One or more Vinci Alerts composed of the Alert Bundle profile and optionally an Alert Endpoint</p> </div> </td> </tr> <tr> <td>IN</td> <td>alert.alert-endpoint</td> <td>0..1</td> <td> canonical(<a href="StructureDefinition-alerts-endpoint.html">Da Vinci Alerts Endpoint Profile</a>) </td> <td/> <td> <div> <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> </div> </td> </tr> <tr> <td>IN</td> <td>alert.alert-bundle</td> <td>1..1</td> <td> canonical(<a href="StructureDefinition-alerts-bundle.html">Da Vinci Alerts Bundle Profile</a>) </td> <td/> <td> <div> <p>The Da Vinci Alert Bundle which contains the individual resources that make up the data-of-interest for the event</p> </div> </td> </tr> </table> <div> <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> </div> </div> </text> <url value="http://hl7.org/fhir/us/davinci-alerts/OperationDefinition/notify"/> <version value="0.1.0"/> <name value="Notify"/> <title value="Da Vinci Notify Operation"/> <status value="active"/> <kind value="operation"/> <date value="2019-07-21T18:36:22-04:00"/> <publisher value="HL7 International - Clinical Decision Support Work Group"/> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/cds/index.cfm"/> </telecom> </contact> <description value="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 value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States of America"/> </coding> </jurisdiction> <code value="notify"/> <comment value="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 value="Communication"/> <system value="false"/> <type value="true"/> <instance value="false"/> <parameter> <name value="alert"/> <use value="in"/> <min value="1"/> <max value="*"/> <documentation value="One or more Vinci Alerts composed of the Alert Bundle profile and optionally an Alert Endpoint"/> <part> <name value="alert-endpoint"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="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 value="canonical"/> <targetProfile value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/alerts-endpoint"/> </part> <part> <name value="alert-bundle"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="The Da Vinci Alert Bundle which contains the individual resources that make up the data-of-interest for the event"/> <type value="canonical"/> <targetProfile value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/alerts-bundle"/> </part> </parameter> </OperationDefinition>