CDS UNIQUE IDENTIFIER

CDS UNIQUE IDENTIFIER provides a unique identity for the life-time of an episode carried in a Commissioning Data Set message.

Format / Length

min an1 max an35

Description

CDS UNIQUE IDENTIFIER  is the same as attribute RECORD IDENTIFIER.

CDS UNIQUE IDENTIFIER  provides a unique identity for the life-time of an episode carried in a Commissioning Data Set message.

Note that the CDS UNIQUE IDENTIFIER must be constructed without the use of PATIENT Confidential Information. This includes PATIENT Identifiers such as NHS NUMBER or LOCAL PATIENT IDENTIFIER (EXTENDED), as well as any text which may identify the PATIENT DIAGNOSIS of the PATIENT or any PATIENT procedures being undertaken.

See the Commissioning Data Set Submission Protocol for detailed information.

Once assigned, a Commissioning Data Set record must retain its CDS UNIQUE IDENTIFIER otherwise duplicate Commissioning Data Set records may be generated and stored in the Secondary Uses Service database.

The CDS UNIQUE IDENTIFIER has three components. The recommended constructs are given below.

For All CDS Types EXCEPT the EAL CDS Types:

REF

UID

FORMAT

CODES / VALUES

COMMENT

1

NHS Organisation Code Type

 

an1

A = Pre 1996 ORGANISATION CODE B = Post 1996 NHS ORGANISATION CODE  / ORGANISATION IDENTIFIER

Mandatory For all CDS Types  

2

Provider Code

 

an5

The NHS ORGANISATION CODE  / ORGANISATION IDENTIFIER  of the Provider at the time of, or at the start of, the period covered by the activity reported by the CDS Message.

Mandatory for all CDS Types  

3a

Application Specific CDS Identity

 

an29

A code of up to 29 alpha-numeric characters generated by the Sender's application to uniquely identify the CDS within its CDS Type or family of CDS Types

Mandatory for all CDS Types Except for EAL CDS Types  

For EAL End Of Period (EOP) CDS Types only (CDS 6-2 only):

REF

UID

FORMAT

CODES / VALUES

COMMENT

1

NHS Organisation Code Type

 

an1

A = Pre 1996 ORGANISATION CODE B = Post 1996 NHS ORGANISATION CODE  / ORGANISATION IDENTIFIER

Mandatory For all CDS Types  

2

Provider Code

 

an5

The NHS ORGANISATION CODE  / ORGANISATION IDENTIFIER  of the Provider at the time of, or at the start of, the period covered by the activity reported by the CDS Message.

Mandatory for all CDS Types  

3b

Application Specific CDS Identity

 

an9

A code of up to 9 alpha-numeric characters generated by the Sender's application to uniquely identify the EAL End Of period census CDS Types with the same Admission List Entry. Additional data positions must be left blank.

Mandatory for all EAL EOP CDS Types

3c

Filler

 

an20

Additional data positions must be left blank.

 

For EAL Event During Period (EDP) CDS Types only (CDS 6-2 only):

REF

UID

FORMAT

CODES / VALUES

COMMENT

1

NHS Organisation Code Type

 

an1

A = Pre 1996 ORGANISATION CODE B = Post 1996 NHS ORGANISATION CODE  / ORGANISATION IDENTIFIER

Mandatory For all CDS Types

 

2

Provider Code

 

an5

The NHS ORGANISATION CODE  / ORGANISATION IDENTIFIER  of the Provider at the time of, or at the start of, the period covered by the activity reported by the CDS Message.

Mandatory for all CDS Types

 

3d

Application Specific CDS Identity

 

an9

A code of up to 5 alpha-numeric characters padded with 4 trailing spaces to 9 characters. Generated by the Sender's application to uniquely identify the EAL Event During Period Census CDS Types with the same Admission List Entry.

Mandatory for all EAL EDP CDS Types

 

3e

Filler

 

an3

A code of 3 alpha-numeric characters generated by the Sender's application to identify the event within the EAL Entry. Even if the events are of different types, they must have different identifiers.

Mandatory for all EAL EDP CDS Types

 

3f

Filler

 

an17

Additional data positions must be left blank.

 

Usage: CDS UNIQUE IDENTIFIER  is a mandatory data item when the Net Change Update Mechanism is used.  It is strongly advised that users of the Bulk Replacement Mechanism maintain a correctly generated CDS UNIQUE IDENTIFIER within the Commissioning Data Set data. This will establish a migration path towards the use of the Net Change Mechanism and will also then minimise the risk of creating duplicate Commissioning Data Set data in the Secondary Uses Service database.

  • Note that senders of Commissioning Data Set data remain directly responsible for the integrity of the CDS UNIQUE IDENTIFIER

  • It is a mandatory requirement for all submissions using the Net Change Update Mechanism that these two components are constructed correctly to ensure uniqueness of CDS UNIQUE IDENTIFIERS across the NHS. 

  • The structure of 3b and 3c allows the EAL End of Period Census and the EAL Event During Period Census for the same EAL Entry to be linked (CDS 6-2 only).

There are circumstances in patient care application systems where the control of the UID key integrity may be suspect. These issues include:

a) Episode deletion (not resulting in a Commissioning Data Set deletion of previously submitted data sent to the original Commissioner); b) Episode re-sequencing (not resulting in a corresponding Commissioning Data Set records being sent); c) Service agreement alterations not resulting in correct adjustments - Old Service Agreement deletion / New Service Agreement addition d) Re-admissions causing duplicate keys on the Secondary Uses Service database.

Each use of an NHS ORGANISATION CODE within a Commissioning Data Set message must be associated with the release version of the NHS Organisation Code scheme. At present this may be derived locally by NHS IT systems.

The following values have been informally used in many Commissioning Data Set implementations and are recommended to be used:

A or O *  

Signifying "OLD" (pre-April 1996) to denote an ORGANISATION CODE issued before, and in use up to the 1996 major re-issue

B or N *  

Signifying "NEW" (post-April 1996) to denote an ORGANISATION CODE  / ORGANISATION IDENTIFIER  issued from April 1996

* The values of A and B must be used in the formatting of the CDS UNIQUE IDENTIFIER.

Note: the Format/Length has been updated in Data Dictionary Change Notice 1808 "Correction of Format/Length Data Elements". The Data Set specifications that contain this item will be updated in the next version of the Information Standard where it is not already correct.

Also Known As

This data element is also known by these names:

Context Alias
Plural CDS UNIQUE IDENTIFIERS

Where Used

Type Link How used
Data Element CDS UNIQUE IDENTIFIER references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2 Type 005B - CDS Transaction Header Group - Bulk Update Protocol references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2 Type 005N - CDS Transaction Header Group - Net Change Protocol references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2 Type 060 - Elective Admission List - Event During Period (Add) CDS references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2 Type 070 - Elective Admission List - Event During Period (Remove) CDS references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2 Type 080 - Elective Admission List - Event During Period (Offer) CDS references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2 Type 090 - Elective Admission List - Event During Period (Available or Unavailable) CDS references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2 Type 100 - Elective Admission List - Event During Period (Old Service Agreement) CDS references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2 Type 110 - Elective Admission List - Event During Period (New Service Agreement) CDS references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2-3 Type 005B - CDS Transaction Header Group - Bulk Update Protocol references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-2-3 Type 005N - CDS Transaction Header Group - Net Change Protocol references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-3 Type 005B - CDS Transaction Header Group - Bulk Update Protocol references in description CDS UNIQUE IDENTIFIER
Data Set CDS V6-3 Type 005N - CDS Transaction Header Group - Net Change Protocol references in description CDS UNIQUE IDENTIFIER
Supporting Information Commissioning Data Set Business Rules references in description CDS UNIQUE IDENTIFIER
Supporting Information Commissioning Data Set Submission Protocol references in description CDS UNIQUE IDENTIFIER
XML Schema Constraint Commissioning Data Set Version 6-2 XML Schema Constraints references in description CDS UNIQUE IDENTIFIER
Data Set ECDS V4 Type 005B - CDS Transaction Header Group - Bulk Update Protocol references in description CDS UNIQUE IDENTIFIER
Data Set ECDS V4 Type 005N - CDS Transaction Header Group - Net Change Protocol references in description CDS UNIQUE IDENTIFIER
Data Element NON CDS UNIQUE IDENTIFIER references in description CDS UNIQUE IDENTIFIER
XML Schema Constraint PLICS Integrated Data Set Admitted Patient Care (Acute) Constraints references in description CDS UNIQUE IDENTIFIER
XML Schema Constraint PLICS Integrated Data Set Emergency Care (Acute) Constraints references in description CDS UNIQUE IDENTIFIER
XML Schema Constraint PLICS Integrated Data Set Out-patient Care (Acute) Constraints references in description CDS UNIQUE IDENTIFIER
Data Set Patient Level Contract Monitoring Data Set references in description CDS UNIQUE IDENTIFIER
Data Set Patient Level Information Costing System Integrated Data Set - Admitted Patient Care (Acute) references in description CDS UNIQUE IDENTIFIER
Data Set Patient Level Information Costing System Integrated Data Set - Emergency Care (Acute) references in description CDS UNIQUE IDENTIFIER
Data Set Patient Level Information Costing System Integrated Data Set - Out-Patient Care (Acute) references in description CDS UNIQUE IDENTIFIER