Health and Social Care Information Centre

NHS Data Model and Dictionary Service

Type:Patch
Reference:1541
Version No:1.0
Subject:Commissioning Data Set "XML Message" Update
Effective Date:Immediate
Reason for Change:Patch
Publication Date:5 October 2015

Background:

An internal review of NHS Data Model and Dictionary content relating to XML Schemas has identified differences in the terminology used.

This patch updates the affected content to use "Schema" rather than "Message"

To view a demonstration on "How to Read an NHS Data Model and Dictionary Change Request", visit the NHS Data Model and Dictionary help pages at: http://www.datadictionary.nhs.uk/Flash_Files/changerequest.htm.

Note: if the web page does not open, please copy the link and paste into the web browser.

Summary of changes:

Supporting Information
COMMISSIONING DATA SET DATA DUPLICATION   Changed Description
COMMISSIONING DATA SET NOTATION   Changed Description
COMMISSIONING DATA SET SUBMISSION PROTOCOL   Changed Description
COMMISSIONING DATA SET VERSION 6-2 TYPE LIST   Changed Description
COMMISSIONING DATA SET XML SCHEMA DESIGN renamed from COMMISSIONING DATA SET XML MESSAGE SCHEMA DESIGN   Changed Name, Description
COMMISSIONING DATA SET XML SCHEMA DOCUMENTATION renamed from COMMISSIONING DATA SET XML MESSAGE SCHEMA DOCUMENTATION   Changed Name, Description
COMMISSIONING DATA SET XML SCHEMA OVERVIEW renamed from COMMISSIONING DATA SET XML MESSAGE SCHEMA OVERVIEW   Changed Name, Description
COMMISSIONING DATA SET XML SCHEMA VERSION NUMBERING   Changed Description
 
Data Elements
CDS INTERCHANGE APPLICATION REFERENCE   Changed Description
CDS INTERCHANGE CONTROL REFERENCE   Changed Description
CDS INTERCHANGE DATE OF PREPARATION   Changed Description
CDS INTERCHANGE RECEIVER IDENTITY   Changed Description
CDS INTERCHANGE SENDER IDENTITY   Changed Description
CDS INTERCHANGE TEST INDICATOR   Changed Description
CDS INTERCHANGE TIME OF PREPARATION   Changed Description
CDS MESSAGE TYPE   Changed Description
CDS MESSAGE VERSION NUMBER   Changed Description
CDS RECORD IDENTIFIER   Changed Description
INVESTIGATION SCHEME IN USE   Changed Description
LOCATION CLASS   Changed Description
ORGANISATION CODE TYPE   Changed Description
PROCEDURE (OPCS)   Changed Description
PROCEDURE (READ)   Changed Description
SECONDARY DIAGNOSIS (ICD)   Changed Description
SECONDARY DIAGNOSIS (READ)   Changed Description
 
XML Schema Constraint
COMMISSIONING DATA SET VERSION 6-2 XML SCHEMA CONSTRAINTS   Changed Description
 

Date:5 October 2015
Sponsor:Richard Kavanagh, Head of Data Standards - Interoperability Specifications, Architecture, Standards and Innovation, Health and Social Care Information Centre

Note: New text is shown with a blue background. Deleted text is crossed out. Retired text is shown in grey. Within the Diagrams deleted classes and relationships are red, changed items are blue and new items are green.

Click here for a printer friendly view of this page.


COMMISSIONING DATA SET DATA DUPLICATION

Change to Supporting Information: Changed Description

It is acknowledged that the Secondary Uses Service processes can be directed to create duplicate Commissioning Data Set records and on occasion to wrongly delete records. This may occur if data senders do not correctly apply the rules associated with the Commissioning Data Set Submission Protocol such as the protocol dates and the sender and recipient codes applicable to interchanges.

It is not advisable to mix the use of Bulk and Net protocol for Commissioning Data Set submissions for the same sender organisation and site code as duplication or wrongful record deletion can occur.

Anticipating possible causes of duplication
Data senders can take steps to avoid Commissioning Data Set duplication in the Secondary Uses Service by anticipating situations which could result in changes to the data applied in the Commissioning Data Set Submission Protocols and by taking action to ensure that key data items that need to be retained consistently in the lifetime of the Commissioning Data Set record are not changed.

Data senders should note the following guidance on situations where extra vigilance is needed and action to ensure consistent and correct application of data elements used in net or bulk protocols:

Changes of address in patient demographic data
A change of POSTCODE following a change of PATIENT USUAL ADDRESS can change the CDS PRIME RECIPIENT IDENTITY in bulk update submissions.  Where possible, data senders should monitor changes to postcodes when preparing Commissioning Data Set data for submission in order to help prepare to minimise its impact on the integrity of the Commissioning Data Set data.

New Patient Care or other local systems used in Commissioning Data Set processing
When a new PATIENT care system or other system is implemented or used for preparing the Commissioning Data Set output data, it must be ensured that the Commissioning Data Set is generated to the appropriate specification required. The sender must ensure that any data events that may impact on key fields in the Commissioning Data Set are managed correctly.

For example, if the CDS SENDER IDENTITY is sourced from the new system it is important to check that its format will not be changed (eg from 5 to 3 characters, or inserting site codes in the 4th and 5th characters instead of zeros).

Sub-contracting
If a provider sub-contracts healthcare services and associated Commissioning Data Set submissions to a second provider, both parties need to actively engage in coordinating their arrangements for Commissioning Data Set submissions, ensuring that Commissioning Data Set Submission Protocol rules are applied appropriately to maintain the Commissioning Data Set data integrity in the Secondary Uses Service database.

New message translation supplierNew XML Schema translation supplier
If a provider changes bureau supplier arrangements for XML message translation, it is important that the new supplier is provided with the information required about the Commissioning Data Set Submission Protocols that has been used in previous Commissioning Data Set submissions in order to ensure that data integrity is maintained in the ongoing Commissioning Data Set messaging processes and in the Secondary Uses Service database.If a provider changes supplier arrangements for XML Schema translation, it is important that the new supplier is provided with the information required about the Commissioning Data Set Submission Protocols that have been used in previous Commissioning Data Set submissions in order to ensure that data integrity is maintained in the ongoing Commissioning Data Set XML Schema processes and in the Secondary Uses Service database.

top


COMMISSIONING DATA SET NOTATION

Change to Supporting Information: Changed Description

The Commissioning Data Set is the basic structure used for the submission of commissioning data to the Secondary Uses Service and is designed to be capable of individually conveying many different Commissioning Data Set structures, encompassing Accident and Emergency Attendances, Out-Patient Attendances, Admitted Patient Care and Elective Admission List.The Commissioning Data Set is the basic structure used for the submission of commissioning data to the Secondary Uses Service and is designed to be capable of individually conveying many different Commissioning Data Set structures, encompassing Accident and Emergency Attendances, Out-Patient Attendances, Admitted Patient Care and Elective Admission List.

Commissioning Data Set Messages have been defined in specific components known as a CDS Type.The Commissioning Data Sets have been defined in specific components known as a CDS Type.

Specific notation is used to indicate the requirements of the Commissioning Data Set XML Message Schema Design conditions for submission of data in the Commissioning Data Sets.Specific notation is used to indicate the requirements of the Commissioning Data Set XML Schema Design conditions for submission of data in the Commissioning Data Sets.

The structure of the Commissioning Data Set message is shown by the use of Data Groups and Sub Groups within those Data Groups.The structure of the Commissioning Data Set XML Schema is shown by the use of Data Groups and Sub Groups within those Data Groups.  For each Data Group, Sub Group and individual Data Element, the allowed cardinality at each level is also shown in the "Status" and "Repeats" columns.

The CDS Type specifications must therefore be read in this hierarchy, using the Status and Repeat conditions within the Data Groups and Sub Groups, to determine the requirements for the individual Data Elements.


Status Column Notation

The Notation used for the "STATUS" column is as follows:

STATUS MEANING DESCRIPTION 
M MANDATORY This signifies that the collection and submission of this Commissioning Data Set data is deemed MANDATORY and its presence is necessary for the CDS Type to be correctly validated and accepted for processing by the Secondary Uses Service.

If a data item is shown as MANDATORY, this should also be regarded as REQUIRED by the Department of Health.

In most instances, data marked as MANDATORY in a Sub Group will result in its parent Data Group also being marked as mandatory, but this is not always the case.

For instance, although the Consultant Episode - Clinical Diagnosis Group (ICD) is marked as R=REQUIRED (and therefore need not actually be populated), if it is used then both the DIAGNOSIS SCHEME IN USE and the PRIMARY DIAGNOSIS (ICD) are marked as M=MANDATORY and must both be present. 

R REQUIRED This signifies that the collection and submission of this Commissioning Data Set data is deemed REQUIRED by the Department of Health to comply with authorised NHS Standards, Policies and Directives. Therefore whenever a Commissioning Data Set is collected and subsequently submitted to the Secondary Uses Service, this data must be supported and populated into the relevant data sets if the data is available.

Note that "temporal" conditions may mean that there are instances where this directive cannot be fulfilled.

For instance in a CDS V6-2 Type 130 - Admitted Patient Care - Finished General Episode Commissioning Data Set, ICD and OPCS data elements are marked as "Required" indicating that this data should be included.  However, if at the time of submission to the Secondary Uses Service this data remains incomplete (perhaps awaiting coding in the ORGANISATION), the remaining data in the CDS record should still be submitted. Once the ORGANISATION has updated its systems with the data, the CDS Type relating to that ACTIVITY should then be resubmitted to the Secondary Uses Service

O OPTIONAL This signifies that the collection and submission of this Commissioning Data Set data is OPTIONAL. Its inclusion in the Commissioning Data Set is therefore determined by "local agreement" between the ORGANISATIONS exchanging the data.

Note that even if marked O=OPTIONAL, any data included in a Commissioning Data Set submission to the Secondary Uses Service must comply with its specification published in the NHS Data Model and Dictionary otherwise the data may be deemed invalid and rejected. 

X X This is used where the Data Element name has been included in the Commissioning Data Set design, usually for pilot use, but is not yet authorised for transmission by the wider NHS. The Data Element will be in italics and not linked to the Data Element where one exists.

Repeats Column Notation

The Notation used for the "REPEATS" column is as follows:

REPEATS DESCRIPTION 
0..1 This signifies that the permitted occurrences of the Data Group, Sub Group or individual Data Element are from a minimum of 0 to a maximum of 1.
0..9 This signifies that the permitted occurrences of the Data Group, Sub Group or individual Data Element are from a minimum of 0 to a maximum of 9.
0..* This signifies that the permitted occurrences of the Data Group, Sub Group or individual Data Element are from a minimum of 0 to an unlimited maximum.
1..1 This signifies that the permitted occurrences of the Data Group, Sub Group or individual Data Element are from a minimum of 1 to a maximum of 1.
1..97 This signifies that the permitted occurrences of the Data Group, Sub Group or individual Data Element are from a minimum of 1 to a maximum of 97.
1..* This signifies that the permitted occurrences of the Data Group, Sub Group or individual Data Element are from a minimum of 1 to an unlimited maximum.

Rules Column Notation

An entry in the "Rules" column shows that a specific Rule applies to submission of an individual Data Element.

The meaning of these Rules can be found in Commissioning Data Set Business Rules.


Notation Examples

The following are examples of some common scenarios.

EXAMPLE 1:
A MANDATORY Data Group with differing Sub-Groups and component data status conditions.
 

The following example shows a MANDATORY Data Group - therefore the Data Group must be present for the CDS Type to be validated and accepted for processing by the Secondary Uses Service.

When a Data Group is used:

  1. All MANDATORY Sub Groups and/or Data Elements must be present
  2. Any REQUIRED Sub Groups and/or Data Elements must be present if the data is available
  3. Any OPTIONAL Sub Groups and/or Data Elements may be omitted

The following data structure is one of three options when completing the Patient Identity Data Group:

1..1DATA GROUP: VERIFIED IDENTITY STRUCTURE
Must be used where the
NHS NUMBER STATUS INDICATOR CODE National Code Value = 01 = Verified 
Rules 
R0..1DATA GROUP: LOCAL IDENTIFIER STRUCTURE  
M 1..1 LOCAL PATIENT IDENTIFIER F
M 1..1 ORGANISATION CODE (LOCAL PATIENT IDENTIFIER) F
M 1..1 Data Element Components Rules 
M 1..1 NHS NUMBER F
M 1..1 NHS NUMBER STATUS INDICATOR CODE V
M 1..1 POSTCODE OF USUAL ADDRESS S3
R0..1ORGANISATION CODE (RESIDENCE RESPONSIBILITY) F
R0..1PERSON BIRTH DATE F
S3
S12

EXPLANATION:

The parent Data Group has a "Status" of M=MANDATORY which indicates that this Data Group must be present in the Commissioning Data Set to ensure correct validation and acceptance when submitted to the Secondary Uses Service.  The parent Data Group "Repeats" = 1..1 indicates that only one occurrence of this Data Group must flow in this particular Commissioning Data Set record.

The Sub Group of "Local Identifier Structure" is marked as R=REQUIRED and therefore must be populated if the data is available. The "Repeats" notation of 0..1 indicates that population of this Sub Group is not necessary to enable the Commissioning Data Set record to be sent to the Secondary Uses Service. If it is sent, then only one occurrence of this Sub Group may flow in this particular Commissioning Data Set record.
Both Data Elements in the Sub Group are marked M=MANDATORY and must both be correctly populated.

The Sub Group of "Data Element Components" is a "generic" structure and is marked as M=MANDATORY and therefore must be populated. The "Repeats" notation of 1..1 indicates that only one occurrence of this Data Group may flow in this particular Commissioning Data Set record.  All the Data Elements marked with M=MANDATORY must be populated.  PERSON BIRTH DATE however is marked with R=REQUIRED, so must also be completed if the data is available. 


EXAMPLE 2:
A REQUIRED Data Group with differing component data status conditions.
 

The following example shows a REQUIRED Data Group. This data must be present in the relevant Commissioning Data Set if available.  However, if submitted to the Secondary Uses Service, omission of this REQUIRED Data Group will not cause rejection.

When the Data Group is used:

  1. All MANDATORY Sub Groups and/or Data Elements must be utilised
  2. Any REQUIRED Sub Groups and/or Data Elements must be present if the data is available
  3. Any OPTIONAL Sub Groups and/or Data Elements may be omitted
Notation DATA GROUP: CONSULTANT EPISODE - CLINICAL DIAGNOSIS GROUP (ICD) 
Group
Status
R
 
Group
Repeats
0..1
 
FUNCTION:
To carry the details of the ICD coded Clinical Diagnoses.
 
M 1..1 Data Element Components Rules 
M 1..1 PROCEDURE SCHEME IN USE V
M 1..1 DATA GROUP: PRIMARY DIAGNOSIS Rules 
M 1..1 PRIMARY DIAGNOSIS (ICD) F
H4
O0..1PRESENT ON ADMISSION INDICATOR F
O0..*DATA GROUP: SECONDARY DIAGNOSIS Rules 
M 1..1 SECONDARY DIAGNOSIS (ICD) F
H4
O0..1PRESENT ON ADMISSION INDICATOR F

EXPLANATION:

The Data Group "Status" = R = Required indicates that this Data Group must be populated in the relevant Commissioning Data Set if the data is available.  The Data Group "Repeats" = 0..1 indicates that population of this Data Group is not necessary to enable the Commissioning Data Set to be sent to the Secondary Uses Service. If it is sent, then only one occurrence of this Data Group may flow in this particular Commissioning Data Set record.

If the Data Group is completed then the Data Element PROCEDURE SCHEME IN USE, marked as M=MANDATORY, must be populated. The "Repeats" notation of 1..1 indicates that only one occurrence of this Data Element is valid.

If the Data Group is completed then the Data Element PRIMARY DIAGNOSIS (ICD), marked as M=MANDATORY, must be populated. The "Repeats" notation of 1..1 indicates that only one occurrence of this Data Element is valid.

If the Data Group is completed then the Sub Group "Secondary Diagnoses", marked as O=OPTIONAL, may be omitted, but if populated it must be in the correct format. The "Repeats" notation of 0..* indicates that unlimited occurrences of this Data Element are valid. Each occurrence must contain a valid SECONDARY DIAGNOSIS (ICD). 

top


COMMISSIONING DATA SET SUBMISSION PROTOCOL

Change to Supporting Information: Changed Description

The Commissioning Data Sets submitted by providers carry information to determine the update method to be used by the Secondary Uses Service in order to update the national database.

These update rules are known as the Commissioning Data Set Submission Protocol and the set of data controls used to indicate this are carried in the Commissioning Data Set Transaction Header Group which must be present and correct in every CDS Type submitted to the Secondary Uses Service.

Two Update Mechanisms are available:

  • Net Change - to support the management of an individual CDS Type in the Secondary Uses Service database and enables Commissioning data to be inserted/ updated or deleted.
    CDS Senders are expected to use the Net Change Update Mechanism wherever possible.

  • Bulk Replacement - to support the management of bulk commissioning data for an identified CDS BULK REPLACEMENT GROUP CODE of data for a specified time period and for a specified CDS PRIME RECIPIENT IDENTITY.
    CDS Senders should only use the Bulk Replacement Update Mechanism in exceptional circumstances.

It is strongly advised that all ORGANISATIONS should, as a minimum process, commence migration to use the CDS-XML Version 6 Message for weekly Net Change submissions by March 2009.

Net Change:
Net Change processes are managed by specific data settings as defined in the CDS V6-2 Type 005N - Commissioning Data Set Transaction Header Group - Net Change Protocol option of the CDS Transaction Header Group. The Secondary Uses Service uses the following data to manage the database:

Each CDS Type must have a CDS UNIQUE IDENTIFIER which must be uniquely maintained for the life of that Commissioning Data Set record. This is a particular consideration where mergers and/or healthcare systems are changed or upgraded, see Commissioning Data Set Submission and Organisation Mergers. Any change to the CDS UNIQUE IDENTIFIER during the "lifetime" of a Commissioning Data Set record will almost certainly result in a duplicate record being lodged in the Secondary Uses Service database.

A Commissioning Data Set record delete transaction must be sent to the Secondary Uses Service database when any previously sent Commissioning Data Set record requires deletion/removal, for example to reflect Commissioner changes etc. 

Where CDS UPDATE TYPE 1 is required (delete/cancellation), an empty XML element called 'Delete Transaction' can be used instead of submitting he original CDS Type record, after the CDS V6-2 Type 005N - CDS Transaction Header Group - Net Change Protocol. See the CDS V6-2- XML Schema Release Notes which can be downloaded via the XML Schema TRUD Download page.

The CDS APPLICABLE DATE and CDS APPLICABLE TIME must be used to ensure that all Commissioning data is updated in the Secondary Uses Service database in the correct chronological order.

The CDS SENDER IDENTITY must not change during the lifetime of the CDS data.
This is particularly significant for multiple and/or merged organisations, and for those services who submit data on behalf of another NHS TrustNHS Foundation Trust or Independent Sector Healthcare Provider.

Bulk Replacement
Bulk Replacement processes are managed by specific data settings as defined in the CDS V6-2 Type 005B - Commissioning Data Set Transaction Header Group - Bulk Update Protocol option of the CDS Transaction Header Group. The Secondary Uses Service uses the following data to manage the database:


Every CDS Type must be submitted using the correct CDS BULK REPLACEMENT GROUP CODE.

The CDS REPORT PERIOD START DATE and the CDS REPORT PERIOD END DATE, (i.e. the effective date period), must be valid and consistent, and reflect the dates relevant to the Commissioning data contained in the interchange.

The CDS SENDER IDENTITY must not change during the lifetime of the Commissioning Data Set record. This is particularly significant for multiple and/or merged organisations, and for those services who submit data on behalf of another ORGANISATION.

The CDS PRIME RECIPIENT IDENTITY must be identified in each Commissioning Data Set and must not be changed during the lifetime of the Commissioning Data Set record otherwise the data stored in the Secondary Uses Service database may lose its integrity (e.g. duplicate Commissioning data may be stored).

For this reason it is advised that the ORGANISATION CODE (RESIDENCE RESPONSIBILITY) should always be used to determine the CDS PRIME RECIPIENT IDENTITY as detailed in the Commissioning Data Set Addressing Grid. Senders must also be aware that if the ORGANISATION CODE (RESIDENCE RESPONSIBILITY) is itself derived from the PATIENT's POSTCODE OF USUAL ADDRESS then great care must be taken to manage all elements of this relationship.For this reason it is advised that the ORGANISATION CODE (RESIDENCE RESPONSIBILITY) should always be used to determine the CDS PRIME RECIPIENT IDENTITY as detailed in the Commissioning Data Set Addressing Grid. Senders must also be aware that if the ORGANISATION CODE (RESIDENCE RESPONSIBILITY) is itself derived from the PATIENT's POSTCODE OF USUAL ADDRESS then great care must be taken to manage all elements of this relationship.

If it is necessary to change any of this data during the lifetime of a Commissioning Data Set record, then the Secondary Uses Service help desk should be contacted for advice.If it is necessary to change any of this data during the lifetime of a Commissioning Data Set record, then the Secondary Uses Service (SUS) Service Desk should be contacted for advice. See SUS Guidance for contact details. 

It is strongly advised that users of the Bulk Replacement Mechanism maintain a correctly generated CDS UNIQUE IDENTIFIER within the Commissioning 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.

Sub contracting
If a Health Care Provider sub-contracts healthcare provision and its associated Commissioning Data Set submission to a second ORGANISATION (eg a different Health Care Provider or a Shared Services Organisation), arrangements to submit the Commissioning Data Set data must be made locally to ensure that only one ORGANISATION sends the Commissioning Data Set data to the Secondary Uses Service.

If the second ORGANISATION wishes to add other Commissioning data to the Secondary Uses Service database to that already submitted by the first ORGANISATION, both parties need to ensure that a different CDS SENDER IDENTITY is used. Often this is done by changing the last 2 digits of the 5 digit code (the Site element of the ORGANISATION CODE).

Note: Data sent using the same CDS SENDER IDENTITY by two different parties will most likely overwrite each other's data in the Secondary Uses Service database. Further advice can be obtained from the Secondary Uses Service helpdesk.

Further advice can be obtained from the Secondary Uses Service (SUS) Service Desk, see SUS Guidance for contact details.

Users should be aware of how the 15 character code of their CDS INTERCHANGE SENDER IDENTITY (also known as the EDI Address) is created. This may depend on how their XML interface solution has been set up. It may not be possible to rely on a change to the ORGANISATION CODE (CODE OF PROVIDER) in order to change the CDS INTERCHANGE SENDER IDENTITY should this become necessary.

top


COMMISSIONING DATA SET VERSION 6-2 TYPE LIST

Change to Supporting Information: Changed Description

For guidance on the Commissioning Data Set Layout, see the Commissioning Data Set Redesign Guidance Notes on the NHS Data Model and Dictionary website.

CDS Layout with
CDS-XML Schema Rules
Overview
CDS Layout with
CDS XML Schema Rules
Overview
Accident and Emergency Commissioning Data Set Type:
CDS V6-2 Type 010 - Accident and Emergency CDSCDS V6-2 Type 010 - Accident and Emergency CDS Overview
Out Patient Commissioning Data Set Types:
CDS V6-2 Type 020 - Outpatient CDSCDS V6-2 Type 020 - Outpatient CDS Overview
CDS V6-2 Type 021 - Future Outpatient CDSCDS V6-2 Type 021 - Future Outpatient CDS Overview
Admitted Patient Care Commissioning Data Set Types:
CDS V6-2 Type 120 - Admitted Patient Care - Finished Birth Episode CDSCDS V6-2 Type 120 - Admitted Patient Care - Finished Birth Episode CDS Overview
CDS V6-2 Type 130 - Admitted Patient Care - Finished General Episode CDSCDS V6-2 Type 130 - Admitted Patient Care - Finished General Episode CDS Overview
CDS V6-2 Type 140 - Admitted Patient Care - Finished Delivery Episode CDSCDS V6-2 Type 140 - Admitted Patient Care - Finished Delivery Episode CDS Overview
 
CDS V6-2 Type 150 - Admitted Patient Care - Other Birth Event CDSCDS V6-2 Type 150 - Admitted Patient Care - Other Birth Event CDS Overview
CDS V6-2 Type 160 - Admitted Patient Care - Other Delivery Event CDSCDS V6-2 Type 160 - Admitted Patient Care - Other Delivery Event CDS Overview
 
CDS V6-2 Type 170 - Admitted Patient Care - Detained and/or Long Term Psychiatric Census CDSCDS V6-2 Type 170 - Admitted Patient Care - Detained and/or Long Term Psychiatric Census CDS Overview 
 
CDS V6-2 Type 180 - Admitted Patient Care - Unfinished Birth Episode CDSCDS V6-2 Type 180 - Admitted Patient Care - Unfinished Birth Episode CDS Overview
CDS V6-2 Type 190 - Admitted Patient Care - Unfinished General Episode CDSCDS V6-2 Type 190 - Admitted Patient Care - Unfinished General Episode CDS Overview
CDS V6-2 Type 200 - Admitted Patient Care - Unfinished Delivery Episode CDSCDS V6-2 Type 200 - Admitted Patient Care - Unfinished Delivery Episode CDS Overview
Elective Admission List Commissioning Data Set Types - End Of Period Census Types:
CDS V6-2 Type 030 - Elective Admission List - End of Period Census (Standard) CDSCDS V6-2 Type 030 - Elective Admission List - End of Period Census (Standard) CDS Overview
CDS V6-2 Type 040 - Elective Admission List - End Of Period Census (Old) CDSCDS V6-2 Type 040 - Elective Admission List - End Of Period Census (Old) CDS Overview
CDS V6-2 Type 050 - Elective Admission List - End Of Period Census (New) CDSCDS V6-2 Type 050 - Elective Admission List - End Of Period Census (New) CDS Overview
Elective Admission List Commissioning Data Set Types - Event During Period Types:
CDS V6-2 Type 060 - Elective Admission List - Event During Period (Add) CDSCDS V6-2 Type 060 - Elective Admission List - Event During Period (Add) CDS Overview
CDS V6-2 Type 070 - Elective Admission List - Event During Period (Remove) CDSCDS V6-2 Type 070 - Elective Admission List - Event During Period (Remove) CDS Overview
CDS V6-2 Type 080 - Elective Admission List - Event During Period (Offer) CDSCDS V6-2 Type 080 - Elective Admission List - Event During Period (Offer) CDS Overview
CDS V6-2 Type 090 - Elective Admission List - Event During Period (Available or Unavailable) CDSCDS V6-2 Type 090 - Elective Admission List - Event During Period (Available or Unavailable) CDS Overview
CDS V6-2 Type 100 - Elective Admission List - Event During Period (Old Service Agreement) CDSCDS V6-2 Type 100 - Elective Admission List - Event During Period (Old Service Agreement) CDS Overview
CDS V6-2 Type 110 - Elective Admission List - Event During Period (New Service Agreement) CDSCDS V6-2 Type 110 - Elective Admission List - Event During Period (New Service Agreement) CDS Overview
Commissioning Data Set Interchange and Message Controls - Mandatory for every Interchange:
CDS V6-2 Type 001 - CDS Interchange HeaderCDS V6-2 Type 001 - CDS Interchange Header Overview
CDS V6-2 Type 002 - CDS Interchange TrailerCDS V6-2 Type 002 - CDS Interchange Trailer Overview
CDS V6-2 Type 003 - CDS Message HeaderCDS V6-2 Type 003 - CDS Message Header Overview
CDS V6-2 Type 004 - CDS Message TrailerCDS V6-2 Type 004 - CDS Message Trailer Overview
Commissioning Data Set Transaction Header Group - Mandatory for every Commissioning Data Set:
CDS V6-2 Type 005B - CDS Transaction Header Group - Bulk Update ProtocolCDS V6-2 Type 005B - CDS Transaction Header Group - Bulk Update Protocol Overview
or
CDS V6-2 Type 005N - CDS Transaction Header Group - Net Change ProtocolCDS V6-2 Type 005N - CDS Transaction Header Group - Net Change Protocol Overview

top


COMMISSIONING DATA SET VERSION 6-2 TYPE LIST

Change to Supporting Information: Changed Description

top


COMMISSIONING DATA SET XML SCHEMA DESIGN  renamed from COMMISSIONING DATA SET XML MESSAGE SCHEMA DESIGN

Change to Supporting Information: Changed Name, Description

The use of XML was mandated by the e-Government Interoperability Framework (e-GIF) programme as the standard to be used for messaging by government organisations and has accordingly been adopted by the NHS.

For the submission of Commissioning Data Set data to the Secondary Uses Service, XML based messaging has been developed to be fully adopted by the end of 2007, replacing all previously published Commissioning Data Set Message formats.

Schema StandardsXML Schema Standards
The overall standards applied and supported by the schema are:

Note:
e-GIF and the Government Data Standards Catalogue have been archived and are available for reference only.

Schema Naming ConventionsXML Schema Naming Conventions
These are in CamelCase reflecting recommended e-GOV guidelines for best practice. Wherever possible, schema data item names are compliant (or intuitively identifiable) with the NHS Data Model and Dictionary data naming conventions.

Schema ComponentsXML Schema Components
The schema consists of the following components:

  • The CDS-XML Message Root
  • The CDS-XML Standard Data Structures
  • The CDS-XML Standard Data Elements
  • The CDS XML Message Root
  • The CDS XML Standard Data Structures
  • The CDS XML Standard Data Elements
  • CDS Type Sub-Schemas
These are described below.

The Schema RootThe XML Schema Root
The schema root is the control section of the schema and uses the "XML Include" technique to call schema sub-components:

  • The Standard Data Structures
  • The Standard Data Elements
  • All CDS Type sub-component schemas, including the Commissioning Data Set Headers and Trailers
In addition, the schema root is the only schema entry point and on entry the schema validates the XML Attributes for:
  • SchemaVersion
  • SchemaDate
Schema Component: Standard Data StructuresXML Schema Component: Standard Data Structures
Schema Version 6-0 introduced standard data structures which are invoked from the CDS Type sub-component schemas.XML Schema Version 6-0 introduced standard data structures which are invoked from the CDS Type sub-component schemas. This simplifies the management and definition of data structures and eliminates (as far as is possible) the multiple definitions of the many common structures used across the CDS Type components. It also helps to eliminate naming and spelling inconsistencies.

This implementation of the schema does not enforce the sequence of data elements within its data structures (nor its data structures within the schema), nor is it foreseen that this will be enforced in future. For ease of understanding, users are advised to implement the structure sequences as published.

In general, the restraints on the permitted occurrences of data groups have been removed and in most cases, unbounded occurrences of iterating data structures are supported. The NHS Data Model and Dictionary defines the actual requirements for the use of NHS data.

Schema Component: Standard Data ElementsXML Schema Component: Standard Data Elements
Schema data items are defined with _Type suffixes and usually refer to a standard list of XML data types which are usually qualified with an enumeration list to reflect the NHS Data Standards as published in the NHS Data Model and Dictionary.XML Schema data items are defined with _Type suffixes and usually refer to a standard list of XML data types which are usually qualified with an enumeration list to reflect the NHS Data Standards as published in the NHS Data Model and Dictionary.

Schema Component: XML Attributes
XML Attributes are used (sparingly) to enforce certain logical data and structure relationships, an example being to determine the type of Critical Care Period data being carried.

top


COMMISSIONING DATA SET XML SCHEMA DOCUMENTATION  renamed from COMMISSIONING DATA SET XML MESSAGE SCHEMA DOCUMENTATION

Change to Supporting Information: Changed Name, Description

The use of XML was mandated by the e-Government Interoperability Framework (e-GIF) programme as the standard to be used for messaging by government organisations and accordingly this has been adopted by the NHS.

Note:
e-GIF and the Government Data Standards Catalogue have been archived and are available for reference only.

For the most part, the schema applies the data specifications as authorised by the NHS and documented in the NHS Data Model and Dictionary.For the most part, the XML Schema applies the data specifications as authorised by the NHS and documented in the NHS Data Model and Dictionary.

The Issued Documentation
NHS Data Standards maintain and issue the following schema documentation:The Data Dictionary and Messaging Team maintain and issue the following XML Schema documentation:

  • The Schema Files (generated using ALTOVA XMLSPY ©)
    The Schema files consist of a series of interpretable XML/HTML statements which define the data structures and content rules for the use of the message. User systems use the schema to either populate or interpret a 'schema instance' that is the resultant XML formatted message file which carries the data.
  • The XML Schema Files (generated using ALTOVA XMLSPY ©)
    The XML Schema files consist of a series of interpretable XML/HTML statements which define the data structures and content rules for the use of the message. User systems use the XML Schema to either populate or interpret a 'XML Schema instance' that is the resultant XML formatted message file which carries the data.

The schema therefore represents the 'design' of the message and it may be necessary therefore to interpret and understand the information inherent in the schema file code.The XML Schema therefore represents the 'design' of the message and it may be necessary therefore to interpret and understand the information inherent in the XML Schema file code.

  • The Schema Documentation (generated using ALTOVA XMLSPY ©)
    These files are generated using XMLSPY software and may be read in any browser, e.g. MS Explorer©. The files consist of a 'root' entry HTML formatted file and a (usually) large number of supporting .png graphic files used by the root HTML.
  • The XML Schema Documentation (generated using ALTOVA XMLSPY ©)
    These files are generated using XMLSPY software and may be read in any browser, e.g. MS Explorer©. The files consist of a 'root' entry HTML formatted file and a (usually) large number of supporting .png graphic files used by the root HTML.

This documentation enables useful "drill down" functions for investigating structures and data items, but these features are not as powerful as when using a full schema editor (see below).This documentation enables useful "drill down" functions for investigating structures and data items, but these features are not as powerful as when using a full XML Schema editor (see below).

Most browsers will support printing and thus the schema details can be printed as required but users are warned that browser based prints often generate a large number of pages.Most browsers will support printing and thus the XML Schema details can be printed as required but users are warned that browser based prints often generate a large number of pages.

The CDS-XML schema generates approximately 450+ pages of details, printing is therefore not advised.The CDS XML Schema generates approximately 450+ pages of details, printing is therefore not advised.

Reading SchemaReading XML Schema
Whilst schema can be read as HTML in most browsers, it may be difficult to fully interpret the schema unless the reader has a detailed understanding of HTML.Whilst XML Schemas can be read as HTML in most browsers, it may be difficult to fully interpret the XML Schema unless the reader has a detailed understanding of HTML.

It is recommended that schema are read using an XML interpreter (such as ALTOVA XMLSPY ©), many of these are freely available on the internet.It is recommended that XML Schemas are read using an XML interpreter (such as ALTOVA XMLSPY ©), many of these are freely available on the internet.

Schema technicians may prefer to use such software to examine schema more deeply as the interactive facilities provided are generally more powerful than browsing the XML/HTML supplied schema code.XML Schema technicians may prefer to use such software to examine XML Schemas more deeply as the interactive facilities provided are generally more powerful than browsing the XML/HTML supplied Schema code.

top


COMMISSIONING DATA SET XML SCHEMA OVERVIEW  renamed from COMMISSIONING DATA SET XML MESSAGE SCHEMA OVERVIEW

Change to Supporting Information: Changed Name, Description

The use of XML was mandated by the e-Government Interoperability Framework (e-GIF) programme as the standard to be used for messaging by government organisations and has accordingly been adopted by the NHS.

For the submission of Commissioning Data Set data to the Secondary Uses Service, XML based messaging has been developed replacing all previously published Commissioning Data Set Message formats.

The CDS-XML Message Schema is supported and applied in the Secondary Uses Service front-end software service (the XML Transfer Service - XTS) to enforce a nationally agreed data specification and thus help protect the data quality and integrity of the data submitted to and stored within the Secondary Uses Service.The CDS XML Schema is supported and applied in the Secondary Uses Service front-end software service (the XML Transfer Service - XTS) to enforce a nationally agreed data specification and thus help protect the data quality and integrity of the data submitted to and stored within the Secondary Uses Service.

It should be noted that after accepting the schema instance data, the Secondary Uses Service then applies further logical data validations and may identify and report further data conditions.It should be noted that after accepting the XML Schema instance data, the Secondary Uses Service then applies further logical data validations and may identify and report further data conditions.

For the most part, the schema applies the data specifications as authorised by the NHS and documented in the NHS Data Model and Dictionary. However, as the NHS Data Model and Dictionary is updated on a continuous time basis and schemas may be less dynamic and updated on a longer time cycle, there may be subtle differences in the data specifications applied in the schema. For example, additional National Codes may be supported in one version of the Commissioning Data Set XML schema but not in earlier versions. Where this is the case, information relating to the supported National Codes can be found on the CDS Version 6-2 XML Schema Constraints page and associated Attribute and Data Elements.For the most part, the XML Schema applies the data specifications as authorised by the NHS and documented in the NHS Data Model and Dictionary. However, as the NHS Data Model and Dictionary is updated on a continuous time basis and XML Schemas may be less dynamic and updated on a longer time cycle, there may be subtle differences in the data specifications applied in the XML Schema. For example, additional National Codes may be supported in one version of the Commissioning Data Set XML Schema but not in earlier versions. Where this is the case, information relating to the supported National Codes can be found on the CDS Version 6-2 XML Schema Constraints page and associated Attributes and/or Data Elements.

Additionally a schema may deliberately retain historic National Codes as well as supporting the new National Codes in order to enable NHS users to be able to process historic data.Additionally an XML Schema may deliberately retain historic National Codes as well as supporting the new National Codes in order to enable NHS users to be able to process historic data.

Schema StandardsXML Schema Standards
The overall standards applied and supported by the schema are:The overall standards applied and supported by the XML Schema are:

Note:
e-GIF and the Government Data Standards Catalogue have been archived and are available for reference only.

Schema Naming ConventionsXML Schema Naming Conventions
These are in CamelCase as accepted best practice. Wherever possible, schema data item names are compliant (or intuitively identifiable) with the NHS Data Model and Dictionary naming conventions. Wherever possible, XML Schema data item names are compliant (or intuitively identifiable) with the NHS Data Model and Dictionary naming conventions.

Schema DocumentationXML Schema Documentation
Schema documentation usually consists of several related publications:XML Schema documentation usually consists of several related publications:

Schema Components: Schema RootXML Schema Components: Schema Root
The schema root is the control section of the schema and is the only entry point and uses the "XML Include" technique to call all schema sub components:The XML Schema root is the control section of the XML Schema and is the only entry point and uses the "XML Include" technique to call all XML Schema sub components:
  • The Standard Data Elements
  • The Standard Data Structures
  • All sub-component schemas for CDS Types including the Commissioning Data Set Headers and Trailers
  • All sub-component XML Schemas for CDS Types including the Commissioning Data Set Headers and Trailers

top


COMMISSIONING DATA SET XML SCHEMA VERSION NUMBERING

Change to Supporting Information: Changed Description

The CDS-XML Schema Version Number FormatThe CDS XML Schema Version Number Format
The use of XML was mandated by the e-Government Interoperability Framework (e-GIF) programme as the standard to be used for messaging by government organisations and has accordingly been adopted by the NHS.

Note:
e-GIF and the Government Data Standards Catalogue have been archived and are available for reference only.

The CDS-XML Schema adopts version numbering techniques in line with published e-GOV best practice guidelines.The CDS XML Schema adopts version numbering techniques in line with published e-GOV best practice guidelines. All schema components are version numbered and date qualified; the following is an example of the adopted format:

CDS-XML_Message_RootCDS XML Message Root
Example: V6-0-2007-03-01 (Note that dash separators are used).
[Schema Filename] + [Major Version Number] + [Minor Version Number] + [Version Date]

VERSION NUMBER ELEMENT 

FORMAT 

EXAMPLE AND NOTES 

Schema File NameAs allocated by Information Standards Delivery,
Health and Social Care Information Centre
CDS-XML_Message_Root-
XML Schema File NameAs allocated by Information Standards Delivery,
Health and Social Care Information Centre
CDS-XML_Message_Root-
Major Version Number
 
A maximum of 3 characters
incremented numerically
without leading zeros
V6-
Minor Version Number
 
A maximum of 3 characters
incremented numerically
without leading zeros
0-
Version Dateccyy-mm-dd2007-03-01

The Major Version Number:
This is incremented when fundamental change has taken place such as:

  • Major addition / deletion / change of schema business functionality
  • Major addition / deletion / change of XML Schema business functionality
  • Major change to the technical design of the schema
  • Re-alignment of the Schema Version Number after cumulative changes
  • Re-alignment of the XML Schema Version Number after cumulative changes
The Minor Version Number:
This is incremented for all schema changes not warranting a Major Version Number increment (as above).This is incremented for all XML Schema changes not warranting a Major Version Number increment (as above).
Examples are:
  • Minor changes to schema business functionality
  • Minor changes to the schema data structures that are not upwardly compatible*
  • Minor changes to XML Schema business functionality
  • Minor changes to the XML Schema data structures that are not upwardly compatible*
  • Addition and/or deletion of data items that are not upwardly compatible*
  • Changes to data item facet definitions that are not upwardly compatible*
The Version Date:
This may be adjusted as a defined reference point for a no risk schema release to reflect minor changes and corrective releases.This may be adjusted as a defined reference point for a no risk XML Schema release to reflect minor changes and corrective releases.
Examples are:
  • Minor changes to the schema data structures that are upwardly compatible* for instance the addition of an optional data item.
  • Minor changes to the XML Schema data structures that are upwardly compatible* for instance the addition of an optional data item.
  • Changes to data item facet definitions that are upwardly compatible* for instance the addition (but not the deletion) of code values to a data item enumeration list.
  • Interim development versions, released for information only

* Upwardly Compatible:
Minor changes and adjustments to the schema which introduce little or no risk of increased data rejection are deemed upwardly compatible.Minor changes and adjustments to the XML Schema which introduce little or no risk of increased data rejection are deemed upwardly compatible.

For example, corrective adjustments, which align the schema to the authorised NHS Data Standards as published in the NHS Data Model and Dictionary often fall within this category.For example, corrective adjustments, which align the XML Schema to the authorised NHS Data Standards as published in the NHS Data Model and Dictionary often fall within this category.

The Schema Date:The XML Schema Date:
All schema releases have a designated SchemaDate XML Attribute.All XML Schema releases have a designated SchemaDate XML Attribute.

Schema Version Control - The Schema Root:XML Schema Version Control - The Schema Root:
The schema root is the single entry point to the schema and XML Attributes for the following are validated:The schema root is the single entry point to the XML Schema and XML Attributes for the following are validated:

  • SchemaVersion
  • SchemaDate

top


CDS INTERCHANGE APPLICATION REFERENCE

Change to Data Element: Changed Description

Format/Length:an14
National Codes: 
Default Codes: 

Notes:
CDS INTERCHANGE APPLICATION REFERENCE identifies the application content of the Interchange where the Interchange contains only one type of Message.

Usage: 
This facility enables submitted interchanges to be marked to enable interchange content to be identified and recorded.
All CDS Interchanges must contain this data element.

CODE CLASSIFICATION 
NHSCDSCDS Interchange

CDS-XML Interchanges:CDS XML Schema Interchanges:
CDS-XML interchanges submitted may contain the optional CDS INTERCHANGE APPLICATION REFERENCE.CDS XML Schema interchanges submitted may contain the optional CDS INTERCHANGE APPLICATION REFERENCE. 

top


CDS INTERCHANGE CONTROL REFERENCE

Change to Data Element: Changed Description

Format/Length:an14
National Codes: 
Default Codes: 

Notes:
CDS INTERCHANGE CONTROL REFERENCE provides a unique number (per sender identity) to identify every Commissioning Data Set Interchange submission.

For each Interchange submitted, the CDS INTERCHANGE CONTROL REFERENCE must be incremented by 1. The maximum value supported is n7 and wrap around from 9999999 to 1 must be supported.

Usage: 
This is a mandatory data element when submitting Commissioning Data Set Interchanges and is used to uniquely identify and if required, to sequence check Commissioning Data Set submissions.CDS INTERCHANGE CONTROL REFERENCE is a mandatory data element when submitting Commissioning Data Set Interchanges and is used to uniquely identify and if required, to sequence check Commissioning Data Set submissions.

Although (for historical reasons) contained in a 14 alpha-numeric format, a maximum value of 9999999 is permitted in the format of n7.

This control reference data may also be presented on Secondary Uses Service service messages and audit logs, etc.This control reference data may also be presented on Secondary Uses Service (SUS) service messages and audit logs, etc.

CDS-XML Interchanges:

CDS XML Schema Interchanges:
All CDS-XML interchanges submitted must contain a CDS INTERCHANGE CONTROL REFERENCE.All CDS XML Schema interchanges submitted must contain a CDS INTERCHANGE CONTROL REFERENCE.  

top


CDS INTERCHANGE DATE OF PREPARATION

Change to Data Element: Changed Description

Format/Length:See DATE 
National Codes: 
Default Codes: 

Notes:
CDS INTERCHANGE DATE OF PREPARATION is the DATE when the Commissioning Data Set Interchange data was created.

Usage: 
CDS INTERCHANGE DATE OF PREPARATION is a mandatory data element when submitting Commissioning data.

CDS-XML Interchanges:CDS XML Schema Interchanges:
All XML interchanges submitted must contain a CDS INTERCHANGE DATE OF PREPARATION.All CDS XML Schema interchanges submitted must contain a CDS INTERCHANGE DATE OF PREPARATION.

 

top


CDS INTERCHANGE RECEIVER IDENTITY

Change to Data Element: Changed Description

Format/Length:an15
National Codes: 
Default Codes: 

Notes:
CDS INTERCHANGE RECEIVER IDENTITY is the address of the physical site receiving a Commissioning Data Set interchange.

Usage: 
The collection facility for Commissioning data is the Secondary Uses Service.

XML Interchanges:CDS XML Schema Interchanges:
All CDS-XML interchanges submitted must contain the CDS INTERCHANGE RECEIVER IDENTITY of the Secondary Uses Service.All CDS XML Schema interchanges submitted must contain the CDS INTERCHANGE RECEIVER IDENTITY of the Secondary Uses Service. 

top


CDS INTERCHANGE SENDER IDENTITY

Change to Data Element: Changed Description

Format/Length:an15
National Codes: 
Default Codes: 

Notes:
CDS INTERCHANGE SENDER IDENTITY is the assigned EDI Address of the physical ORGANISATION or site responsible for sending Commissioning data.

Usage: 
CDS INTERCHANGE SENDER IDENTITY is a mandatory data element when submitting Commissioning Data Set interchanges.
Every organisation must register its CDS INTERCHANGE SENDER IDENTITY for use with the Secondary Uses Service.

Where an ORGANISATION acts on behalf of another NHS ORGANISATION, care must be taken to ensure the correct use of the identity. For data submitted to the service, the CDS INTERCHANGE SENDER IDENTITY is the EDI Address of the sending site.

XML Interchanges:CDS XML Schema Interchanges:
All CDS-XML interchanges submitted must contain a CDS INTERCHANGE SENDER IDENTITY.All CDS XML Schema interchanges submitted must contain a CDS INTERCHANGE SENDER IDENTITY. 

top


CDS INTERCHANGE TEST INDICATOR

Change to Data Element: Changed Description

Format/Length:an1
National Codes: 
Default Codes: 

Notes:
CDS INTERCHANGE TEST INDICATOR indicates whether the Interchange is a production or test Interchange.

Permitted National Codes:

1The whole Interchange contains Test data
0
(zero)
 
The whole Interchange contains Production data
Other
Blank
Null
The whole Interchange contains Production data

Usage: 
This optional test facility enables interchanges submitted to be marked and therefore processed as Test or Production data.

Whilst the data element is optional it is highly recommended that correct values be completed in the data.

On receipt of a Test Interchange, the processes are as follows:
a) All normal validation processes will be carried out
b) The Interchange data will not be entered into the Secondary Uses Service database

CDS-XML Interchanges:CDS XML Schema Interchanges:
All CDS-XML interchanges submitted may contain a CDS INTERCHANGE TEST INDICATOR.All CDS XML Schema interchanges submitted may contain a CDS INTERCHANGE TEST INDICATOR. 

top


CDS INTERCHANGE TIME OF PREPARATION

Change to Data Element: Changed Description

Format/Length:See TIME 
National Codes: 
Default Codes: 

Notes:
CDS INTERCHANGE TIME OF PREPARATION is the time when the Commissioning Data Set Interchange data was created.

Usage: 
This is a mandatory data element when submitting Commissioning Data Set Interchanges.CDS INTERCHANGE TIME OF PREPARATION is a mandatory data element when submitting Commissioning Data Set Interchanges.

CDS-XML Interchanges:CDS XML Schema Interchanges:
All XML interchanges submitted to the service must contain a CDS INTERCHANGE TIME OF PREPARATION.All CDS XML Schema interchanges submitted to the service must contain a CDS INTERCHANGE TIME OF PREPARATION.

 

top


CDS MESSAGE TYPE

Change to Data Element: Changed Description

Format/Length:an6
National Codes: 
Default Codes: 

Notes:
CDS MESSAGE TYPE is a recommended data element and should be used to indicate the type of message within a Commissioning Data Set Interchange.

Permitted National Codes:

NHSCDSCDS Message

Usage: 
Commissioning Data Set Interchanges should only contain multiple message of the same CDS MESSAGE TYPE.Commissioning Data Set XML Schema interchanges should only contain multiple message of the same CDS MESSAGE TYPE.

 

top


CDS MESSAGE VERSION NUMBER

Change to Data Element: Changed Description

Format/Length:an8
National Codes: 
Default Codes: 

Notes:
CDS MESSAGE VERSION NUMBER is a mandatory data element in the Commissioning Data Set Message Header and reflects the version number of the message in use.CDS MESSAGE VERSION NUMBER is a mandatory data element in the Commissioning Data Set Message Header and reflects the version number of the CDS XML Schema in use. Message version numbers are updated as required during the on-going message development processes.

Permitted National Codes:

NHS003The 2000 / 2001 Specification 
NHS004The 2004 / 2005 CDS-XML Specification 
NHS005The 2005 / 2006 CDS-XML SpecificationFor implementation of XML messaging in the Secondary Uses Service  
NHS004The 2004 / 2005 CDS XML Specification 
NHS005The 2005 / 2006 CDS XML SpecificationFor implementation of XML messaging in the Secondary Uses Service  
CDS006The 2007 CDS-XML Specification (CDS V6-0/6-1/6-1-1)Note the change to the prefix CDS 
CDS062The 2012 CDS-XML Specification (CDS V6-2)Note the change to the format which represents the sub-version identifier (version 6-2)
CDS062The 2012 CDS XML Specification (CDS V6-2)Note the change to the format which represents the sub-version identifier (version 6-2)

Usage: 
Interchanges must only contain CDS Messages of the same CDS MESSAGE VERSION NUMBER and each and every CDS Type must contain a CDS MESSAGE VERSION NUMBER.

 

top


CDS RECORD IDENTIFIER

Change to Data Element: Changed Description

Format/Length:an35
National Codes: 
Default Codes: 

Notes:
CDS RECORD IDENTIFIER may also be referred to as the CDS-RID.

When exchanging Commissioning Data Set data, this is an optional data element and when used is a unique number generated by the sender and inserted into the Commissioning Data Set data to enable senders and recipients to be able to cross-match and uniquely identify each and every Commissioning Data Set record.

The CDS RECORD IDENTIFIER consists of the following components:

REFRID COMPONENTFORMATCODES / VALUES
1CDS SENDER IDENTITY an5As generated in the CDS V6-2 Type 005B - CDS Transaction Header Group - Bulk Update Protocol or the CDS V6-2 Type 005N - CDS Transaction Header Group - Net Change Protocol 
2Not Usedan2Set = Blank
3CDS INTERCHANGE CONTROL REFERENCE an14
(n7) *
As generated in the CDS V6-2 Type 001 - CDS Interchange Header 
4CDS MESSAGE REFERENCE an14
(n7) *
As generated in the CDS V6-2 Type 003 - CDS Message Header 

* This data item is configured as an14 format element, but a maximum value of 9999999 is permitted in the format of n7.

Usage: 

The CDS-RID is an optional reference assigned to each record by the Commissioning Data Set sender to aid the identification and cross-referencing of data between the sender and the receiver(s) of the Commissioning Data Set data.

CDS-XML Interchanges:CDS XML Schema Interchanges:

The CDS-RID data element is carried in the CDS Message Header (CDS V6-2 Type 003 - CDS Message Header). 

top


INVESTIGATION SCHEME IN USE

Change to Data Element: Changed Description

Format/length:an2
Format/Length:an2
National Codes: 
Default Codes: 

Notes:


Definition:
This is used in the Clinical Activity Group of the Commissioning Data Set to denote the scheme basis of an investigation.

INVESTIGATION SCHEME IN USE is used in the Clinical Activity Group of the Commissioning Data Set to denote the scheme basis of an investigation.

Permitted National Codes:

01Accident & Emergency Investigation

CDS-XML Message:

The codes as specified above must be used for CDS-XML messages. 

top


LOCATION CLASS

Change to Data Element: Changed Description

Format/Length:an2
National Codes: 
Default Codes: 

Notes:
LOCATION CLASS is a classification for use within Commissioning Data Set messages of the physical location within which the recorded PATIENT event occurs.

Permitted National Codes:

01Health Site (General Occurrence)
02Home
03Delivery Place
04Health site at the start of Health Care Activity
05Health site at the end of Health Care Activity

CDS-XML Message:

The codes as specified above must be used in CDS-XML messages. 

top


ORGANISATION CODE TYPE

Change to Data Element: Changed Description

Format/length:an1
Format/Length:an1
National Codes: 
Default Codes: 

Notes:
A code to identify the format and basis of the release of an NHS ORGANISATION CODE being used.ORGANISATION CODE TYPE is a code to identify the format and basis of the release of an NHS ORGANISATION CODE being used.

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 issued from April 1996

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

NOTE:

The use of this data element has been withdrawn from use in the CDS-XML Message formats
from CDS-XML Version 5-0 (NHS005) onwards but it may still be used in the formatting of the CDS UNIQUE IDENTIFIER.The use of this data element has been withdrawn from use in the CDS XML Schema from CDS XML Schema Version 5-0 (NHS005) onwards but it may still be used in the formatting of the CDS UNIQUE IDENTIFIER.  

top


PROCEDURE (OPCS)

Change to Data Element: Changed Description

Format/Length:See OPCS-4 CODE
National Codes: 
Default Codes: 

Notes:
PROCEDURE (OPCS) is the same as attribute CLINICAL CLASSIFICATION CODE.

PROCEDURE (OPCS) is a procedure other than the PRIMARY PROCEDURE (OPCS).

For Commissioning Data Sets purposes it is recommended that multiple Procedures are recorded and the CDS-XML Message (CDS Version 6 onwards) has been designed to carry as many Procedures as required.For Commissioning Data Sets purposes it is recommended that multiple Procedures are recorded and the CDS XML Schema (CDS Version 6 onwards) has been designed to carry as many Procedures as required.

 

top


PROCEDURE (READ)

Change to Data Element: Changed Description

Format/Length:See READ CODE
National Codes: 
Default Codes: 

Notes:
PROCEDURE (READ) is the same as attribute CLINICAL TERMINOLOGY CODE.

PROCEDURE (READ) is the Read Coded Clinical Terms for a procedure other than the PRIMARY PROCEDURE (READ).

For Commissioning Data Sets purposes it is recommended that multiple Procedures are recorded and the CDS-XML Message (CDS Version 6 onwards) has been designed to carry as many Procedures as required.For Commissioning Data Sets purposes it is recommended that multiple Procedures are recorded and the CDS XML Schema (CDS Version 6 onwards) has been designed to carry as many Procedures as required.

Note: Read Coded Clinical Terms Version 3 (CTV3) with qualifiers is not supported in the Commissioning Data Sets.Note: Read Coded Clinical Terms Version 3 (CTV3) with qualifiers is not supported in the Commissioning Data Sets. Therefore, the Commissioning Data Set Version 6-2 XML Schema has the format of this Data Element constrained to max an5.

 

top


SECONDARY DIAGNOSIS (ICD)

Change to Data Element: Changed Description

Format/Length:See ICD-10 CODE
National Codes: 
Default Codes: 

Notes:
SECONDARY DIAGNOSIS (ICD) is the same as attribute CLINICAL CLASSIFICATION CODE.

SECONDARY DIAGNOSIS (ICD) is the International Classification of Diseases (ICD) code used to identify the secondary PATIENT DIAGNOSIS.

For Commissioning Data Sets (CDS) purposes it is recommended that multiple Diagnoses are recorded and the CDS-XML Message (CDS Version 6 onwards) has been designed to carry as many Diagnoses as required.For Commissioning Data Sets (CDS) purposes it is recommended that multiple Diagnoses are recorded and the CDS XML Schema (CDS Version 6 onwards) has been designed to carry as many Diagnoses as required.

SECONDARY DIAGNOSIS (ICD) is used by the Secondary Uses Service to derive the Healthcare Resource Group 4. Failure to correctly populate this data element is likely to result in an incorrect Healthcare Resource Group, usually resulting in lower levels of healthcare resource.

For further information, please refer to the Secondary Uses Service Guidance page.

Note:

  • The format/length of this Data Element has been corrected as a result of the work undertaken for the development of the Coding Strategy.
  • The data set specifications of the data sets that contain this Data Element will be updated in the next version of the information standard where it is not already correct.
 

top


SECONDARY DIAGNOSIS (READ)

Change to Data Element: Changed Description

Format/Length:See READ CODE
National Codes: 
Default Codes: 

Notes:
SECONDARY DIAGNOSIS (READ) is the same as attribute CLINICAL TERMINOLOGY CODE.

SECONDARY DIAGNOSIS (READ) is the Read Coded Clinical Terms used to identify the secondary PATIENT DIAGNOSIS.

For Commissioning Data Set (CDS) purposes it is recommended that multiple Diagnoses are recorded and the CDS-XML Message (CDS Version 6 onwards) has been designed to carry as many Diagnoses as required.For Commissioning Data Set (CDS) purposes it is recommended that multiple Diagnoses are recorded and the CDS XML Schema (CDS Version 6 onwards) has been designed to carry as many Diagnoses as required.

Note: Read Coded Clinical Terms Version 3 (CTV3) with qualifiers is not supported in the Commissioning Data Sets.Note: Read Coded Clinical Terms Version 3 (CTV3) with qualifiers is not supported in the Commissioning Data Sets. Therefore, the Commissioning Data Set Version 6-2 XML Schema has the format of this Data Element constrained to max an5.

 

top


COMMISSIONING DATA SET VERSION 6-2 XML SCHEMA CONSTRAINTS

Change to XML Schema Constraint: Changed Description

XML Schema constraints applied to the Commissioning Data Sets.XML Schema constraints applied to the Commissioning Data Sets.

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

  • None = The National Codes and Default Codes are included in the XML Schema
  • Removed = The National Codes and Default Codes are not included in the XML Schema.
Data ElementXML Schema Format/LengthAllowed ValuesRangePattern MatchReason / Comment / XML Choice
A and E ATTENDANCE NUMBERmax an12
None
None
None
Existing Format/Length states an12 - XML Schema allows max an12
ACCIDENT AND EMERGENCY DIAGNOSIS - FIRSTmin an2 max an6
None
None
None
Existing Format/Length states an6 - XML Schema allows min an2 max an6
ACCIDENT AND EMERGENCY DIAGNOSIS - SECONDmin an2 max an6
None
None
None
Existing Format/Length states an6 - XML Schema allows min an2 max an6
ACCIDENT AND EMERGENCY INVESTIGATION - FIRSTmin an2 max an6
None
None
None
Existing Format/Length states an6 - XML Schema allows min an2 max an6
ACCIDENT AND EMERGENCY INVESTIGATION - SECONDmin an2 max an6
None
None
None
Existing Format/Length states an6 - XML Schema allows min an2 max an6
ACCIDENT AND EMERGENCY TREATMENT - FIRSTmin an2 max an6
None
None
None
Existing Format/Length states an6 - XML Schema allows min an2 max an6
ACCIDENT AND EMERGENCY TREATMENT - SECONDmin an2 max an6
None
None
None
Existing Format/Length states an6 - XML Schema allows min an2 max an6
ADVANCED CARDIOVASCULAR SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
ADVANCED RESPIRATORY SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
AGE AT CDS ACTIVITY DATEmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
AGE AT CENSUSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
AGE ON ADMISSIONmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
ATTENDANCE IDENTIFIERmax an12
None
None
None
Existing Format/Length states an12 - XML Schema allows max an12
BASIC CARDIOVASCULAR SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
BASIC RESPIRATORY SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
BIRTH WEIGHTmax n4
None
None
None
Existing Format/Length states n4 - XML Schema allows max n4
CARE PROFESSIONAL MAIN SPECIALTY CODENone
100,101,110,120,130,140,141,142,143,145,146,147,148,149,
150,160,170,171,180,190,192,300,301,302,303,304,305,310,
311,312,313,314,315,320,321,325,326,330,340,350,352,360,
361,370,371,400,401,410,420,421,430,450,451,460,501,502,
504,560,600,601,700,710,711,712,713,715,800,810,820,821,
822,823,824,830,831,833,834,900,901,902,903,904,950,960,
199,499
None
None
National Code 500 removed (not allowed in XML Schema)
CDS COPY RECIPIENT IDENTITYmin an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
CDS MESSAGE REFERENCEmax n7
None
None
None
Existing Format/Length states n7 - XML Schema allows max n14 but SUS accepts max n7
CDS MESSAGE VERSION NUMBERNone
CDS062
Existing Format/Length states n7 - XML Schema allows max n14 but SUS accepts max n7
CDS MESSAGE VERSION NUMBERNone
CDS062
None
None
Message version is hard coded in the XML Schema
CDS PRIME RECIPIENT IDENTITYmin an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
CDS SENDER IDENTITYmin an3 max an12
None
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
CDS UNIQUE IDENTIFIERmax an35
None
None
None
Existing Format/Length states an35 - XML Schema allows max an35
COMMISSIONER REFERENCE NUMBERmax an17
None
None
None
Existing Format/Length states an17 - XML Schema allows max an17
COMMISSIONING SERIAL NUMBERmax an6
None
None
None
Existing Format/Length states an6 - XML Schema allows max an6
CONSULTATION MEDIUM USEDNone
01,02,03,04
None
None
National Codes 05, 06 and 98 are not used in CDS version 6-2
COUNT OF DAYS SUSPENDEDmax n4
None
None
None
Existing Format/Length states n4 - XML Schema allows max n4
CRITICAL CARE LEVEL 2 DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
CRITICAL CARE LEVEL 3 DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
CRITICAL CARE LOCAL IDENTIFIERmax an8
None
None
None
Existing Format/Length states an8 - XML Schema allows max an8
DERMATOLOGICAL SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
DURATION OF CARE TO PSYCHIATRIC CENSUS DATEmax n5
None
None
None
Existing Format/Length states n5 - XML Schema allows max n5
DURATION OF DETENTIONmax n5
None
None
None
Existing Format/Length states n5 - XML Schema allows max n5
DURATION OF ELECTIVE WAITmax n4
None
None
None
Existing Format/Length states n4 - XML Schema allows max n4
ELECTIVE ADMISSION LIST ENTRY NUMBERmax an12
None
None
None
Existing Format/Length states an12 - XML Schema allows max an12
EPISODE NUMBERmax an2
None
None
None
Existing Format/Length states an2 - XML Schema allows max an2
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
GASTRO-INTESTINAL SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
GENERAL MEDICAL PRACTITIONER PRACTICE (ANTENATAL CARE)min an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
GENERAL MEDICAL PRACTICE CODE (PATIENT REGISTRATION)min an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
GENERAL MEDICAL PRACTITIONER (ANTENATAL CARE)None
Removed
None
None
National Codes and default codes not enumerated in the XML Schema
GENERAL MEDICAL PRACTITIONER (SPECIFIED)None
Removed
None
None
National Codes and default codes not enumerated in the XML Schema
HOSPITAL PROVIDER SPELL NUMBERmax an12
None
None
None
Existing Format/Length states an12 - XML Schema allows max an12
INTENDED SITE CODE (OF TREATMENT)min an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
LIVER SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
LOCAL PATIENT IDENTIFIERmax an10
None
None
None
Existing Format/Length states an10 - XML Schema allows max an10
LOCAL PATIENT IDENTIFIER (BABY)max an10
None
None
None
Existing Format/Length states an10 - XML Schema allows max an10
LOCAL PATIENT IDENTIFIER (MOTHER)max an10
None
None
None
Existing Format/Length states an10 - XML Schema allows max an10
MENTAL HEALTH ACT LEGAL STATUS CLASSIFICATION CODE (AT CENSUS DATE)None
01,02,03,04,05,06,07,08,09,10,11,12,13,14,
15,16,17,18,19,20,31,32,34,35,36,37,38
None
None
Additional National Codes 37 and 38 added
MENTAL HEALTH ACT LEGAL STATUS CLASSIFICATION CODE (ON ADMISSION)None
01,02,03,04,05,06,07,08,09,10,11,12,13,14,
15,16,17,18,19,20,31,32,34,35,36,37,38
None
None
Additional National Codes 37 and 38 added
NEUROLOGICAL SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
NHS SERVICE AGREEMENT LINE NUMBERmax an10
None
None
None
Existing Format/Length states an10 - XML Schema allows max an10
ORGAN SUPPORT MAXIMUMNone
None
00-06
None
Range 00-06 allowed
ORGANISATION CODE (CODE OF COMMISSIONER)min an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
ORGANISATION CODE (CODE OF PROVIDER)min an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION SITE CODE changes
ORGANISATION CODE (LOCAL PATIENT IDENTIFIER)min an3 max an12
None
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
ORGANISATION CODE (LOCAL PATIENT IDENTIFIER (BABY))min an3 max an12
None
None
None
Field size extended to future proof for ODS ORGANISATION SITE CODE changes
ORGANISATION CODE (LOCAL PATIENT IDENTIFIER (MOTHER))min an3 max an12
None
None
None
Field size extended to future proof for ODS ORGANISATION SITE CODE changes
ORGANISATION CODE (PATIENT PATHWAY IDENTIFIER ISSUER)min an3 max an12
None
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
ORGANISATION CODE (RESIDENCE RESPONSIBILITY)min an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION SITE CODE changes
PERSON WEIGHTn3.n3
None
None
None
Existing Format/Length states max n3.max n3 - XML Schema enforces 3 digits before and after the decimal point - max removed
PRIMARY DIAGNOSIS (READ)max an5
None
None
None
Existing Format/Length allows for all clinical classifications -XML Schema allows max an5
PROVIDER REFERENCE NUMBERmax an17
None
None
None
Existing Format/Length states an17 - XML Schema allows max an17
REFERRER CODENone
Removed
None
None
National Codes and default codes not enumerated in the XML Schema
REFERRING ORGANISATION CODEmin an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes
RENAL SUPPORT DAYSmax n3
None
None
None
Existing Format/Length states n3 - XML Schema allows max n3
SECONDARY DIAGNOSIS (READ)max an5
None
None
None
Existing Format/Length allows for all clinical classifications -XML Schema allows max an5
SITE CODE (OF TREATMENT)min an3 max an12
Removed
None
None
Field size extended to future proof for ODS ORGANISATION CODE changes

top


For enquiries about this Change Request, please email information.standards@hscic.gov.uk