diff --git a/hml/HEADER.txt b/hml/HEADER.txt index 69c59afe..4a19e836 100644 --- a/hml/HEADER.txt +++ b/hml/HEADER.txt @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published diff --git a/hml/pom.xml b/hml/pom.xml index f94115c9..29766380 100644 --- a/hml/pom.xml +++ b/hml/pom.xml @@ -2,7 +2,7 @@ + targetNamespace="http://schemas.nmdp.org/spec/hml/1.0" + version="1.0.2"> @@ -59,7 +59,8 @@ - Expected to be '1.0.1' to use this version of the HML schema. + Expected to be a '1.0.x' version like '1.0.2' to use this version of the HML schema. + HML 1.0.2 released March 2016. @@ -79,42 +80,6 @@ - - - - This element identifies the entity/organization sending this HML data. - If included, must contain a unique ID identifying the sender as well as - a context which defines to whom the ID is meaningful or the source - of the ID. - This element is required for NMDP transactions and if context is not - included, is assumed to be "NMDP". - - Attributes: - ----------- - - reporting-center-id: (required) Unique id of reporting center - like "789". - - reporting-center-context: (optional) Source of the reporting center ID - like "NMDP". To whom the ID is meaningful. - - - - - - - - - - - - - - - - - - - - @@ -132,9 +97,16 @@ ----------- - root: Unique publicly registered identifier for the HML creator's organization. - (ex: NMDP HL7 id is "2.16.840.1.113883.3.1470") - Format is expected to be a string of digits and dot - delimiters. (required) + Examples: + + HL7: NMDP HL7 id is "2.16.840.1.113883.3.1470" + + + UUID: + + + Root format is expected to be a string of digits with + dot or dash delimiters. (required) - extension: A unique document identifier managed internally by the organization specified in 'root'. Can be any alpha-numeric format desired by the organization. (ex: "hml-0.9.7-123456789.23a") @@ -154,10 +126,11 @@ Unique publicly registered identifier for the HML creator's organization. This can be an HL7 compliant field (ex: NMDP is "2.16.840.1.113883.3.1470") - Format is expected to be a string of digits and dot delimiters. (required) + The format can also be a UUID like "5177ec14-495b-4fea-a8fc-de1311f241cd". + Format is expected to be a string of digits and dot or hyphen delimiters. (required) - + @@ -177,6 +150,42 @@ + + + + This element identifies the entity/organization sending this HML data. + If included, must contain a unique ID identifying the sender as well as + a context which defines to whom the ID is meaningful or the source + of the ID. + This element is required for NMDP transactions and if context is not + included, is assumed to be "NMDP". + + Attributes: + ----------- + - reporting-center-id: (required) Unique id of reporting center + like "789". + - reporting-center-context: (optional) Source of the reporting center ID + like "NMDP". To whom the ID is meaningful. + + + + + + + + + + + + + + + + + + + + @@ -245,7 +254,7 @@ - + @@ -754,7 +763,7 @@ Children: --------- - - amplification (required, qty: 1) + - amplification (not required, qty: 0 or 1) - sub-amplification (not required, qty: 0 or more) - gssp (not required, qty: 0 or more) @@ -783,7 +792,7 @@ - + @@ -833,9 +842,7 @@ - - - + @@ -1313,7 +1320,7 @@ @@ -1564,8 +1571,8 @@ - paired: true/false (default) (required) - pooled: true/false (default) (required) - availability: public|private|permission (optional) - - adapterTrimmed: true/false (default) (required) - - qualityTrimmed: true/false (default) (required) + - adapter-trimmed: true/false (default) (required) + - quality-trimmed: true/false (default) (required) diff --git a/hml/src/main/xsd/hml-1.0.1.xjb b/hml/src/main/xsd/hml-1.0.2.xjb similarity index 90% rename from hml/src/main/xsd/hml-1.0.1.xjb rename to hml/src/main/xsd/hml-1.0.2.xjb index 2eb07c7b..e15a2711 100644 --- a/hml/src/main/xsd/hml-1.0.1.xjb +++ b/hml/src/main/xsd/hml-1.0.2.xjb @@ -2,7 +2,7 @@ + targetNamespace="http://schemas.nmdp.org/spec/hml/1.0" + version="1.0.2"> @@ -59,7 +59,8 @@ - Expected to be '1.0.1' to use this version of the HML schema. + Expected to be a '1.0.x' version like '1.0.2' to use this version of the HML schema. + HML 1.0.2 released March 2016. @@ -79,42 +80,6 @@ - - - - This element identifies the entity/organization sending this HML data. - If included, must contain a unique ID identifying the sender as well as - a context which defines to whom the ID is meaningful or the source - of the ID. - This element is required for NMDP transactions and if context is not - included, is assumed to be "NMDP". - - Attributes: - ----------- - - reporting-center-id: (required) Unique id of reporting center - like "789". - - reporting-center-context: (optional) Source of the reporting center ID - like "NMDP". To whom the ID is meaningful. - - - - - - - - - - - - - - - - - - - - @@ -132,9 +97,16 @@ ----------- - root: Unique publicly registered identifier for the HML creator's organization. - (ex: NMDP HL7 id is "2.16.840.1.113883.3.1470") - Format is expected to be a string of digits and dot - delimiters. (required) + Examples: + + HL7: NMDP HL7 id is "2.16.840.1.113883.3.1470" + + + UUID: + + + Root format is expected to be a string of digits with + dot or dash delimiters. (required) - extension: A unique document identifier managed internally by the organization specified in 'root'. Can be any alpha-numeric format desired by the organization. (ex: "hml-0.9.7-123456789.23a") @@ -154,10 +126,11 @@ Unique publicly registered identifier for the HML creator's organization. This can be an HL7 compliant field (ex: NMDP is "2.16.840.1.113883.3.1470") - Format is expected to be a string of digits and dot delimiters. (required) + The format can also be a UUID like "5177ec14-495b-4fea-a8fc-de1311f241cd". + Format is expected to be a string of digits and dot or hyphen delimiters. (required) - + @@ -177,6 +150,42 @@ + + + + This element identifies the entity/organization sending this HML data. + If included, must contain a unique ID identifying the sender as well as + a context which defines to whom the ID is meaningful or the source + of the ID. + This element is required for NMDP transactions and if context is not + included, is assumed to be "NMDP". + + Attributes: + ----------- + - reporting-center-id: (required) Unique id of reporting center + like "789". + - reporting-center-context: (optional) Source of the reporting center ID + like "NMDP". To whom the ID is meaningful. + + + + + + + + + + + + + + + + + + + + @@ -245,7 +254,7 @@ - + @@ -754,7 +763,7 @@ Children: --------- - - amplification (required, qty: 1) + - amplification (not required, qty: 0 or 1) - sub-amplification (not required, qty: 0 or more) - gssp (not required, qty: 0 or more) @@ -783,7 +792,7 @@ - + @@ -833,9 +842,7 @@ - - - + @@ -1313,7 +1320,7 @@ @@ -1564,8 +1571,8 @@ - paired: true/false (default) (required) - pooled: true/false (default) (required) - availability: public|private|permission (optional) - - adapterTrimmed: true/false (default) (required) - - qualityTrimmed: true/false (default) (required) + - adapter-trimmed: true/false (default) (required) + - quality-trimmed: true/false (default) (required) diff --git a/hml/src/test/java/org/nmdp/ngs/hml/HmlReaderTest.java b/hml/src/test/java/org/nmdp/ngs/hml/HmlReaderTest.java index e570872c..58a42dc0 100644 --- a/hml/src/test/java/org/nmdp/ngs/hml/HmlReaderTest.java +++ b/hml/src/test/java/org/nmdp/ngs/hml/HmlReaderTest.java @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published diff --git a/hml/src/test/java/org/nmdp/ngs/hml/HmlUtilsTest.java b/hml/src/test/java/org/nmdp/ngs/hml/HmlUtilsTest.java index 844d4d1d..9ec9db7c 100644 --- a/hml/src/test/java/org/nmdp/ngs/hml/HmlUtilsTest.java +++ b/hml/src/test/java/org/nmdp/ngs/hml/HmlUtilsTest.java @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published diff --git a/hml/src/test/java/org/nmdp/ngs/hml/HmlValidationExceptionTest.java b/hml/src/test/java/org/nmdp/ngs/hml/HmlValidationExceptionTest.java index f01fc66d..82d580a0 100644 --- a/hml/src/test/java/org/nmdp/ngs/hml/HmlValidationExceptionTest.java +++ b/hml/src/test/java/org/nmdp/ngs/hml/HmlValidationExceptionTest.java @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published diff --git a/hml/src/test/java/org/nmdp/ngs/hml/HmlWriterTest.java b/hml/src/test/java/org/nmdp/ngs/hml/HmlWriterTest.java index b1ff6ace..bdc88a04 100644 --- a/hml/src/test/java/org/nmdp/ngs/hml/HmlWriterTest.java +++ b/hml/src/test/java/org/nmdp/ngs/hml/HmlWriterTest.java @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published @@ -55,7 +55,7 @@ public final class HmlWriterTest { @Before public void setUp() throws Exception { data = new Hml(); - data.setVersion("1.0.1"); + data.setVersion("1.0.2"); data.setProjectName("LAB"); ReportingCenter reportingCenter = new ReportingCenter(); diff --git a/hml/src/test/java/org/nmdp/ngs/hml/rules/AbstractHmlValidationRuleTest.java b/hml/src/test/java/org/nmdp/ngs/hml/rules/AbstractHmlValidationRuleTest.java index 1ba1f41d..5fa9d3ea 100644 --- a/hml/src/test/java/org/nmdp/ngs/hml/rules/AbstractHmlValidationRuleTest.java +++ b/hml/src/test/java/org/nmdp/ngs/hml/rules/AbstractHmlValidationRuleTest.java @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published diff --git a/hml/src/test/java/org/nmdp/ngs/hml/rules/HmlValidationRulesTest.java b/hml/src/test/java/org/nmdp/ngs/hml/rules/HmlValidationRulesTest.java index e877632f..6d39fe99 100644 --- a/hml/src/test/java/org/nmdp/ngs/hml/rules/HmlValidationRulesTest.java +++ b/hml/src/test/java/org/nmdp/ngs/hml/rules/HmlValidationRulesTest.java @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published diff --git a/hml/src/test/java/org/nmdp/ngs/hml/rules/HmlValidatorImplTest.java b/hml/src/test/java/org/nmdp/ngs/hml/rules/HmlValidatorImplTest.java index fc572fb8..b278496e 100644 --- a/hml/src/test/java/org/nmdp/ngs/hml/rules/HmlValidatorImplTest.java +++ b/hml/src/test/java/org/nmdp/ngs/hml/rules/HmlValidatorImplTest.java @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published diff --git a/hml/src/test/java/org/nmdp/ngs/hml/rules/MiringModuleTest.java b/hml/src/test/java/org/nmdp/ngs/hml/rules/MiringModuleTest.java index aabe915d..c4826e92 100644 --- a/hml/src/test/java/org/nmdp/ngs/hml/rules/MiringModuleTest.java +++ b/hml/src/test/java/org/nmdp/ngs/hml/rules/MiringModuleTest.java @@ -1,7 +1,7 @@ /* ngs-hml Mapping for HML XSDs. - Copyright (c) 2014-2015 National Marrow Donor Program (NMDP) + Copyright (c) 2014-2017 National Marrow Donor Program (NMDP) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published diff --git a/hml/src/test/resources/org/nmdp/ngs/hml/hml-example.xml b/hml/src/test/resources/org/nmdp/ngs/hml/hml-example.xml index cc03d8b3..4b6d972e 100644 --- a/hml/src/test/resources/org/nmdp/ngs/hml/hml-example.xml +++ b/hml/src/test/resources/org/nmdp/ngs/hml/hml-example.xml @@ -24,12 +24,12 @@ - + version="1.0.2"> buccal swab diff --git a/hml/src/test/resources/org/nmdp/ngs/hml/hmlid.xml b/hml/src/test/resources/org/nmdp/ngs/hml/hmlid.xml index fdd70d69..fc19ea64 100644 --- a/hml/src/test/resources/org/nmdp/ngs/hml/hmlid.xml +++ b/hml/src/test/resources/org/nmdp/ngs/hml/hmlid.xml @@ -2,7 +2,7 @@ - + version="1.0.2"> diff --git a/hml/src/test/resources/org/nmdp/ngs/hml/invalid-schema.xml b/hml/src/test/resources/org/nmdp/ngs/hml/invalid-schema.xml index 019fcfb7..19f5abde 100644 --- a/hml/src/test/resources/org/nmdp/ngs/hml/invalid-schema.xml +++ b/hml/src/test/resources/org/nmdp/ngs/hml/invalid-schema.xml @@ -2,7 +2,7 @@ - + version="1.0.2"/> diff --git a/hml/src/test/resources/org/nmdp/ngs/hml/invalid-syntax.xml b/hml/src/test/resources/org/nmdp/ngs/hml/invalid-syntax.xml index ec2cacb1..9825045d 100644 --- a/hml/src/test/resources/org/nmdp/ngs/hml/invalid-syntax.xml +++ b/hml/src/test/resources/org/nmdp/ngs/hml/invalid-syntax.xml @@ -2,7 +2,7 @@ - + version="1.0.2"> diff --git a/hml/src/test/resources/org/nmdp/ngs/hml/missing-hmlid.xml b/hml/src/test/resources/org/nmdp/ngs/hml/missing-hmlid.xml index cc03d8b3..7ab73016 100644 --- a/hml/src/test/resources/org/nmdp/ngs/hml/missing-hmlid.xml +++ b/hml/src/test/resources/org/nmdp/ngs/hml/missing-hmlid.xml @@ -2,7 +2,7 @@ - + version="1.0.2"> buccal swab diff --git a/hml/src/test/resources/org/nmdp/ngs/hml/rules/hmlid.xml b/hml/src/test/resources/org/nmdp/ngs/hml/rules/hmlid.xml index fdd70d69..fc19ea64 100644 --- a/hml/src/test/resources/org/nmdp/ngs/hml/rules/hmlid.xml +++ b/hml/src/test/resources/org/nmdp/ngs/hml/rules/hmlid.xml @@ -2,7 +2,7 @@ - + version="1.0.2"> diff --git a/hml/src/test/resources/org/nmdp/ngs/hml/rules/missing-hmlid.xml b/hml/src/test/resources/org/nmdp/ngs/hml/rules/missing-hmlid.xml index cc03d8b3..7ab73016 100644 --- a/hml/src/test/resources/org/nmdp/ngs/hml/rules/missing-hmlid.xml +++ b/hml/src/test/resources/org/nmdp/ngs/hml/rules/missing-hmlid.xml @@ -2,7 +2,7 @@ - + version="1.0.2"> buccal swab