HIV and AIDS Reporting Data Set XML Schema Constraints

XML Schema constraints applied to the HIV and AIDS Reporting Data Set.

The "Allowed Values" column indicates the NHS Data Model and Dictionary National Codes and Default Codes present in the XML Schema:

Data ElementXML Schema Format/LengthAllowed ValuesRangePattern MatchReason / Comment / XML Choice
CONSULTATION MEDIUM USEDNone
01,02,03,04,05
None
None
National Code 06 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 CREATEDNone
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 CATEGORYmax 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 IDENTIFIERNone
None
None
\d.\d.\d
Format pattern applied to allow correct reporting of HARS MESSAGE VERSION IDENTIFIER
HARS SUBMISSION IDENTIFIERNone
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 IDENTIFIERNone
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 THERAPYNone
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 COMMUNICATIONNone
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 TESTNone
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 ENTRYNone
None
None
(19|20){1}\d\d
Format pattern applied to allow correct reporting of YEAR OF UK ENTRY