Page History

Timeline

Proposal ready:

31 Jul 2020

XSD public available

17 Sep 2020

Communication period
Implementation / testing

Q4, 2020

Release Date

Q4,2020 or Q1,2021

Status

Progress Bar | Vectors (Formerly: SP Progress bar)

current-step	3
steps	Preparation, Draft,Public review , Implementation, Release

Info

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

WMDA data-upload will still support XSD 2.1 till 2020.Q4.

Organsations have one year to arrange the update of using XSD 2.2.

...

Panel

bgColor	lightyellow
title	Inventories.xsd

Code Block

language	xml
theme	RDark
title	Version 2.1
linenumbers	true

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

Update version number to 2.2

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.3">

...

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">
				...

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'.
Move GRID to the sequence to the type "donItemType", and changed GRID to 'required'.
Business rules state : DONOR records should have grid, and optional ID. CBU records should have ID, and no GRID.

Changed length to 25 chars

Please note that in a future version (2.3) the GRID and ID will probably move to another location.

Code Block

language	xml
theme	RDark
firstline	86
title	Version 2.3

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="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>
					<xs:element name="ID" minOccurs="0">
						...
					</xs:element>
					<xs:element name="GRID" minOccurs="1">
						...
					</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="STAT_REASON" type="statReasonCbuType" minOccurs="0">
						...
					</xs:element>
					<xs:element name="ID" minOccurs="1">
						...
					</xs:element>

...

Change Field Name KIR_GL to KIR_GLS_URI

Panel

bgColor	lightyellow
title	basicTypes.xsd

Code Block

language	xml
theme	RDark	firstline	1059
title	Version version 2.2
linenumbers	true

		<xs:sequence>
			<xs:elementelement name="AKIR_GL" type="hlaLocusType" minOccurs="0"/>
				<xs:element name="B" type="hlaLocusType" minOccurs="0"/>annotation>
					<xs:elementdocumentation namexml:lang="Cen" type="hlaLocusType" minOccurs="0"/>
            <xs:element name="DRB1" type="hlaLocusType" minOccurs="0"/>

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

>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

Code Block

language	xml
title	Version 2.2
linenumbers	true

<xs:sequence>
			<xs:element name="AKIR_GLS_URI" typeminOccurs="hlaLocusType" minOccurs="0"/>0">
			<xs:element name="B" type="hlaLocusType" minOccurs="0"/>
annotation>
				<xs:elementdocumentation namexml:lang="Cen" type="hlaLocusType" minOccurs="0"/>
			<xs:element name="E" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DRB1" type="hlaLocusType" minOccurs="0"/>>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>

Additionally a new simpleType bareBankIdType has been defined in basicTypes

Code Block

<xs:simpleType name="cbBankIdType">
		<!-- @v2.2 added -->
		<xs:annotation>
			<xs:documentationelement xml:langname="enA">Bank ID type (CBB)</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string"type="hlaLocusType" minOccurs="0"/>
			<xs:element name="B" type="hlaLocusType" minOccurs="0"/>
			<xs:maxLengthelement valuename="10"/>
		</xs:restriction>
	</xs:simpleType>

Examples to add the HLA-E:

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

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

...


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="E" type="hlaLocusDnaOnlyType" minOccurs="0"/>
			<xs:element name="DRB1" type="hlaLocusType

Panel

bgColor	lightyellow
title	Inventories.xsd

Code Block

language	xml
theme	RDark
linenumbers	true

			<xs:element name="GRID" minOccurs="0"  >
				<xs:annotation>
					<xs:documentation xml:lang="en">Global registration identifier of the donor/CBU.</xs:documentation>
				</xs:annotation>
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:length value="19"/>
					</xs:restriction>
				</xs:simpleType>/>

Examples 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"/>

Updated documentation

Please note that in version 2.3 the position of this element may change

Code Block

language	xml
linenumbers	true

			<xs:element name="GRIDDRB5" type="hlaLocusDnaOnlyType" minOccurs="0"  />
				<xs:annotation>
	element name="DQA1" type="hlaLocusDnaOnlyType" minOccurs="0"/>
				<xs:documentationelement xml:langname="enDQB1">Global 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 (affect XML)

Because of the request to add MICA and MICB, we see issue with naming of the existing HLA types, so some improvements are made.

Change the type of "hlaLocusType" to "hlaLocusSerDnaType" (XSD structure optimization)
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"/>registration identifier of the donor. This element is required for Donors.</xs:documentation>
				</xs:annotation>
				<xs:simpleType>
					<xs:restriction base="xs:string"element name="GLS" type="hlaGlsFieldType" minOccurs="0" maxOccurs="0"/>
						<xs:length value="19"/>
		</xs:sequence>
			</xs:restriction>
			</xs:complexContent>
	</xs:simpleType>

Updated CMV elements ( RFC-001S Distinguish different CMV/HIV tests (ANTI-vs. PCR)#/ )

Renamed CMV to ANTI_CMV
Renamed CMV_DATE to ANTI_CMV_DATE and changed order to be after ANTI_CMV
Added CMV_NAT_DATE
The changes above effect CMV fields for DONOR, CBU, and CBU Maternal

...

language	xml
theme	RDark

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>

...

language	xml

...

														  
		<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>

Space shortcuts

Page tree

Versions Compared

Old Version 1

New Version 2

Key

Change Field Name KIR_GL to KIR_GLS_URI

Add HLA-E

Add MICA and MICB

Updated CMV elements ( RFC-001S Distinguish different CMV/HIV tests (ANTI-vs. PCR)#/ )