SanteDB XML Schemas

When editing an asset in SanteDB which is in XML format, the use of an XML Schema can greatly assist the development process. The SanteDB community provides schemas for developers to use in their XML files at http://santedb.org/schema/v3.0or http://santedb.org/schema/v2.2.

Schemas

The schema location in the table below assumes a root of http://santedb.org/schema/v3.0/for example http://santedb.org/schema/v3.0/Applet.xsdwould reference the applet manifest schema.

Schema Location	Uses
Applet.xsd	Applet Manifest (manifest.xml) - Manifest File
Audit.xsd	HDSI format Audit messages
BusinessIntelligence.xsd	Any BI asset: BiIndicatorDefinition, BiQueryDefinition, BiViewDefinition, BiReportDefinition - Business Intelligence Assets
Cdss.xsd	Clinical Decision Support rules expressed in XML - CDSS Definitions
Dataset.xsd	Any dataset file (seeding data) Dataset Files
DetectedIssue.xsd	HDSI format detected issue templates
ForeignData.xsd	Any Foreign Data Map definition file ( External Data Maps)
MatcherDefinition.xsd	Any match configuration file - Matching Engine
ModelMap.xsd	For .NET plugins where a persistence layer (physical layer) class definition must be mapped to a business layer object.
ViewModelDescription.xsd	For defining view model definition files which control how the HDSI - ViewModel JSON

Referencing Schemas

To reference a schema in your XML file, simply:

• Declare the http://www.w3.org/2001/XMLSchema-instancenamespace on your root element

• Use the xsi:schemaLocationattribute to point to the intended schema

For example, if defining BI Indicator:

<BiIndicatorDefinition 
    xmlns="http://santedb.org/bi"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://santedb.org/bi http://santedb.org/schema/v3.0/BusinessIntelligence.xsd"
    id="org.example.indicator"
    name="Example Indicator"
    label="ui.org.example.indicator.label">
</BiIndicatorDefinition>