Timeline

Proposal ready:

31 Jul 2020

XSD public review

22 Sep 2020 - 22 Oct 2020

Communication period
Implementation / testing

Q4, 2020

Release Date

Staging: Jan, 14th, 2021

Prod: Feb, 13th, 2021

Status

Progress Bar | Vectors (Formerly: SP Progress bar)

current-step	6
steps	Preparation, Draft, Discussion, Public review , Implementation, Release

Info

The WMDA data-upload production is now with XSD 2.2 supported from 16 Dec 2019

Till Nov, 2020, as there are only 40% of organization moved to XSD 2.2, WMDA data-upload decide to keep support XSD 2.1 till 2021,October.

Organizations can upgrade to XSD 2.2 as planned which will now be supported till 2022, October, or plan to update to XSD 2.3 after Q1, 2021.

Table of Contents

Download XSD version 2.3 :

Status


colour	Green
title	public review

The files below are officially approved by the Datadictionary Technical XML group (XSD group).

All questions regarding this version can be asked here : https://share.wmda.info/questions/topics/360087558/xsdv23

Attachments

Changes between version 2.2 and 2.3

Updated version number to 2.3

Panel

bgColor	lightyellow
title	Inventories.xsd

Code Block

language	xml
theme	RDark
title	Version 2.2
linenumbers	true

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2.2">

Update version number to 2.3

Code Block

language	xml
theme	RDark
title	Version 2.3
linenumbers	true

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2.3">

Move GRID/ID

Panel

bgColor	lightyellow
title	Inventories.xsd

Code Block

language	xml
theme	RDark
title	version 2.2
linenumbers	true

	<xs:complexType name="itemBaseType" abstract="true">
		<xs:annotation>
			<xs:documentation xml:lang="en">Abstract base type of donor and CBU items</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="ID" minOccurs="0">
				...
			</xs:element>
			<xs:element name="GRID" minOccurs="0">
				...
			</xs:element>
			<xs:element name="ATTR" minOccurs="0">
				...

Because GRID is compulsory for DONOR, and ID is optional for DONOR, but compulsory for CBU, the xsd schema 1.0 we use can not handle with conditions structure, so we need move GRID and ID,

Move ID to the sequence to the type "donItemType", keep ID as "optional"
Move ID to the sequence to the type "cbuItemType", and changed ID to "required".
GRID is already required/compulsory in the validation control in WMDA data upload from XSD 2.2, but not using XSD schema control, we added the "required" control in the XSD schema file in 2.3
Move GRID to the sequence to the type "donItemType", and changed GRID to 'required'.

Code Block

language	xml
theme	RDark
firstline	86
title	Version 2.3
linenumbers	true

<xs:complexType name="donItemType">
		<xs:annotation>
			<xs:documentation xml:lang="en">A donor is an adult person who has consented to donate haematopoietic progenitor cells to an unrelated patient.</xs:documentation>
		</xs:annotation>
		<xs:complexContent>
			<xs:extension base="itemBaseType">
				<xs:sequence>
					<xs:element name="ID" minOccurs="0">
						...
					</xs:element>
					<xs:element name="GRID" minOccurs="1">
						...
					</xs:element>
					<xs:element name="STAT_REASON" type="statReasonDonType" minOccurs="0">
						<xs:annotation>
							<xs:documentation xml:lang="en">Additional information relevant to the donor status</xs:documentation>
						</xs:annotation>
					</xs:element>

Code Block

language	xml
theme	RDark
firstline	199
title	Version 2.3
linenumbers	true

	<xs:complexType name="cbuItemType">
		<xs:annotation>
			<xs:documentation xml:lang="en">A cord blood unit (CBU) is a banked, frozen blood product extracted from a newborn baby's umbilical cord.</xs:documentation>
		</xs:annotation>
		<xs:complexContent>
			<xs:extension base="itemBaseType">
				<xs:sequence>
					<xs:element name="ID" minOccurs="1">
						...
					</xs:element>
					<xs:element name="STAT_REASON" type="statReasonCbuType" minOccurs="0">
						...
					</xs:element>

XML Example version 2.3:

Code Block

language	xml
title	XML Example version 2.3

<DONOR>
	<BIRTH_DATE>...</BIRTH_DATE>
	...
	<HLA>...</HLA>	
	<IDM>...</IDM>
	<STATUS>RS</STATUS>
    <STAT_END_DATE>2022-10-20</STAT_END_DATE>
    <ID>WMDA001</ID>
    <GRID>1234000000WMDA00121</GRID>
    <STAT_REASON>TX</STAT_REASON>
	...

Change Field Name KIR_GL to KIR_GLS_URI

Panel

bgColor	lightyellow
title	basicTypes.xsd

Code Block

language	xml
theme	RDark
title	version 2.2
linenumbers	true

		<xs:element name="KIR_GL" minOccurs="0">
				<xs:annotation>
					<xs:documentation xml:lang="en">URI that refers to a GL-string registered with a GL-service or direct GL-string for absence / presence. Field is not used at the moment and should therefore always be empty.</xs:documentation>

				...

Change KIR_GL to KIR_GLS_URI.
Update "annotation" and changed "GL-string" to "GL String", which is more used by the official articles
There is no data in current data upload, so no worries about data lost because the required value change.
XSD group consider to have this change for a more realistic use case if value will be provided.

Code Block

language	xml
theme	RDark
firstline	979
title	Version 2.3
linenumbers	true

		<xs:element name="KIR_GLS_URI" minOccurs="0">
			<xs:annotation>
				<xs:documentation xml:lang="en">URI that refers to a GL String registered with a GL service. Field is not used at the moment and should therefore always be empty.</xs:documentation>

Add HLA-E

Panel

bgColor	lightyellow
title	basicTypes.xsd

Code Block

language	xml
theme	RDark
firstline	1059
title	Version 2.2
linenumbers	true

<xs:sequence>
			<xs:element name="A" type="hlaLocusType" minOccurs="0"/>
			<xs:element name="B" type="hlaLocusType" minOccurs="0"/>
			<xs:element name="C" type="hlaLocusType" minOccurs="0"/>
            <xs:element name="DRB1" type="hlaLocusType" minOccurs="0"/>

Add HLA-E after HLA-C, HLA-E only has DNA fields

Code Block

language	xml
theme	RDark
firstline	1097
title	Version 2.3
linenumbers	true

<xs:sequence>
			<xs:element name="A" type="hlaLocusType" minOccurs="0"/>
			<xs:element name="B" type="hlaLocusType" minOccurs="0"/>
			<xs:element name="C" type="hlaLocusType" minOccurs="0"/>
			<xs:element name="E" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DRB1" type="hlaLocusType" minOccurs="0"/>

XML Example to add the HLA-E:

Code Block

language	xml

<HLA>
	<A>...</A>
	<B>...</B>	
	<E>
		<DNA>
			<FIELD1>01:01:01:01</FIELD1>
			<FIELD2>01:01:01:02</FIELD2>
		</DNA>
	</E>
</HLA>

Add MICA and MICB

Panel

bgColor	lightyellow
title	basicTypes.xsd

Code Block

language	xml
theme	RDark
firstline	1063
title	Version 2.2
linenumbers	true

			<xs:element name="DRB1" type="hlaLocusType" minOccurs="0"/>
			<xs:element name="DRB3" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DRB4" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DRB5" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DQA1" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DQB1" type="hlaLocusType" minOccurs="0"/>
			<xs:element name="DPA1" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DPB1" type="hlaLocusDnaOnlyType" minOccurs="0"/>
		</xs:sequence>

Add fields MICA and MICB as part of HLA

Because of the request to add MICA and MICB, we see issues with naming of the existing schema type for HLA, so some improvements are made.

Change the type of "hlaLocusType" to "hlaLocusSerDnaType" (XSD structure optimization, no effect to XML structure)
Additionally 3 new schema types are added:
- simpleType "hlaGlsFieldType"
- complexType "hlaLocusGlsOnlyType"
- complexType "hlaLocusSerDnaType"

Code Block

language	xml
theme	RDark
firstline	1102
title	Version 2.3
linenumbers	true

			<xs:element name="DRB1" type="hlaLocusSerDnaType" minOccurs="0"/>
			<xs:element name="DRB3" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DRB4" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DRB5" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DQA1" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DQB1" type="hlaLocusSerDnaType" minOccurs="0"/>
			<xs:element name="DPA1" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DPB1" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="MICA" type="hlaLocusGlsOnlyType" minOccurs="0"/>
			<xs:element name="MICB" type="hlaLocusGlsOnlyType" minOccurs="0"/>
		</xs:sequence>

Code Block

language	xml
theme	RDark
firstline	1033
title	Version 2.3
linenumbers	true

	<xs:simpleType name="hlaGlsFieldType">
		<xs:annotation>
			<xs:documentation xml:lang="en">HLA typing result provided as GL String</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:maxLength value="255"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:complexType name="hlaLocusBaseType">

Code Block

language	xml
theme	RDark
firstline	1051
title	Version 2.3
linenumbers	true

	<xs:complexType name="hlaLocusSerDnaType">
		<xs:annotation>
			<xs:documentation xml:lang="en">HLA locus type comprising SER and DNA fields</xs:documentation>
		</xs:annotation>
		<xs:complexContent>
			<xs:restriction base="hlaLocusBaseType">
				<xs:sequence>
					<xs:element name="SER" type="hlaSerFieldsType" minOccurs="0" maxOccurs="1"/>
					<xs:element name="DNA" type="hlaDnaFieldsType" minOccurs="0" maxOccurs="1"/>
					<xs:element name="GLS" type="hlaGlsFieldType" minOccurs="0" maxOccurs="0"/>
				</xs:sequence>
			</xs:restriction>
		</xs:complexContent>
	</xs:complexType>

Code Block

language	xml
theme	RDark
firstline	1099
title	Version 2.3
linenumbers	true

	<xs:complexType name="hlaLocusGlsOnlyType">
		<xs:annotation>
			<xs:documentation xml:lang="en">HLA locus type comprising a GL String only</xs:documentation>
		</xs:annotation>
		<xs:complexContent>
			<xs:restriction base="hlaLocusBaseType">
				<xs:sequence>
					<xs:element name="SER" type="hlaSerFieldsType" minOccurs="0" maxOccurs="0"/>
					<xs:element name="DNA" type="hlaDnaFieldsType" minOccurs="0" maxOccurs="0"/>
					<xs:element name="GLS" type="hlaGlsFieldType" minOccurs="0" maxOccurs="1"/>
				</xs:sequence>
			</xs:restriction>
		</xs:complexContent>
	</xs:complexType>

Additional improvement to XSD structures:

"hlaLocusType" is improved to "hlaLocusBaseType"
Add GLS field with type "hlaGlsFieldType"

Code Block

language	xml
theme	RDark
firstline	1053
title	Version 2.2
linenumbers	true

   <xs:complexType name="hlaLocusType">
		<xs:annotation>
			<xs:documentation xml:lang="en">HLA locus type comprising SER and DNA fields</xs:documentation>
		</xs:annotation>								   							  				   				 										 				 																									  
		<xs:sequence>
			<xs:element name="SER" type="hlaSerFieldsType" minOccurs="0" maxOccurs="1"/>
			<xs:element name="DNA" type="hlaDnaFieldsType" minOccurs="0" maxOccurs="1"/>																			  
		</xs:sequence>
	</xs:complexType>

Code Block

language	xml
theme	RDark
firstline	1061
title	Version 2.3
linenumbers	true

    <xs:complexType name="hlaLocusBaseType">
		<xs:annotation>
			<xs:documentation xml:lang="en">HLA locus base type comprising SER, DNA and GLS fields</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="SER" type="hlaSerFieldsType" minOccurs="0" maxOccurs="1"/>
			<xs:element name="DNA" type="hlaDnaFieldsType" minOccurs="0" maxOccurs="1"/>
			<xs:element name="GLS" type="hlaGlsFieldType" minOccurs="0" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>

XML example to use MICA:

Code Block

language	xml

<HLA>
	<A>...</A>
	<B>...</B>	
	<DPB1>...</DPB1>
	<MICA>
		<GLS>008:01:01/008:01:02/008:03/008:04+018:01/018:02</GLS>
	</MICA>
</HLA>

XSD schema type naming optimization

Panel

bgColor	lightyellow
title	basicTypes.xsd

Code Block

language	xml
theme	RDark
firstline	1053
title	Version 2.2
linenumbers	true

   <xs:complexType name="hlaLocusType">
		<xs:annotation>
			<xs:documentation xml:lang="en">HLA locus type comprising SER and DNA fields</xs:documentation>
		</xs:annotation>								   							  				   				 										 				 																									  
		<xs:sequence>
			<xs:element name="SER" type="hlaSerFieldsType" minOccurs="0" maxOccurs="1"/>
			<xs:element name="DNA" type="hlaDnaFieldsType" minOccurs="0" maxOccurs="1"/>																			  
		</xs:sequence>
	</xs:complexType>

Because of the request to add MICA and MICB, we see issue with naming of the schema type for HLA fields, so some additional improvements are made as below:

"hlaLocusType" is improved to "hlaLocusBaseType"
Add GLS field with type "hlaGlsFieldType" in the "hlaLocusBaseType"

Code Block

language	xml
theme	RDark
firstline	1061
title	Version 2.3
linenumbers	true

    <xs:complexType name="hlaLocusBaseType">
		<xs:annotation>
			<xs:documentation xml:lang="en">HLA locus base type comprising SER, DNA and GLS fields</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="SER" type="hlaSerFieldsType" minOccurs="0" maxOccurs="1"/>
			<xs:element name="DNA" type="hlaDnaFieldsType" minOccurs="0" maxOccurs="1"/>
			<xs:element name="GLS" type="hlaGlsFieldType" minOccurs="0" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>

Space shortcuts

Page tree

Versions Compared

Old Version 33

New Version 34

Key

Download XSD version 2.3 :

Changes between version 2.2 and 2.3

Updated version number to 2.3

Move GRID/ID

Change Field Name KIR_GL to KIR_GLS_URI

Add HLA-E

Add MICA and MICB

XSD schema type naming optimization

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 33

New Version 34

Key

Download XSD version 2.3 :

Changes between version 2.2 and 2.3

Updated version number to 2.3

Move GRID/ID

Change Field Name KIR_GL to KIR_GLS_URI

Add HLA-E

Add MICA and MICB

XSD schema type naming optimization