XML Schema Constraints applied to the HIV and AIDS Reporting Data Set.
Key to XML Schema Constraint Column Headings:
Column Name | Column Meaning | Column Options | ||
XML Schema Format/Length | Indicates any differences between the Format/Length of the item in the NHS Data Model and Dictionary and the XML Schema representation | None = The Format/Length is the same as the NHS Data Model and Dictionary | Any other entry = The Format/Length is different in the XML Schema to the NHS Data Model and Dictionary | |
Allowed Values | Indicates whether the NHS Data Model and Dictionary National Codes and Default Codes are present in the XML Schema | None = The NHS Data Model and Dictionary National and Default Codes are present in the XML Schema | Removed = The NHS Data Model and Dictionary National Codes and Default Codes are not present in the XML Schema | Any other entry = Shows the values present in the XML Schema which are a subset of those in the NHS Data Model and Dictionary |
Range | Indicates whether a range value constraint has been applied in the XML Schema | None = There is no range value constraint applied in the XML Schema | Any other entry = Shows the range value constraint applied in the XML Schema | |
Pattern Match | Indicates whether a data pattern, to which the data must conform, has been applied in the XML Schema | None = There is no data pattern, to which the data must conform, applied in the XML Schema | Any other entry = Shows the data pattern, to which the data must conform, applied in the XML Schema |
XML Schema Constraints:
Data Element | XML Schema Format/Length | Allowed Values | Range | Pattern Match | Reason / Comment / XML Choice |
CONSULTATION MEDIUM USED | None | 01,02,03,04,05 | None | None | National Code 06, 07, 08 and 98 not applicable - removed |
COUNTRY CODE (BIRTH) | None | None | None | [A-Z][A-Z][A-Z] | Format pattern applied to allow correct reporting of COUNTRY CODE (BIRTH) |
COUNTRY CODE (HIV INFECTION) | None | None | None | [A-Z][A-Z][A-Z] | Format pattern applied to allow correct reporting of COUNTRY CODE (HIV INFECTION) |
DATE AND TIME DATA SET CREATED | None | None | None | (19|20)\d\d-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T((0[1-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])) | Format pattern applied to allow correct reporting of DATE AND TIME DATA SET CREATED |
ETHNIC CATEGORY | max an2 | None | None | None | Existing Format/Length means fixed length which is incorrect. Unable to change this as it is used in other data sets. Second character can be for local use. Format/Length amended to max an2. |
GENERAL MEDICAL PRACTICE CODE (PATIENT REGISTRATION) | min an3 max an12 | Removed | None | None | Field size extended to future proof for ODS ORGANISATION CODE changes |
HARS MESSAGE VERSION IDENTIFIER | None | None | None | \d.\d.\d | Format pattern applied to allow correct reporting of HARS MESSAGE VERSION IDENTIFIER |
HARS SUBMISSION IDENTIFIER | None | None | None | [0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12} | Format pattern applied to allow correct reporting of HARS SUBMISSION IDENTIFIER |
HARS UNIQUE IDENTIFIER | None | None | None | [0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12} | Format pattern applied to allow correct reporting of HARS UNIQUE IDENTIFIER |
ORGANISATION CODE (CODE OF PROVIDER) | min an3 max an12 | Removed | None | None | Field size extended to future proof for ODS ORGANISATION CODE changes |
ORGANISATION CODE (CODE OF SUBMITTING ORGANISATION) | min an3 max an12 | None | None | None | Field size extended to future proof for ODS ORGANISATION CODE changes |
SITE CODE (OF PREVIOUS HIV CARE) | min an3 max an12 | Removed | None | None | Field size extended to future proof for ODS ORGANISATION SITE CODE changes |
SITE CODE (OF TREATMENT) | min an3 max an12 | Removed | None | None | Field size extended to future proof for ODS ORGANISATION SITE CODE changes |
SITE CODE (REFERRED TO FOR SHARED HIV CARE) | min an3 max an12 | None | None | None | Field size extended to future proof for ODS ORGANISATION SITE CODE changes |
TEST OF RECENT INFECTION RESULT (HIV) | None | None | None | \d{1,3}\.\d{1} | Format pattern applied to allow correct reporting of TEST OF RECENT INFECTION RESULT (HIV) |
YEAR AND MONTH FIRST STARTED ANTIRETROVIRAL THERAPY | None | None | None | (19|20)\d\d-(0[1-9]|1[012]) | Format pattern applied to allow correct reporting of YEAR AND MONTH FIRST STARTED ANTIRETROVIRAL THERAPY |
YEAR AND MONTH OF LAST CARE PROFESSIONAL HIV COMMUNICATION | None | None | None | (19|20)\d\d-(0[1-9]|1[012]) | Format pattern applied to allow correct reporting of YEAR AND MONTH OF LAST CARE PROFESSIONAL HIV COMMUNICATION |
YEAR AND MONTH OF LAST NEGATIVE HIV TEST | None | None | None | (19|20)\d\d-(0[1-9]|1[012]) | Format pattern applied to allow correct reporting of YEAR AND MONTH OF LAST NEGATIVE HIV TEST |
YEAR OF DIAGNOSIS OUTSIDE UNITED KINGDOM (HIV) | None | None | None | (19|20){1}\d\d | Format pattern applied to allow correct reporting of YEAR OF DIAGNOSIS OUTSIDE UNITED KINGDOM (HIV) |
YEAR OF UK ENTRY | None | None | None | (19|20){1}\d\d | Format pattern applied to allow correct reporting of YEAR OF UK ENTRY |