<?xml version="1.0" encoding="UTF-8"?>
<!--
 Copyright (c) 2007, Oracle. All rights reserved.  

   NAME
     ordcmmp.xsd - XML schema for DICOM mapping documents

   MODIFIED   (MM/DD/YY)
   dolin       06/06/07 - 
   myalavar    06/06/07 - review comments
   fechen      05/08/07 - fix the comments 
   myalavar    04/10/07 - copyright
   myalavar    04/09/07 - add major_minor version
   dguo        08/01/06 - Beta release 1
   dguo        04/03/05 - Created

-->

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://xmlns.oracle.com/ord/dicom/mapping_1_0" xmlns:dt="http://xmlns.oracle.com/ord/dicom/datatype_1_0" targetNamespace="http://xmlns.oracle.com/ord/dicom/mapping_1_0" elementFormDefault="qualified" attributeFormDefault="unqualified">
  <xs:import namespace="http://xmlns.oracle.com/ord/dicom/datatype_1_0" schemaLocation="http://xmlns.oracle.com/ord/dicom/datatype_1_0"/>
  <xs:annotation>
    <xs:documentation>
      This schema defines the DICOM (XML) mapping document.
      It defines how each DICOM attribute maps to an element of the 
      DICOM metadata document.
      
      The mapping document is used by the metadata encoder to produce 
      a DICOM metadata document. Each DICOM attribute is identified by 
      a 4-byte hexadecimal attribute tag. Each DICOM attribute is mapped 
      to an element of the XML metadata document designated by the PATH 
      element. By default, a DICOM attribute can be null and is optional.
      
      XML_MAPPING_DOCUMENT
        Question mark "?" means optional items.
        Plus "+" means one or more items.
        Asterisk "*" means zero or more items.

      DOCUMENT_HEADER?
        DOCUMENT_CHANGE_LOG*
         DOCUMENT_MODIFIER
         DOCUMENT_MODIFICATION_DATE
         DOCUMENT_VERSION?
         MODIFICATION_COMMENT?
         BASE_DOCUMENT?
         BASE_DOCUMENT_RELEASE_DATE?
         BASE_DOCUMENT_DESCRIPTION?
      NAMESPACE?
      ROOT_ELEM_TAG
      UNMAPPED_ELEM
      MAPPED_ELEM
      MAPPED_PATH+ (occurs?, notEmpty?, writeTag?, writeDefiner?, writeName?, writeRawValue)
         {ATTRIBUTE_TAG(definer), PATH}+
       
    </xs:documentation>
  </xs:annotation>
  <xs:element name="XML_MAPPING_DOCUMENT">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="DOCUMENT_HEADER" type="dt:DOCUMENT_HEADER_T" minOccurs="0"/>
        <xs:element name="NAMESPACE" type="dt:SHORT_TEXT_T">
          <xs:annotation>
            <xs:documentation>
              The namespace of the XML metadata schema on which a mapping 
              document is based. Metadata from a DICOM object can be
              mapped into an XML document constrained by this XML
              metadata schema. If the value of this element is an empty string,
              the extracted XML metadata document is not 
              associated with an XML schema.
              The order of the MAPPED_PATH elements
              MUST match the sequence of the corresponding XML 
              elements in this namespace.              
              </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="ROOT_ELEM_TAG" type="dt:SHORT_STRING_T">
          <xs:annotation>
            <xs:documentation>
              This element specifies the root element tag of 
              an XML metadata document.
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="UNMAPPED_ELEM" type="dt:SHORT_STRING_T" nillable="true" minOccurs="0">
          <xs:annotation>
            <xs:documentation>
            This element specifies the XML path (appended to 
            ROOT_ELEM_TAG) for unmapped attributes, that is, the set
            of DICOM attributes that are present in a DICOM object, 
            but whose mappings have not been defined by the
            MAPPED_PATH elements of an XML mapping document.
            This element is optional. If this element is omitted or empty, 
            the unmapped attributes are appended to ROOT_ELEM_TAG. 
            If an XML schema is used to constrain the metadata document,
            the XML schema element pointed to by this element should
            be of type dt:DATASET_T. See the DICOM data type definition
            schema "http://xmlns.oracle.com/ord/dicom/datatype_1_0"
            and dt:DATASET_T for more information.
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="MAPPED_ELEM" type="dt:SHORT_STRING_T" nillable="true" minOccurs="0">
          <xs:annotation>
            <xs:documentation>
            This element specifies the XML path for all mapped 
            attributes, that is,  the set of DICOM attributes that are 
            present in a DICOM object, and whose mappings
            are defined by the MAPPED_XPATH elements 
            of an XML mapping document. This element
            specifies a relative path from ROOT_ELEM_TAG.
            For example, to map a DICOM attribute (0010,0010) to
            the XML element at "/DICOM_METADATA/PATIENT/NAME",
            specify the following 
            The ROOT_ELEM_TAG element value is "DICOM_METADATA".
            The MAPPED_ELEM element value is "PATIENT" and 
            The MAPPED_PATH/PATH element value should be "NAME".
            Alternatively, 
            if the value of element MAPPED_ELEM is an empty string,
            then the value of the element MAPPED_PATH/PATH
            should be "PATIENT/NAME".
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="MAPPED_PATH" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:annotation>
                <xs:documentation>
                  A MAPPED_PATH element contains attribute tag and
                  path pairs.
                  An attribute tag uniquely identifies an attribute within the
                  data dictionary. Wildcards are not allowed in an attribute
                  tag specification in this release.
                  The path consists of slash "/"-concatenated element names.
                  A path specifies the destination of an attribute in the 
                  DICOM XML metadata document. The mapped path
                  is the relative path from ROOT_ELEM_TAG and
                  MAPPED_ELEM. The absolute path is:
                  "${ROOT_ELEM_TAG} / ${MAPPED_ELEM} / 
                  ${MAPPED_PATH}".
                  The optional attribute "occurs" specifies whether the
                  attribute must exist in the original DICOM content.
                  (The attribute tag must exist, but the attribute value
                  can be an empty string, for example, a DICOM  type 2 
                  attribute.)
                  The optional attribute "notEmpty" specifies 
                  whether the attribute must have a value in 
                  the original DICOM content (type 1 in DICOM terms).
                  Depending on the run-time preferences, if the 
                  above "occurs' or "notEmpty" condition is not 
                  met, an error may be thrown at run-time.
                  The optional attribute "writeTag" specifies whether to
                  add the attribute "tag" when writing the element.
                  The tag attribute is of type "dt:AT". The value of this
                  attribute is the DICOM attribute tag in little-endian 
                  encoding.
                  The optional attribute "writeDefiner" specifies whether
                  to add the attribute "definer" when writing the element.
                  The definer attribute is of type "dt:LO". The value of
                  this attribute is the same as the definer attribute of
                  ATTRIBUTE_TAG element of the mapping document.
                  The optional attribute "writeName" specifies whether
                  to add the attribute "name" when writing the element.
                  The name attribute is of type "dt:SHORT_STRING_T".
                  The value of this element is the attribute name
                  defined by the data dictionary.
                  The optional attribute "writeRawValue" specifies whether
                  to add the attribute "rawValue" when writing the element.
                  The raw value attribute is of type "xs:hexBinary".
                  This attribute only occurs when there is a parsing error
                  for this attribute and no XML value can be extracted for
                  the element. The value of this attribute is the 
                  hexadecimal dump of the original byte stream.
                </xs:documentation>
              </xs:annotation>
              <xs:element name="ATTRIBUTE_TAG" type="dt:VALUE_LOCATOR_T"/>
              <xs:element name="PATH" type="dt:SHORT_TEXT_T"/>
            </xs:sequence>
            <xs:attribute name="occurs" type="xs:boolean" default="false"/>
            <xs:attribute name="notEmpty" type="xs:boolean" default="false"/>
            <xs:attribute name="writeTag" type="xs:boolean" default="false"/>
            <xs:attribute name="writeDefiner" type="xs:boolean" default="false"/>
            <xs:attribute name="writeName" type="xs:boolean" default="false"/>
            <xs:attribute name="writeRawValue" type="xs:boolean" default="false"/>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>