Schema NotificationAction-303-500.xsd


schema location:  C:\Users\chris\Desktop\DataStandards\Notification Action\Format 500\NotificationAction-303-500.xsd
attributeFormDefault:  unqualified
elementFormDefault:  qualified
targetNamespace:  http://www.himsa.com/AlertDashboard/Notification/500
 
Elements 
NotificationAction 


element NotificationAction
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p1.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
properties
content complex
children Category Description ActionGUID Url ModuleID ModuleParameter IconUrl Group
attributes
Name  Type  Use  Default  Fixed  Annotation
Version  derived by: xs:integer  required    500  
documentation
Version of this data standard
ConvertedFromDataStandard  derived by: xs:integer        
documentation
Software saving data formatted via this XSD file should not use this element for storage.  The intention is for Noah data convertors to fill in an appropriate value for runtime conversions - not permanent storage.

Please note that values less than 500 mean that the data was originally stored in a format which was not validated by Noah before storage.  This could mean that the data will not validated against this version
annotation
documentation
HIMSA Notification Action Data Standard

Important: All XML data must be encoded using UTF-8.  With Noah 4.13 and newer Noah validation rules will only allow UTF-8.

Including a Byte Order Mark (BOM)is not necessary but considered acceptable

Declaring and making use of additional XML Namespaces is not allowed.  Noah validation rules will reject the data if detected.

REV 3 (see REV History below)

Copyright © 2019 HIMSA II K/S

The information in this document is subject to change according to the review policies established by HIMSA II.

HIMSA II MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OR SUITABILITY FOR A PARTICULAR PURPOSE. HIMSA shall not be liable for errors contained herein or for incidental consequential damages in connection with the supply of, performance of, or use of this material.

This document contains proprietary information that is protected by copyright. All rights are reserved. No parts of this document may be photocopied, reproduced or distributed to Non-HIMSA member companies. without the prior permission of HIMSA II.

Copyright © 2019 HIMSA II K/S

REV History
REV 1 /  Intial release made April 2 2019
REV 2 / November 6 2019 - Annotation updates only, note to use UTF-8
REV 3 / December 14 2020 -
Annotation updates only, note on UTF-8 and validation, BOM and use of additional namespaces
source <xs:element name="NotificationAction">
  <xs:annotation>
    <xs:documentation>HIMSA Notification Action Data Standard

Important: All XML data must be encoded using UTF-8.  With Noah 4.13 and newer Noah validation rules will only allow UTF-8.

Including a Byte Order Mark (BOM)is not necessary but considered acceptable

Declaring and making use of additional XML Namespaces is not allowed.  Noah validation rules will reject the data if detected.

REV 3 (see REV History below)

Copyright © 2019 HIMSA II K/S

The information in this document is subject to change according to the review policies established by HIMSA II.

HIMSA II MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OR SUITABILITY FOR A PARTICULAR PURPOSE. HIMSA shall not be liable for errors contained herein or for incidental consequential damages in connection with the supply of, performance of, or use of this material.

This document contains proprietary information that is protected by copyright. All rights are reserved. No parts of this document may be photocopied, reproduced or distributed to Non-HIMSA member companies. without the prior permission of HIMSA II.

Copyright © 2019 HIMSA II K/S

REV History
REV 1 /  Intial release made April 2 2019
REV 2 / November 6 2019 - Annotation updates only, note to use UTF-8
REV 3 / December 14 2020 -
Annotation updates only, note on UTF-8 and validation, BOM and use of additional namespaces</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Category">
        <xs:annotation>
          <xs:documentation>Must be one of the pre-defined values.  The string will be verified to see if it matches one of the pre-defined valid strings. These strings are defined in the cloud but will dynamically be retrieved by NoahServer.</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
          <xs:restriction base="xs:string"/>
        </xs:simpleType>
      </xs:element>
      <xs:element name="Description">
        <xs:annotation>
          <xs:documentation>The Notification Description.  The notification description is not be confused with Action Description.</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
          <xs:restriction base="xs:string"/>
        </xs:simpleType>
      </xs:element>
      <xs:element name="ActionGUID" nillable="true" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Used to reference the action that was sent, or referenced, in the same Notification (if any)</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value="[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element name="Url" type="xs:anyURI" minOccurs="0">
        <xs:annotation>
          <xs:documentation>If provided Noah will use this link to open the default web browser when the user selects the notification action in the GUI</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="ModuleID" type="xs:int" nillable="true" minOccurs="0">
        <xs:annotation>
          <xs:documentation>If provided Noah will open this module when the user selects the notification action in the GUI</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="ModuleParameter" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>command line argument when opening a module</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="IconUrl" type="xs:anyURI" minOccurs="0">
        <xs:annotation>
          <xs:documentation>url address to icon resource. Used in conjunction with URL

If this value isn’t provided and the ’Url’ value is provided – then a default icon will be displayed</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Group" nillable="true" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Used to mark a notification action/alert as a part of a series of notification actions/alerts with the same Group.</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value="[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
    </xs:sequence>
    <xs:attribute name="Version" use="required" fixed="500">
      <xs:annotation>
        <xs:documentation>Version of this data standard</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:integer"/>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="ConvertedFromDataStandard">
      <xs:annotation>
        <xs:documentation>Software saving data formatted via this XSD file should not use this element for storage.  The intention is for Noah data convertors to fill in an appropriate value for runtime conversions - not permanent storage.

Please note that values less than 500 mean that the data was originally stored in a format which was not validated by Noah before storage.  This could mean that the data will not validated against this version</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:integer">
          <xs:minInclusive value="100"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

attribute NotificationAction/@Version
type restriction of xs:integer
properties
use required
fixed 500
annotation
documentation
Version of this data standard
source <xs:attribute name="Version" use="required" fixed="500">
  <xs:annotation>
    <xs:documentation>Version of this data standard</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:integer"/>
  </xs:simpleType>
</xs:attribute>

attribute NotificationAction/@ConvertedFromDataStandard
type restriction of xs:integer
facets
Kind Value Annotation
minInclusive 100
annotation
documentation
Software saving data formatted via this XSD file should not use this element for storage.  The intention is for Noah data convertors to fill in an appropriate value for runtime conversions - not permanent storage.

Please note that values less than 500 mean that the data was originally stored in a format which was not validated by Noah before storage.  This could mean that the data will not validated against this version
source <xs:attribute name="ConvertedFromDataStandard">
  <xs:annotation>
    <xs:documentation>Software saving data formatted via this XSD file should not use this element for storage.  The intention is for Noah data convertors to fill in an appropriate value for runtime conversions - not permanent storage.

Please note that values less than 500 mean that the data was originally stored in a format which was not validated by Noah before storage.  This could mean that the data will not validated against this version</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:integer">
      <xs:minInclusive value="100"/>
    </xs:restriction>
  </xs:simpleType>
</xs:attribute>

element NotificationAction/Category
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p2.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
type restriction of xs:string
properties
content simple
annotation
documentation
Must be one of the pre-defined values.  The string will be verified to see if it matches one of the pre-defined valid strings. These strings are defined in the cloud but will dynamically be retrieved by NoahServer.
source <xs:element name="Category">
  <xs:annotation>
    <xs:documentation>Must be one of the pre-defined values.  The string will be verified to see if it matches one of the pre-defined valid strings. These strings are defined in the cloud but will dynamically be retrieved by NoahServer.</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
</xs:element>

element NotificationAction/Description
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p3.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
type restriction of xs:string
properties
content simple
annotation
documentation
The Notification Description.  The notification description is not be confused with Action Description.
source <xs:element name="Description">
  <xs:annotation>
    <xs:documentation>The Notification Description.  The notification description is not be confused with Action Description.</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
</xs:element>

element NotificationAction/ActionGUID
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p4.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
type restriction of xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
facets
Kind Value Annotation
pattern [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
annotation
documentation
Used to reference the action that was sent, or referenced, in the same Notification (if any)
source <xs:element name="ActionGUID" nillable="true" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Used to reference the action that was sent, or referenced, in the same Notification (if any)</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:pattern value="[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

element NotificationAction/Url
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p5.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
type xs:anyURI
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
If provided Noah will use this link to open the default web browser when the user selects the notification action in the GUI
source <xs:element name="Url" type="xs:anyURI" minOccurs="0">
  <xs:annotation>
    <xs:documentation>If provided Noah will use this link to open the default web browser when the user selects the notification action in the GUI</xs:documentation>
  </xs:annotation>
</xs:element>

element NotificationAction/ModuleID
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p6.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
type xs:int
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
If provided Noah will open this module when the user selects the notification action in the GUI
source <xs:element name="ModuleID" type="xs:int" nillable="true" minOccurs="0">
  <xs:annotation>
    <xs:documentation>If provided Noah will open this module when the user selects the notification action in the GUI</xs:documentation>
  </xs:annotation>
</xs:element>

element NotificationAction/ModuleParameter
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p7.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
command line argument when opening a module
source <xs:element name="ModuleParameter" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>command line argument when opening a module</xs:documentation>
  </xs:annotation>
</xs:element>

element NotificationAction/IconUrl
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p8.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
type xs:anyURI
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
url address to icon resource. Used in conjunction with URL

If this value isn’t provided and the ’Url’ value is provided – then a default icon will be displayed
source <xs:element name="IconUrl" type="xs:anyURI" minOccurs="0">
  <xs:annotation>
    <xs:documentation>url address to icon resource. Used in conjunction with URL

If this value isn’t provided and the ’Url’ value is provided – then a default icon will be displayed</xs:documentation>
  </xs:annotation>
</xs:element>

element NotificationAction/Group
diagram NotificationAction-303-500rev3_diagrams/NotificationAction-303-500rev3_p9.png
namespace http://www.himsa.com/AlertDashboard/Notification/500
type restriction of xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
facets
Kind Value Annotation
pattern [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
annotation
documentation
Used to mark a notification action/alert as a part of a series of notification actions/alerts with the same Group.
source <xs:element name="Group" nillable="true" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Used to mark a notification action/alert as a part of a series of notification actions/alerts with the same Group.</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:pattern value="[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy