Data Types


Contents

1. Schema

2. Coded Types

2.1 cs

2.2 CV.GB-en-NHS.CodedValueType1

2.3 CV.GB-en-NHS.CodedValueType6

2.4 CV.GB-en-NHS.CodedValueType8

3. Identifier Types

3.1 II

3.2 II.GB-en-NHS.IdentifierType2

3.3 II.GB-en-NHS.IdentifierType4

3.4 II.GB-en-NHS.IdentifierType5

3.5 II.GB-en-NHS.IdentifierType6

3.6 II.GB-en-NHS.IdentifierType7

4. String Types

4.1 st

4.2 ST

5.2 ST.GB-en-NHS.StringType1

5 Number Types

5.1 int

5.2 INT

 


1. Schema

Format Document Title Description

HARS XML DataTypes Version 1-0 This schema file provides an implementation of the data types specified in this document.

2. Coded Types

2.1 cs

The simple type string is defined as follows:

Attribute Cardinality Notes
code 1..1 The actual value of the code is held here.

2.2 CV.GB-en-NHS.CodedValueType1

Attribute Cardinality Notes
code 1..1 This attribute holds the actual code.
codeSystem 0..0 This attribute should be fixed to the OID representing the code system from which the concept is drawn.
codeSystemName 0..0  
codeSystemVersion 0..0  
displayName 0..0  
originalText 0..0  
translation 0..0  

The following schema restrictions apply:

Attribute Restriction Notes
code Parent <xs:restrictionbase="cs"> Indicates that this is a restriction of the coded simple data type.

2.3 CV.GB-en-NHS.CodedValueType2

This flavour supports the use of NICIP content and is implemented as follows:

Attribute Cardinality Notes
code 1..1 This attribute holds the actual code.
codeSystem 0..0 This attribute is fixed at the OID "2.16.840.1.113883.2.1.3.2.4.21".
codeSystemName 0..0  
codeSystemVersion 0..0  
displayName 0..0  
originalText 0..0  
translation 0..0  

The following schema restrictions apply:

Attribute Restriction Notes
code Parent <xs:restriction base="cs"> Indicates that this is a restriction of the coded simple data type.
Length <xs:minLength value="1"/>
<
xs:maxLength value="6
"/>
Indicates that the minimum length is 1.
Indicates that the maximum length is 6.

2.4 CV.GB-en-NHS.CodedValueType6

This flavour supports the use of ICD10 content and is implemented as follows:

Attribute Cardinality Notes
code 1..1 This attribute holds the actual code.
codeSystem 0..0 This attribute is fixed at the OID "2.16.840.1.113883.6.3".
codeSystemName 0..0  
codeSystemVersion 0..0  
displayName 0..0  
originalText 0..0  
translation 0..0  

The following schema restrictions apply:

Attribute Restriction Notes
code Parent <xs:restriction base="cs"> Indicates that this is a restriction of the coded simple data type.
Length <xs:minLength value="4"/>
<
xs:maxLength value="6"/>
Indicates that the minimum length is 4 and the maximum length is 6.

2.5 CV.GB-en-NHS.CodedValueType8

This flavour supports the use of SNOMED-CT content and is implemented as follows:

Attribute Cardinality Notes
code 1..1 This attribute holds the actual code.
codeSystem 0..0 This attribute is fixed at the OID "2.16.840.1.113883.2.1.3.2.4.16.6".
codeSystemName 0..0  
codeSystemVersion 0..0  
displayName 0..0  
originalText 0..0  
translation 0..0  

The following schema restrictions apply:

Attribute Restriction Notes
code Parent <xs:restriction base="cs"> Indicates that this is a restriction of the coded simple data type.
Length <xs:minLength value="1"/>
<
xs:maxLength value="2"/>
Indicates that the maximum length is 18.
Pattern <xs:pattern value="99"/>
<
xs:pattern value="[ABCDEFGHJKLMNPRSZ]"/>
<
xs:pattern value="[ABCDEFGHJKLMNPRSZ]."/>
Indicates values of 99 or ABCDEFGHJKLMNPRSZ.

3. Identifier Types

3.1 II

The complex type instance identifier is defined as:

Attribute Cardinality Notes
root 0..1  
extension 0..1  
assigningAuthorityName 0..1  
displayable 0..1  

3.2 II.GB-en-NHS.IdentifierType2

This flavour supports the sending of a DCE UUID.

Attribute Cardinality Notes
root 1..1 This attribute SHALL contain a DCE UUID
extension 0..0  
assigningAuthorityName 0..0  
displayable 0..0  

The following schema restrictions apply:

Attribute Restriction Notes
extension Parent <xs:restriction base="st"> Indicates that this is a restriction of the string data type.
Pattern <xs:pattern value="[A-Z0-9]*"/> Indicates that the allowable characters are the ranges A-Z and 0-9.

3.3 II.GB-en-NHS.IdentifierType4

This flavour supports the sending of Organisation data as derived from ODS.

Attribute Cardinality Notes
root 1..1 This attribute holds the OID for the identification scheme.  The default OID for ODS Organisations is: 2.16.840.1.113883.2.1.3.2.4.19.1
extension 1..1 This attribute holds the value for the identifier.
assigningAuthorityName 0..0  
displayable 0..0  

The following schema restrictions apply:

Attribute Restriction Notes
extension Parent <xs:restriction base="st"> Indicates that this is a restriction of the string data type.
Length <xs:minLength value="3"/>
<
xs:maxLength value="12
"/>

Indicates that the minimum length is 3.
Indicates that the maximum length is 12.
Pattern <xs:pattern value="[A-Z0-9]*"/> Indicates that the allowable characters are the ranges A-Z and 0-9.

4. String Types

 4.1 st

The simple type string is defined as follows:

Attribute Cardinality Notes
<content> 1..1 The actual value of the date is held as element content.

 4.2 ST

The complex type string is defined as follows:

Attribute Cardinality Notes
<content> 1..1 The actual value is held as element content.

 4.3 ST.GB-en-NHS.StringType1

This flavour supports the use of date content as a string and is implemented as follows:

Attribute Cardinality Notes
<content> 1..1 The actual value of the date is held as element content.

The following schema restrictions apply:

Attribute Restriction Notes
<content> Parent <xs:restriction base="st"> Indicates that this is a restriction of the string data type.
Pattern <xs:pattern value="(19|20)\d\d-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])"/>  Indicates that the format should be YYYY-MM-DD.

 4.4 ST.GB-en-NHS.StringType2

This flavour supports the use of boolean content as a string and is implemented as follows:

Attribute Cardinality Notes
<content> 1..1 The actual value of the boolean is held as element content.

The following schema restrictions apply:

Attribute Restriction Notes
<content> Parent <xs:restriction base="st"> Indicates that this is a restriction of the string data type.
Pattern <xs:enumeration value="Y"/>
<
xs:enumeration value="N"/>
Indicates that the allowed values are Y, N.

5. Number Types

 5.1 int

The simple type string is defined as follows:

Attribute Cardinality Notes
<content> 1..1 The actual value of the integer is held as attribute content.

 5.2 INT

This supports the use of integers and is implemented as follows:

Attribute Cardinality Notes
value 1..1 The actual value of the integer is held as an int.