Data Types


Contents

1. Schema

2. Address Types

2.1 AD

2.2 AD.GB-en-NHS.AddressType1

2.3 AD.GB-en-NHS.AddressType1

3. Coded Types

3.1 cs

3.2 CV

3.3 CV.GB-en-NHS.CodedValueType1

3.4 CV.GB-en-NHS.CodedValueType2

3.5 CV.GB-en-NHS.CodedValueType3

4. Identifier Types

4.1 II

4.2 II.GB-en-NHS.IdentifierType4

4.3 II.GB-en-NHS.IdentifierType5

4.4 II.GB-en-NHS.IdentifierType6

4.5 II.GB-en-NHS.IdentifierType7

5. String Types

5.1 st

5.2 ST.GB-en-NHS.StringType1

 


1. Schema

Format Document Title Description

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

2. Address Types

2.1 AD

Attribute Cardinality Notes
use

0..1

The use of the address.  the permitted values are:
  • "H" (Home Address)
  • "HP" (Primary Home)
  • "TMP" (Temporary Address)
  • "PST" (Postal Address)
  • "WP" (Work Place)
country

0..*

The country part of the address.
state

0..*

The state part of the address
county

0..*

The county part of the address.
city

0..*

The city part of the address.
postalCode

0..*

The postcode part of the address.
streetAddressLine

0..*

A construct used for any address part with no need to specify the part.
houseNumber

0..*

The house number part of the address.
houseNumberNumeric

0..*

The numeric house number part of the address.
direction

0..*

The direction of the address.
streetName

0..*

The street name part of the address.
streetNameBase

0..*

The base name of the street part of the address.
streetNameType

0..*

The street name type.
additionalLocator

0..*

An additional locator.
unitID

0..*

The unit identifier of a specific unit within a building or complex.
unitType

0..*

The type of unit.
carrier

0..*

 
censusTract

0..*

A geographic unit used for demographics.
addressKey

0..*

The key associated with the address.
desc

0..*

A description of the address.
usablePeriod

0..*

The usable period of the address.

2.2 AD.GB-en-NHS.AddressType1

Attribute Cardinality Notes
postalCode 1..1 This attribute carries the postcode.
Attribute Restriction Notes
postalCode Parent <xs:restrictionbase="postalCodeType"> Indicates that this is a restriction of the postal code custom type.
Pattern <xs:pattern value="[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z-[CIKMOV]]{2}"/> Indicates that the pattern for postal code.

3. Coded Types

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

3.2 CV

Attribute Cardinality Notes
code 0..1 The code to be used.
codeSystem 0..1 The identifier of the system from which the code is drawn.
codeSystemName 0..1 The name of the system from which the code is drawn.
codeSystemVersion 0..1 The version of the system from which the code is drawn.
displayName 0..1 The text associated with the code.
originalText 0..1 The original text used as the basis for coding.
translation 0..1 A translation to an alternative code system.

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

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

3.5 CV.GB-en-NHS.CodedValueType3

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.15".
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:maxLength value="18"/> Indicates that the maximum length is 18.

4. Identifier Types

4.1 II

Attribute Cardinality Notes
root 0..1 An identifier which guarantees uniqueness.
extension 0..1 A string which is the unique identifier within the root scope.
assigningAuthorityName 0..1 The authority which assigned the identifier.
displayable 0..1 Indicates whether the identifier is intended for human display.

4.2 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.3 II.GB-en-NHS.IdentifierType5

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

Attribute Cardinality Notes
root 0..0 This attribute is fixed to the OID: 2.16.840.1.113883.2.1.4.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:length value="10"/> Indicates that the length is 10.
Pattern <xs:pattern value="[0-9]{10}"/> Indicates that the allowable pattern is 10 characters from the range 0-9.

4.4 II.GB-en-NHS.IdentifierType6

This flavour supports the use of Radiological Accession Number content and is implemented as follows:

Attribute Cardinality Notes
root 0..0 This attribute is fixed to the OID: 2.16.840.1.113883.2.1.3.2.4.22
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="1"/>
<
xs:maxLength value="20
"/>
Indicates that the minimum length is 1.
Indicates that the maximum length is 20.

4.5 II.GB-en-NHS.IdentifierType7

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

Attribute Cardinality Notes
root 0..0 This attribute is fixed to the OID: 2.16.840.1.113883.2.1.3.2.4.16.60
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:length value="8"/> Indicates that the length is 8.

5. String Types

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

 5.2 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 timestamp 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.