Data Types
Contents
3.2 CV.GB-en-NHS.CodedValueType1
3.3 CV.GB-en-NHS.CodedValueType2
3.4 CV.GB-en-NHS.CodedValueType9
3.5 CV.GB-en-NHS.CodedValueType8
4.1 II.GB-en-NHS.IdentifierType2
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
1. Schema
| Format | Document Title | Description |
|---|---|---|
| COSD XML DataTypes Version 3-0 | This schema file provides an implementation of the data types specified in this document. |
2. Address Types
2.1. AD.GB-en-NHS.AddressType1
| Attribute | Cardinality | Notes |
|---|---|---|
| postalCode | 1..1 | This attribute carries the postcode. |
| Attribute | Restriction | Notes | |
|---|---|---|---|
| postalCode | Parent | <xs:restriction base="postalCodeType"> | Indicates that this is a restriction of the postal code custom type. |
| Pattern | <xs:maxLength value="8"/> | Indicates that the pattern for postal code. | |
2.2. AD.GB-en-NHS.AddressType4
| Attribute | Cardinality | Notes |
|---|---|---|
| CHOICE OF: | ||
|
UnstructuredAddress/ streetAddressLine |
1..1 | This attribute carries an unstructured address. |
|
StructuredAddress/ streetAddressLine |
5..5 | This attribute carries a structured address. |
| Attribute | Restriction | Notes | |
|---|---|---|---|
|
UnstructuredAddress/ streetAddressLine |
Parent | <xs:restriction base="st"> | Indicates that this is a restriction of the string type. |
| Length | <xs:maxLength value="175"/> | Indicates that the maximum length of the streetAddressLine is 175 characters. | |
|
StructuredAddress/ streetAddressLine |
Parent | <xs:restriction base="st"> | Indicates that this is a restriction of the postal code custom type. |
| Length | <xs:maxLength value="35"/> | Indicates that this is a restriction of the string type. | |
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.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.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. |
|
3.4 CV.GB-en-NHS.CodedValueType9
This flavour supports the use of SNOMED content (of any version) and is implemented as follows:
| Attribute | Cardinality | Notes |
|---|---|---|
| code | 1..1 | This attribute holds the actual code. |
| codeSystem | 0..0 | |
| 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="18"/> |
Indicates that the maximum length is 18. | |
3.5 CV.GB-en-NHS.CodedValueType8
This flavour supports the use of the Ethnic Category Code:
| 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 minimum length is 1 and the maximum length is 2. | |
| Pattern |
<xs:pattern
value="99"/> <xs:pattern value="[ABCDEFGHJKLMNPRSZ]"/> <xs:pattern value="[ABCDEFGHJKLMNPRSZ]."/> |
Indicates the patterns to be applied. | |
4. Identifier Types
4.1 II.GB-en-NHS.IdentifierType2
This flavour supports the sending of DCE UUID.
| Attribute | Cardinality | Notes |
|---|---|---|
| root | 1..1 | This attribute holds a DCE UUID. |
| extension | 0..0 | |
| assigningAuthorityName | 0..0 | |
| displayable | 0..0 |
The following schema restrictions apply:
| Attribute | Restriction | Notes | |
|---|---|---|---|
| root | Parent | <xs:restriction base="st"> | Indicates that this is a restriction of the string data type. |
| Pattern | <xs:pattern value="[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}"> | Indicates that the allowable pattern. | |
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. | |

