Change Request
 
NHS Information Authority

NHS Data Model and Dictionary Service

Reference: Change Request 457
Version No: 1.37
Subject: Migration of CDS data specifications into the NHS Data Dictionary.
Type of Change: Data Standards
Effective Date: 1 July 2004
Reason for Change: Migration of all the remaining specifications of CDS Message and Header data elements from the NHS CDS Manual into the NHS Data Dictionary to support the introduction of CDS-XML based messages.

Background:

The replacement of the NHS-Wide Clearing Service (NWCS) with the new Secondary Uses Service (SUS) provides the opportunity to update the standards used for the Commissioning Data Set (CDS) and Mental Health Minimum Data Set (MHMDS) messages. The Requirement for CDS-XML and MHMDS-XML messages has been approved by the NHS Information Standards Board and therefore these messages will be updated to use the XML based standards to conform to the electronic-Government Interoperability Framework (e-GIF).

The CDS Header and Trailer data structures, which form an integral part of the new XML schemas and are currently documented in the NHS CDS Manual, have been migrated into the NHS Data Dictionary. The CDS data items defined in the NHS CDS Manual have been repositioned as data elements and added to the NHS Data Dictionary.

The CDS Message

The Commissioning Data Sets (CDS) use the NHSCDS EDIFACT message as their technical format for data exchange. In particular, the NHSCDS message required specially formatted interchange and message headers and trailers. These structures are documented in the NHS CDS Manual.

Compliance with e-GIF requires that XML standards are adopted for messages and to comply with this the CDS-XML Version 4 has been developed for use by the Secondary Uses Service (SUS). The CDS-XML Version 4 contains all data structures and elements including the CDS interchange and message headers and trailers. To ensure that the CDS-XML specification is supported by a complete set of NHS data definitions, the historic CDS data items have been repositioned into the NHS Data Dictionary as data elements.

The NHSCDS EDIFACT Message

The current NHSCDS message (Version NHS003) is the final CDS message to be designed using EDIFACT standards. Following the implementation of the CDS-XML message, the NHSCDS EDIFACT message will be removed from service and the current NHS CDS Manual will be largely obsolete. Certain elements of the manual need to be retained, the CDS data item definitions (Volume A, Chapter A.5) being of prime importance. The longer term intention is to reposition all message specifications into the NHS Data Dictionary.

The CDS-XML and MHMDS_XML Messages

This DSCN does not detail the structure and format of the CDS-XML and MHMDS-XML messages themselves, these will be subject to a separate DSCN.


Summary of changes:

Data Elements
CDS APPLICABLE DATE    New Data Element
CDS APPLICABLE TIME    New Data Element
CDS BULK REPLACEMENT GROUP    New Data Element
CDS CENSUS DATE    New Data Element
CDS COPY RECIPIENT IDENTITY    New Data Element
CDS EXTRACT DATE    New Data Element
CDS EXTRACT TIME    New Data Element
CDS INTERCHANGE APPLICATION REFERENCE    New Data Element
CDS INTERCHANGE CONTROL COUNT    New Data Element
CDS INTERCHANGE CONTROL REFERENCE    New Data Element
CDS INTERCHANGE DATE OF PREPARATION    New Data Element
CDS INTERCHANGE IGS REFERENCE    New Data Element
CDS INTERCHANGE RECEIVER IDENTITY    New Data Element
CDS INTERCHANGE SENDER IDENTITY    New Data Element
CDS INTERCHANGE TEST INDICATOR    New Data Element
CDS INTERCHANGE TIME OF PREPARATION    New Data Element
CDS MESSAGE REFERENCE    New Data Element
CDS MESSAGE TYPE    New Data Element
CDS MESSAGE VERSION NUMBER    New Data Element
CDS PRIME RECIPIENT IDENTITY    New Data Element
CDS PROTOCOL IDENTIFIER    New Data Element
CDS RECORD IDENTIFIER    New Data Element
CDS REPORT PERIOD END DATE    New Data Element
CDS REPORT PERIOD START DATE    New Data Element
CDS SENDER IDENTITY    New Data Element
CDS TEST INDICATOR    New Data Element
CDS TYPE    New Data Element
CDS UNIQUE IDENTIFIER    New Data Element
CDS UPDATE TYPE    New Data Element
DETAINED AND (OR) LONG TERM PSYCHIATRIC CENSUS DATE    Change to Description
DIAGNOSIS SCHEME IN USE    Change to Description
INVESTIGATION SCHEME IN USE    Change to Aliases
LOCATION CLASS    Change to Description
MHMDS CONTROL NUMBER    New Data Element
MHMDS DATE CREATED    New Data Element
MHMDS DESTINATION IDENTIFICATION    New Data Element
MHMDS HEADER RECORD IDENTIFIER    New Data Element
MHMDS IGS TRANSLATION REFERENCE    New Data Element
MHMDS RECORD COUNT    New Data Element
MHMDS RECORD IDENTIFER    New Data Element
MHMDS RECORD NUMBER    New Data Element
MHMDS SOURCE IDENTIFICATION    New Data Element
MHMDS TEST INDCATOR    New Data Element
MHMDS TIME CREATED    New Data Element
MHMDS TRAILER RECORD IDENTIFIER    New Data Element
MHMDS TRANSLATION REFERENCE    New Data Element
ORGANISATION CODE TYPE CDS COPY RECIPIENT    New Data Element
ORGANISATION CODE TYPE CDS PRIME RECIPIENT    New Data Element
ORGANISATION CODE TYPE CDS SENDER IDENTITY    New Data Element
PROCEDURE SCHEME IN USE    Change to Aliases
REPORTING PERIOD END DATE MENTAL HEALTH    New Data Element
REPORTING PERIOD START DATE MENTAL HEALTH    New Data Element
 
Data Sets (CDS, CMDS, HES)
CDS INTERCHANGE HEADER    New Data Set (CDS, CMDS, HES)
CDS INTERCHANGE TRAILER    New Data Set (CDS, CMDS, HES)
CDS MESSAGE HEADER    New Data Set (CDS, CMDS, HES)
CDS MESSAGE TRAILER    New Data Set (CDS, CMDS, HES)
CDS TRANSACTION HEADER GROUP BULK UPDATE    New Data Set (CDS, CMDS, HES)
CDS TRANSACTION HEADER GROUP NET CHANGE    New Data Set (CDS, CMDS, HES)
 
Supporting Information
CDS TYPE LIST NAVIGATION    Change to Supporting Information
 

Name: Model 3
Date: 14 January 2005
Sponsor: NHS Data Model and Dictionary Service

Note: Additions shown in highlighted with a blue background. Deletions are shown using strikeout. Within the Diagrams deleted classes and relationships are shown as red in colour, blue is used for changed items and green is used for created items.

Click here for a printer friendly view of this page.


CDS APPLICABLE DATE

Change to Data Element: New Data Element

CDS APPLICABLE DATE

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
The date (with an associated CDS APPLICABLE TIME) of the update event (or the nearest equivalent) that resulted in the need to exchange this CDS.

Usage:
This CDS data item is mandatory when used with the CDS Net Change Update Mechanism.
It is not required when the CDS Bulk Replacement Update Mechanism is used.

The CDS APPLICABLE DATE (and TIME if supplied) is stored in the database and in the event of multiple submissions of the same uniquely identified CDS (even in separate interchanges), the database update process is then able to use the date and time to ensure correct updating of the CDS data in the correct relative date/time sequence.

CDS-XML Interchanges:
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.

NHSCDS EDIFACT Interchanges:
Used as a combined DATE/TIME element in the format CCYYMMDDHHMM.
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
The date and time must be supplied in the CDS IGS Header Record. 


top


CDS APPLICABLE TIME

Change to Data Element: New Data Element

CDS APPLICABLE TIME

Format/length: See TIME
HES item:
National Codes:
Default Codes:

Notes:

Definition:
The time (with an associated DATE) of the update event (or the nearest equivalent) that resulted in the need to exchange this CDS.

Usage:
This CDS data item is mandatory when used with the CDS Net Change Update Mechanism.
It is not required when the CDS Bulk Replacement Update Mechanism is used.

The CDS APPLICABLE TIME (and DATE if supplied) is stored in the database and in the event of multiple submissions of the same uniquely identified CDS (even in separate interchanges), the database update process is then able to use the date and time to ensure correct updating of the CDS data in the correct relative date/time sequence.

CDS-XML Interchanges:
Used in the NHS standard format which is the e-GIF compliant format of HH:MM:SS (and an optional.sss).

NHSCDS EDIFACT Interchanges:
Used as a combined DATE/TIME element in the format CCYYMMDDHHMM.
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
The date and time must be supplied in the CDS IGS Header Record. 


top


CDS BULK REPLACEMENT GROUP

Change to Data Element: New Data Element

CDS BULK REPLACEMENT GROUP

Format/length: n3
HES item:
National Codes:
Default Codes:

Notes:

Definition:
The CDS Group into which CDS Types must be grouped when using the CDS Bulk Replacement Update Mechanism.

Permitted values are:

CODE CLASSIFICATION
010 Finished General, Delivery and Birth Episodes
020 Unfinished General, Delivery and Birth Episodes
030 Other Delivery
040 Other Birth
050 Detained and/or Long Term Psychiatric Census
060 Out-Patient and Ward Attendance
070 Standard variation of Elective Admission List End Of Period Census
080 New and Old variations of Elective Admission List End Of Period Census
090 Add variation of Elective Admission List Event During Period
100 Remove variation of Elective Admission List Event During Period
110 Offer variation of Elective Admission List Event During Period
120 Available/Unavailable variation of Elective Admission List Event During Period
130 New and Old variations of Elective Admission List Event During Period
140 Accident and Emergency Attendance

Usage:
This is a mandatory data item when the Bulk Replacement Update Mechanism is used and is not required when the Net Change Update Mechanism is used.
The CDS Bulk Replacement Update Mechanism process identifies previously transferred CDSs Types that are to be replaced by the submitted CDS interchange.
To do this the CDS BULK REPLACEMENT GROUP must be used together with the following data items:
CDS REPORT PERIOD START DATE
CDS REPORT PERIOD END DATE
CDS INTERCHANGE SENDER IDENTITY
CDS PRIME RECIPIENT IDENTITY

It is particularly important when using the CDS Bulk Replacement Update Mechanism for a CDS BULK REPLACEMENT GROUP to contain all the relevant CDS Types for the extracted time period in a single CDS Interchange, e.g. the Finished General Episodes, Finished Delivery Episodes and Finished Birth Episodes in a Finished Episode Group. 


top


CDS CENSUS DATE

Change to Data Element: New Data Element

CDS CENSUS DATE

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
The date on which the relevant census was undertaken.

Usage:
This is a mandatory data item when submitting the ADMITTED PATIENT CARE CDS TYPE - DETAINED AND - OR LONG TERM PSYCHIATRIC CENSUS and the relevant Elective Admission List CDS Types.

CDS-XML Interchanges:
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.

NHSCDS EDIFACT Interchanges:
Used in a combined DATE/TIME element. 


top


CDS COPY RECIPIENT IDENTITY

Change to Data Element: New Data Element

CDS COPY RECIPIENT IDENTITY

Format/length: an5
HES item:
National Codes:
Default Codes:


Notes:

Definition:
See ORGANISATION CODE.
The 5-character NHS ORGANISATION CODE (or valid default code) for an organisation indicated as a CDS COPY RECIPIENT of the CDS Message.

Usage:
A Recipient may be an agency or service provider that carries out the receiving (and perhaps other) processes on behalf of the NHS Organisation that ultimately uses the data. There may be multiple recipients for a CDS.
Default codes for CDS COPY RECIPIENT(s) are detailed in the CDS Addressing Grid as defined in the CDS HES Contextual .
 


top


CDS EXTRACT DATE

Change to Data Element: New Data Element

CDS EXTRACT DATE

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
The date (with an associated TIME ) of the update event (or the nearest equivalent) that resulted in the need to exchange this CDS.

Usage:
This CDS data item is mandatory when used with the CDS Bulk Replacement Update Mechanism. It is not required when the CDS Net Change Update Mechanism is used.
The CDS EXTRACT DATE (and TIME if supplied) is stored in the database and in the event of multiple submissions of a similarly defined identified Bulk Update submission of CDSs (even in separate interchanges), the database update process is then able to use the date and time to ensure correct updating of the CDS data in the correct relative date/time sequence.

CDS-XML Interchanges:
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.

NHSCDS EDIFACT Interchanges:
Used as a combined DATE/TIME element in the format CCYYMMDDHHMM.
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
The date and time must be supplied in the CDS IGS Header Record. 


top


CDS EXTRACT TIME

Change to Data Element: New Data Element

CDS EXTRACT TIME

Format/length: See TIME
HES item:
National Codes:
Default Codes:

Notes:

Definition:
The time at which the CDS extract was undertaken.

Usage:
This CDS Data item is mandatory when using the CDS Bulk Replacement Update Mechanism and is used to ensure that submissions are processed in the correct relative sequence, especially where submissions contain multiple data sets. The sender of CDS data should determine the most useful point of the system's processes to generate and insert this time into the data stream to provide a useful reference/audit control point.

Recommended uses are:
At the point of the PAS/CASEMIX extract process.
After any further data pre-processing. 
On completion of the EDI translation processes.

CDS-XML Interchanges:
Used in the NHS standard format which is the e-GIF compliant format of HH:MM:SS (and an optional.sss).

NHSCDS EDIFACT Interchanges:
Used as a combined DATE/TIME element in the format CCYYMMDDHHMM. 
The HHMM time element is optional.
 


top


CDS INTERCHANGE APPLICATION REFERENCE

Change to Data Element: New Data Element

CDS INTERCHANGE APPLICATION REFERENCE

Format/length: an14
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This element 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
NHSCDS CDS Interchange

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

NHSCDS EDIFACT Interchanges:
The CDS INTERCHANGE APPLICATION REFERENCE is represented by the data value contained in the EDIFACT UNB 0026 EDIFACT Application Reference.

EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
Not Applicable.


top


CDS INTERCHANGE CONTROL COUNT

Change to Data Element: New Data Element

CDS INTERCHANGE CONTROL COUNT

Format/length: n7
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a mandatory data element and is a count of CDS Messages contained in the CDS Interchange.

Usage:
Senders of CDS Interchanges must generate this data.
Recipients of CDS Interchanges are advised to recount the received CDS messages and match this control count to ensure all CDS data submitted has been correctly received.
 


top


CDS INTERCHANGE CONTROL REFERENCE

Change to Data Element: New Data Element

CDS INTERCHANGE CONTROL REFERENCE

Format/length: an14
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This provides a unique number (per sender) to identify every CDS submission.
For each CDS 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 CDS Interchanges and is used to uniquely identify and if required, to sequence check all CDS submissions. 
Although EDIFACT configures a 14 alpha-numeric format, a maximum value of 9,999,999 is permitted in the format of n7.
This control reference data may also be presented on service messages and audit logs, etc.

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

NHSCDS EDIFACT Interchanges:
The CDS INTERCHANGE CONTROL REFERENCE is represented by the data value contained in the EDIFACT UNB 0020 Interchange Control Reference data element. 
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
The CDS INTERCHANGE CONTROL REFERENCE is represented by the data value contained in the Control Number data element as defined in the Interface Gateway Service Control record. The authorised source of this definition is contained in the NWCS User Guide.

Note that in the CDS IGS record the Control Number data field has a format of n7.
Wrap around from 9999999 to 1 must be supported.


top


CDS INTERCHANGE DATE OF PREPARATION

Change to Data Element: New Data Element

CDS INTERCHANGE DATE OF PREPARATION

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is the date when the CDS Interchange data was created.

Usage:
This is a mandatory data element when submitting CDS Interchanges.

CDS-XML Interchanges:
All XML interchanges submitted must contain a CDS INTERCHANGE DATE OF PREPARATION.
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.

NHSCDS EDIFACT Interchanges:
The CDS INTERCHANGE DATE OF PREPARATION is represented by the date contained in the EDIFACT UNB S004/0017 Date Of Preparation compound data element. Note that the EDIFACT format is YYMMDD which is not e-GIF compliant.

CDS INTERFACE GATEWAY SERVICE Interchanges:
The CDS INTERCHANGE DATE OF PREPARATION is represented by the date data contained in the Date Created data field as contained in the Interface Gateway Service Control record. Note that this has the format of CCYYMMDD.
The authorised source of the definition of this IGS data field is contained in the NWCS User Guide. 


top


CDS INTERCHANGE IGS REFERENCE

Change to Data Element: New Data Element

CDS INTERCHANGE IGS REFERENCE

Format/length: an7
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This identifies the Interface Gateway Service (IGS) translation map required to process the submitted application format file input to a pre-determined EDIFACT translation process.

Usage:
This is a mandatory data element when submitting CDS Interchanges using a CDS IGS. The authorised definition of values for this data field is contained in the NWCS User Guide.

CDS-XML Interchanges:
Available for future use.

CDS INTERFACE GATEWAY SERVICE Interchanges:
The CDS INTERCHANGE IGS REFERENCE is mandatory when using a CDS IGS and is represented by the data contained in the Translation Reference data field as defined in the Interface Gateway Service Control record.
Values for this data field are defined in the NWCS User Guide.

NHSCDS EDIFACT Interchanges:
Not applicable. 


top


CDS INTERCHANGE RECEIVER IDENTITY

Change to Data Element: New Data Element

CDS INTERCHANGE RECEIVER IDENTITY

Format/length: an15
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is the address of the physical site receiving a CDS interchange.

Usage:
This is a mandatory data element when receiving CDS interchanges.
Every ORGANISATION wishing to receive data from the service must register its CDS INTERCHANGE RECEIVER IDENTITY . Where an Organisation acts on behalf of another NHS Organisation, care must be taken to ensure the correct use of the address.

For onward delivery, the service will insert the identity in the CDS INTERCHANGE SENDER IDENTITY as the address of the physical site to send the data and the address of the recipient into the CDS INTERCHANGE RECEIVER IDENTITY.

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

NHSCDS EDIFACT Interchanges:
The CDS INTERCHANGE RECEIVER IDENTITY is represented by the EDI Receiver Address data contained in the EDIFACT UNB S003/0010 Recipient Identification data element and must conform to the NHS EDI Addressing Standards as specified in NWNDT/T1.20.2 as allocated by the NHS Information Authority.
Note that this utilises a 15 alpha-character format although the EDIFACT data element supports an an35 format.
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
The CDS INTERCHANGE RECEIVER IDENTITY is represented by the EDI Receiver Address contained in the Destination Identification data field as defined in the CDS Interface Gateway Service Control record. The authorised source of this definition is contained in the NWCS User Guide.
Note that the MHMDS Assembler software generates this data into its CDS IGS control record before submitting data.


top


CDS INTERCHANGE SENDER IDENTITY

Change to Data Element: New Data Element

CDS INTERCHANGE SENDER IDENTITY

Format/length: an15
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is the address of the physical ORGANISATION or site responsible for sending a CDS interchange.

Usage:
This is a mandatory data element when submitting CDS interchanges.
Every organisation must register its CDS INTERCHANGE SENDER IDENTITY and/or CDS INTERCHANGE RECEIVER IDENTITY with the service. Where an Organisation acts on behalf of another NHS Organisation, care must be taken to ensure the correct use of the address. For data submitted to the service the CDS INTERCHANGE SENDER IDENTITY is the EDI Address of the sending site.
For onward delivery, the service will insert the CDS supplier identity as the address of the physical site to send the data.

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

NHSCDS EDIFACT Interchanges:
The CDS INTERCHANGE SENDER IDENTITY is represented by the EDI Sender Address data contained in the EDIFACT UNB S002/0004 Sender Identification data element and must conform to the NHS EDI Addressing Standards as specified in NWNDT/T1.20.2 as allocated by the NHS Information Authority.
Note that this utilises a 15 alpha-character format although the EDIFACT data element supports an an35 format.
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
The CDS INTERCHANGE SENDER IDENTITY is represented by the EDI Sender Address contained in the Source Identification data field as defined in the CDS Interface Gateway Service Control record. The authorised source of this definition is contained in the NWCS User Guide.
Note that the MHMDS Assembler software generates this data into its CDS IGS control record carried at the start of the MHMDS before submitting the data.


top


CDS INTERCHANGE TEST INDICATOR

Change to Data Element: New Data Element

CDS INTERCHANGE TEST INDICATOR

Format/length: an1
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This indicates whether the Interchange is a production or test Interchange.

CODE CLASSIFICATION
1 The whole Interchange contains TEST data
0 (zero) The whole Interchange contains PRODUCTION data
Other The whole Interchange contains PRODUCTION data
Blank The whole Interchange contains PRODUCTION data
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 database
c) The Interchange data will not be delivered to any receiver

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

NHSCDS EDIFACT Interchanges:
The CDS INTERCHANGE TEST INDICATOR is represented by the data value contained in the EDIFACT UNB 0035 EDIFACT Test Indicator. EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
The CDS INTERCHANGE TEST INDICATOR is represented by the data value contained in the Test Indicator data field as defined in the CDS Interface Gateway Service Control record. The authorised source of this definition is contained in the NWCS User Guide.

Note:
A further test facility exists where an individual CDS may be marked as test by setting the CDS TEST INDICATOR in the CDS Transaction Header Group.


top


CDS INTERCHANGE TIME OF PREPARATION

Change to Data Element: New Data Element

CDS INTERCHANGE TIME OF PREPARATION

Format/length: See TIME
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is the time when the CDS Interchange data was created.

Usage:
This is a mandatory data element when submitting CDS Interchanges.

CDS-XML Interchanges:
All XML interchanges submitted to the service must contain a CDS INTERCHANGE TIME OF PREPARATION.
Used in the NHS standard format which is the e-GIF compliant format of HH:MM:SS (and an optional.sss).

NHSCDS EDIFACT Interchanges:
The CDS INTERCHANGE TIME OF PREPARATION is represented by the time data contained in the EDIFACT UNB S004/0019 Time Of Preparation compound data element.
Note that the EDIFACT format is HHMM which is not e-GIF compliant.

CDS INTERFACE GATEWAY SERVICE Interchanges:
The CDS INTERCHANGE TIME OF PREPARATION is represented by the date data contained in the Time Created data field as defined in the Interface Gateway Service Control record.
 


top


CDS MESSAGE REFERENCE

Change to Data Element: New Data Element

CDS MESSAGE REFERENCE

Format/length: an14
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a mandatory data element and is a sequentially incremented number for each message within an interchange.

Usage:
For each message within an interchange the CDS MESSAGE REFERENCE is assigned to provide a unique identity (within an interchange).
Although EDIFACT configures a 14 alpha-numeric format, a maximum value of 9999999 is permitted in the format of n7.
Wrap around from 9999999 to 1 must be supported.

CDS-XML Interchanges:
All CDS-XML messages submitted must contain a CDS MESSAGE REFERENCE in both the CDS Message Header.

NHSCDS EDIFACT Interchanges:
All NHSCDS EDIFACT message submitted must contain a CDS MESSAGE REFERENCE in the EDIFACT UNH 0062 EDIFACT Message Reference Number data element. The same data element is also carried in the associated UNT Message Trailer Segment.
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
Not Applicable.
The CDS MESSAGE REFERENCE is generated and inserted into the NHSCDS EDIFACT message or the CDS-XML message as required.
 


top


CDS MESSAGE TYPE

Change to Data Element: New Data Element

CDS MESSAGE TYPE

Format/length: an6
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a mandatory data element and indicates the type of message within an Interchange.
Permitted values are:

CODE CLASSIFICATION
NHSCDS CDS Message

Usage:
Interchanges may contain multiple message of the same CDS MESSAGE TYPE and CDS MESSAGE TYPES must not be mixed within a single CDS Interchange.

CDS-XML Interchanges:
All CDS-XML messages submitted must contain a CDS MESSAGE TYPE

NHSCDS EDIFACT Interchanges:
The CDS MESSAGE TYPE is represented by the data value contained in the EDIFACT UNH S009 / 0065 EDIFACT Message Type data element which has an assigned value of "NHSCDS".
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
Not Applicable.
The CDS IGS message content is inferred by its association with the allocated value supplied in the IGS Header Record Identifier.
 


top


CDS MESSAGE VERSION NUMBER

Change to Data Element: New Data Element

CDS MESSAGE VERSION NUMBER

Format/length: an6
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a mandatory data element and reflects the version number of the message in use.
Message version numbers are updated as required during the on-going message development processes.
Permitted values are:

CODE CLASSIFICATION
NHS003 The 2000 / 2001 Specification
NHS004 The 2004 CDS-XML Specification

Usage:
Interchanges may only contain multiple messages of the same CDS MESSAGE VERSION NUMBER.
CDS MESSAGE VERSION NUMBERS must not be mixed within a single CDS Interchange.

CDS-XML Interchanges:
All XML messages submitted must contain a CDS MESSAGE VERSION NUMBER.

NHSCDS EDIFACT Interchanges:
The CDS MESSAGE VERSION NUMBER reflects the CDS Specification in use and is represented by the data value contained in the EDIFACT UNH S009 / 0057 EDIFACT Association Assigned Code data element.
The CDS MESSAGE VERSION NUMBER must be recorded in each CDS Message used in an Interchange. This is in addition to the CDS EDIFACT MESSAGE RELEASE NUMBER.
EDI gateway management and translation solution sets usually generate the required EDIFACT Service Segments (UNB, UNH, UNT, UNZ).

CDS INTERFACE GATEWAY SERVICE Interchanges:
Not Applicable.
The NHSCDS message version is inferred by its association with the allocated value supplied in the IGS Header Record Identifier and the IGS Translation Reference.
 

This data element is also known by these names:

Context Alias
plural CDS MESSAGE VERSION NUMBERS


top


CDS PRIME RECIPIENT IDENTITY

Change to Data Element: New Data Element

CDS PRIME RECIPIENT IDENTITY

Format/length: an5
HES item:
National Codes:
Default Codes:

Notes:

Definition:
See ORGANISATION CODE.
This is a mandatory 5-character NHS Organisation Code (or valid default code) representing the organisation determined to be the CDS PRIME RECIPIENT of the CDS Message as indicated in the CDS Addressing Grid detailed in the CDS HES Contextual

Usage:
The CDS PRIME RECIPIENT is, in most cases, identified as the 5-character Organisation Code of the Primary Care Trust of the Patient. In other specific circumstances, default codes are recommended as defined in the CDS HES Contextual
This is a mandatory data item crucial for the correct indexing of the database and must not be changed during the life of the associated CDS.
It does not identify the first or most important recipient of data, i.e. there is no inference of primacy of one recipient over another.
 


top


CDS PROTOCOL IDENTIFIER

Change to Data Element: New Data Element

CDS PROTOCOL IDENTIFIER

Format/length: n3
HES item:
National Codes:
Default Codes:

Notes:

Definition:
A code to identify the CDS Exchange Protocol and Update Mechanism associated with the transaction.

Permitted values are:

CODE CLASSIFICATION
010 Net Change Update Mechanism
020 Bulk Replacement Update Mechanism

Usage:
This is a mandatory data item for the processing of CDS data.
The rules for the derivation of the CDS Protocol Identifier are detailed in the NHS CDS Manual.
 


top


CDS RECORD IDENTIFIER

Change to Data Element: New Data Element

CDS RECORD IDENTIFIER

Format/length: an35
HES item:
National Codes:
Default Codes:

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

Definition:
When exchanging CDS data, this is an optional data element and when used is a unique number generated by the sender and inserted into the CDS data to enable senders and recipients to be able to cross-match and uniquely identify each and every CDS record.
The CDS-RID consists of the following components:

REF RID COMPONENT FORMAT CODES / VALUES
1 CDS SENDER IDENTITY an5 As generated in the CDS TRANSACTION HEADER GROUP BULK UPDATE
or the CDS TRANSACTION HEADER GROUP NET CHANGE
2 Not Used an2 Set = Blank
3 CDS INTERCHANGE CONTROL REFERENCE an14
(n7) *
As generated in the CDS INTERCHANGE HEADER
4 CDS MESSAGE REFERENCE an14
(n7) *
As generated in the CDS MESSAGE HEADER

* The NHSCDS EDIFACT Message configures this data item as an an14 format element, but a maximum user value of 9,999,999 is permitted in the format of n7.

Usage:
This item has been defined as a CDS data item to support the carrying of pseudonymised data in the CDS.
The CDS-RID is an an optional identity assigned to each record by the CDS sender to aid the identification and cross-referencing of data between the sender and the receiver(s) of the CDS data.

CDS-XML Interchanges:
The CDS-RID data element is carried in the CDS Message Header.

NHSCDS EDIFACT Interchanges:
The NHSCDS EDIFACT Message does not directly support this as an individual data item but the equivalent reference information may be generated and/or related to the data elements referenced in the chart above.

IGS Interchanges:
Applicable to CDS IGS processes.
 


top


CDS REPORT PERIOD END DATE

Change to Data Element: New Data Element

CDS REPORT PERIOD END DATE

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This data item defines the end date (for the date range of the data being exchanged) for the CDS Bulk Replacement Update time period.

Usage:
This is a mandatory data item when the CDS Bulk Replacement Update Mechanism is used. It is not required when the CDS Net Change Update Mechanism is used.
The CDS REPORT PERIOD END DATE must be a valid date and must not be before the CDS REPORT PERIOD START DATE.

CDS-XML Interchanges:
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.

NHSCDS EDIFACT Interchanges:
Used as a combined DATE/TIME element in the format CCYYMMDDHHMM. The time element is not used.
 


top


CDS REPORT PERIOD START DATE

Change to Data Element: New Data Element

CDS REPORT PERIOD START DATE

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This defines the start date (for the date range of the data being exchanged) for the Bulk Replacement Update time period. 

Usage:
This is a mandatory data item when the CDS Bulk Replacement Update Mechanism is used. It is not required when the CDS Net Change Update Mechanism is used.
The CDS REPORT PERIOD START DATE must be a valid date and cannot be after the CDS REPORT PERIOD END DATE.

CDS-XML Interchanges:
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.

NHSCDS EDIFACT Interchanges:
Used as a combined DATE/TIME element in the format CCYYMMDDHHMM. The time element is not used.
 


top


CDS SENDER IDENTITY

Change to Data Element: New Data Element

CDS SENDER IDENTITY

Format/length: an5
HES item:
National Codes:
Default Codes:


Notes:
This is the identity of the ORGANISATION acting as the Sender of a CDS submission and is represented by that Organisation's ORGANISATION CODE.

Definition:
See ORGANISATION CODE.

Usage:
The CDS SENDER IDENTITY is the mandatory 5-character NHS Organisation Code of the organisation acting as the physical Sender of CDS submissions.
The CDS Sender must make sure that the CDS extraction and submission facilities and processes differentiate correctly between:
· The ORGANISATION CODE (CDS SENDER IDENTITY) as carried in the CDS Transaction Header Group for every CDS,
and
· The ORGANISATION CODE (CODE OF PROVIDER) as carried in the Service Agreement details which are part of the Episode/Attendance details. 


top


CDS TEST INDICATOR

Change to Data Element: New Data Element

CDS TEST INDICATOR

Format/length: an1
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This optional data item enables the individual CDS message to be classified as a normal or a test transaction.
Permitted values are:

CODE CLASSIFICATION
T The CDS Message contains Test CDS data
Other The CDS Message contains production CDS data

Usage:
CDS data marked with a "T" in the CDS Test Indicator in the CDS Transaction Group Header will result in:
a) Delivery of the test marked CDS to the receiver as addressed;
b) The test-marked CDS will not be entered into the database;
c) Delivery of all other CDSs to the receiver as addressed;
d) All non-test marked CDSs will be entered into the database.
Production CDSs must not be marked as a TEST.
It is strongly recommended that Test and Production CDSs are not mixed in the same interchange.
A further test facility exists where the whole CDS Interchange is marked as TEST by setting the CDS INTERCHANGE TEST INDICATOR in the CDS Interchange Header.
Refer to the NHS CDS Manual for a detailed description of these processes.
 


top


CDS TYPE

Change to Data Element: New Data Element

CDS TYPE

Format/length: n3
HES item:
National Codes:
Default Codes:

Notes:

Definition:
A code to identify the CDS Exchange Protocol and Update Mechanism associated with the transaction.
Permitted values are:

CODE CLASSIFICATION
010 Net Change Update Mechanism
020 Bulk Replacement Update Mechanism

Usage:
This is a mandatory data element for the processing of CDS data.
 


top


CDS UNIQUE IDENTIFIER

Change to Data Element: New Data Element

CDS UNIQUE IDENTIFIER

Format/length: an35
HES item:
National Codes:
Default Codes:

Notes:

Definition:
A CDS data element providing a unique identity for the life-time of an episode carried in a CDS message.
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
Mandatory For all CDS Types
2 Provider Code an5 The NHS Organisation Code 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:
REF UID FORMAT CODES / VALUES COMMENT
1 NHS Organisation Code Type an1 A = Pre 1996 Organisation Code
B = Post 1996 NHS Organisation Code
Mandatory For all CDS Types
2 Provider Code an5 The NHS Organisation Code 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:

REF UID FORMAT CODES / VALUES COMMENT
1 NHS Organisation Code Type an1 A = Pre 1996 Organisation Code
B = Post 1996 NHS Organisation Code
Mandatory For all CDS Types
2 Provider Code an5 The NHS Organisation Code 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 End Of period census CDS Types with the same Admission List Entry. Mandatory for all EAL EOP 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:
This is a mandatory data item when the Net Change Update Mechanism is used and strongly recommended for use with the Bulk Replacement Update Mechanism.
1. Note that senders of CDS data remain directly responsible for the integrity of the CDS UID.
2. The first two components, the NHS Organisation Code Type and the Provider Code, are required for all CDS Types.
3. 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 the CDS UID across the NHS.
4. 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.

There are circumstances in PAS/CASEMIX application systems where the control of the UID key integrity may be suspect. These issues include:
a) Episode deletion (not resulting in a CDS deletion sent to the Commissioner);
b) Episode re-sequencing (not resulting in a corresponding CDS 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 ClearNET database. 

The NWCS User Guide contains further details regarding the management and use of the CDS UNIQUE IDENTIFIER.
 


top


CDS UPDATE TYPE

Change to Data Element: New Data Element

CDS UPDATE TYPE

Format/length: an1
HES item:
National Codes:
Default Codes:

Notes:

Definition:
A code to indicate the required database update process for the submitted CDS Message.
Permitted values are:

CODE CLASSIFICATION
1 To indicate a CDS Deletion or Cancellation
9 To indicate a CDS Original or Replacement

Usage:
This is a mandatory data item when using the Net Change Update Mechanism. It is not required when using the Bulk Replacement Update Mechanism.
 


top


DETAINED AND (OR) LONG TERM PSYCHIATRIC CENSUS DATE

Change to Data Element: Change to Description
Format/length: see DATE
HES item: CENDATE
National Codes:
Default Codes:

Notes:
The year in which, on 31 March, the Psychiatric Census of detained and/or long-term PATIENTS is held. This data item is held in the CDS Transaction Header Group as CENSUS DATE. The date at which, on 31 March, the Psychiatric Census of detained and/or long-term PATIENTS is held. 

This data element is also known by these names:

Context Alias
plural DETAINED AND (OR) LONG TERM PSYCHIATRIC CENSUS DATES


top


DIAGNOSIS SCHEME IN USE

Change to Data Element: Change to Description
Format/length: n3
Format/length: an2
HES item:
National Codes:
Default Codes:

Notes:

Definition:
A value to identify the diagnosis scheme in use and corresponds to the NHSCDS EDIFACT Message data element 1131 as defined in the NHS CDS Manual, Chapter B5. This is used in the Clinical Information Group of the CDS to denote the scheme basis of a Diagnosis. 

This is used in the Clinical Information Group of several CDS Types to denote the scheme basis of the Diagnosis which can be: Permitted values are:

CODE NHSCDS EDIFACT CODE DESCRIPTION
01 704 Accident & Emergency Diagnosis
02 872 ICD-10
03 901 Read Version 1 (READ 4)
04 921 Read Version 2 (READ 5)
05 941 Read Version 3.0

Read Version 3.1 is not supported in the CDS.

CDS-XML Message:
* Accident & Emergency Diagnosis

The CDS-XML codes as specified above must be used. NHSCDS EDIFACT Message:
* ICD-10

In the NHSCDS EDIFACT Message the value used to identify the DIAGNOSIS SCHEME IN USE is carried the EDIFACT data element 1131 as defined in the NHS CDS Manual, Chapter B.
Where necessary, EDI gateway management and translation software must interpret these code sets when interfacing to the NHSCDS EDIFACT Message.
* Read Version 1 (Read 4)

* Read Version 2 (Read 5)
* Read Version 3.0

Read Version 3.1 is not supported in the CDS. 

This data element is also known by these names:

Context Alias
plural DIAGNOSIS SCHEME IN USES
plural DIAGNOSIS SCHEMES IN USE


top


INVESTIGATION SCHEME IN USE

Change to Data Element: Change to Aliases
Format/length:
Format/length: an2
HES item:
National Codes:
Default Codes:


Notes:
As for data item note PROCEDURE SCHEME IN USE.   Definition:
This is used in the Clinical Activity Group of the CDS to denote the scheme basis of an investigation. 

Permitted values are:

CODE NHSCDS EDIFACT CODE DESCRIPTION
01 705 Accident & Emergency Investigation

CDS-XML Message:
The CDS-XML codes as specified above must be used.

NHSCDS EDIFACT Message:
In the NHSCDS EDIFACT Message the value used to identify the INVESTIGATION SCHEME IN USE is carried the EDIFACT data element 1131.
Where necessary, EDI gateway management and translation software must interpret these code sets when interfacing to the NHSCDS EDIFACT Message.

This data element is also known by these names:

Context Alias
plural INVESTIGATION SCHEME IN USES
plural INVESTIGATION SCHEMES IN USE


top


LOCATION CLASS

Change to Data Element: Change to Description
Format/length: an2
HES item:
National Codes:
Default Codes:


Notes:
A classification for use within CDS messages of the physical location within which the recorded patient event occurs.

CODE NHSCDS EDIFACT CODE CLASSIFICATION
01 701 Health Site (General Occurrence)
02 702 Home
03 703 Delivery Place
04 704 Health site at the start of Health Care Activity
05 705 Health site at the end of Health Care Activity

CDS-XML Message:
The CDS-XML codes as specified above must be used.

NHSCDS EDIFACT Interchanges:
01 Health Site (General Occurrence)

This data element was originally a NHSCDS EDIFACT Message Qualifier with permitted values as detailed in the NHS CDS Manual.
02 Home
03 Delivery Place
04 Health site at the start of Health Care Activity
05 Health site at the end of Health Care Activity
  Where necessary EDI gateway management and translation solution sets must interpret these code sets when interfacing to the NHSCDS EDIFACT Message.

This data element is also known by these names:

Context Alias
plural LOCATION CLASS


top


MHMDS CONTROL NUMBER

Change to Data Element: New Data Element

MHMDS CONTROL NUMBER

Format/length: n7
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a mandatory data element and is a number, sequentially incremented, each time a file is generated for the MHMDS IGS (0000000 is not acceptable).

Usage:
For each MHMDS file the MHMDS CONTROL NUMBER is assigned to provide a unique identity.
Wrap around from 9999999 to 1 must be supported.
This data element is populated by the MHMDS Assembler program. 
 


top


MHMDS DATE CREATED

Change to Data Element: New Data Element

MHMDS DATE CREATED

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is the date when the MHMDS File was created.

Usage:
This is a mandatory data element when submitting the MHMDS.
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.
This data element is populated by the MHMDS Assembler program.
 


top


MHMDS DESTINATION IDENTIFICATION

Change to Data Element: New Data Element

MHMDS DESTINATION IDENTIFICATION

Format/length: an35
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is the EDI Address of the Recipient.
In practice, an EDI Address is 15 characters in length

Usage:
This is a mandatory data element when sending MHMDS.
This data element is populated by the MHMDS Assembler program.
 


top


MHMDS HEADER RECORD IDENTIFIER

Change to Data Element: New Data Element

MHMDS HEADER RECORD IDENTIFIER

Format/length: an9
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a text literal used to identify the MHMDS Header Record. A default value of "MHHDRnnnn" must be used.
"nnnn" = the Assembler Version Number.

Usage:
This is a mandatory data element when submitting the MHMDS.
This data element is populated by the MHMDS Assembler program.
 


top


MHMDS IGS TRANSLATION REFERENCE

Change to Data Element: New Data Element

MHMDS IGS TRANSLATION REFERENCE

Format/length: an7
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This identifies the IGS (Interface Gateway Service) translation map required to process the submitted application format file input to a pre-determined translation process for the MHMDS data File.

Usage:
This is a mandatory data element when submitting MHMDS files.
The authorised definition of values for this data field is contained in the NWCS User Guide 


top


MHMDS RECORD COUNT

Change to Data Element: New Data Element

MHMDS RECORD COUNT

Format/length: n7
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a mandatory data element and is a count of records contained in the MHMDS file, including the IGS (Interface Gateway Service) Header and the IGS Trailer records.

Usage:
This data element is populated by the MHMDS Assembler program.
Recipients of MHMDS data are advised to recount and match this control count to ensure all records submitted are received.
 


top


MHMDS RECORD IDENTIFER

Change to Data Element: New Data Element

MHMDS RECORD IDENTIFER

Format/length: an35
HES item:
National Codes:
Default Codes:

Notes:

Notes:
This may also be referred to as the MHMDS-RID.

Definition:
This is a unique number generated and inserted into the MHMDS data and may be used to enable a recipient to uniquely identify each and every MHMDS record.
The MHMDS-RID consists of the following components:

REF RID COMPONENT FORMAT CODES / VALUES
1 MHMDS SOURCE IDENTIFICATION an5 As generated in the MHMDS HEADER STRUCTURE of the
Mental Health Minimum Data Set
2 Not Used an2 Set = Blank
3 MHMDS CONTROL NUMBER an14
(n7) *
As generated in the MHMDS HEADER STRUCTURE of the
Mental Health Minimum Data Set
4 MHMDS RECORD NUMBER an14
(n7) *
A sequentially incremented number starting at zero, incremented for each and every MHMDS record within an individual MHMDS file.
* A maximum value of 9,999,999 (per individual file) is permitted.

Usage:
Where required, users of MHMDS data must establish their own procedures for recording and using the MHMDS Record Identifier.
 


top


MHMDS RECORD NUMBER

Change to Data Element: New Data Element

MHMDS RECORD NUMBER

Format/length: n7
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a mandatory data element, starting at 1 and is a sequentially incremented number for each record within an individual MHMDS file.
A maximum value of 9999999 is supported.
The number must be reset for each new MHMDS file.

Usage:
For each record within an MHMDS file the MHMDS RECORD NUMBER is assigned to provide a unique identity (within that file).


top


MHMDS SOURCE IDENTIFICATION

Change to Data Element: New Data Element

MHMDS SOURCE IDENTIFICATION

Format/length: an35
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is the EDI Address of the Sender.
In practice, an EDI Address is 15 characters in length must be used to comply with NHS EDI requirements.

Usage:
This is a mandatory data element when sending an MHMDS.
This data element is input via the MHMDS Assembler program.
 


top


MHMDS TEST INDCATOR

Change to Data Element: New Data Element

MHMDS TEST INDCATOR

Format/length: an1
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is indicates whether the MHMDS is a production or test file.

CODE CLASSIFICATION
0 (zero) The whole MHMDS Interchange contains live (production) data and will be stored in the national database.
1 The whole MHMDS Interchange contains test data and will not be stored in the national database.

Usage:
This test facility enables interchanges submitted to be marked and therefore processed as TEST or PRODUCTION data.
The data ia mandatory and must be completed.

CDS-XML Interchanges:
All XML interchanges submitted must contain a MHMDS TEST INDICATOR.

MHMDS-CDS INTERFACE GATEWAY SERVICE Interchanges:
The MHMDS TEST INDICATOR is represented by the data value contained in the Test Indicator data field as defined in the CDS Interface Gateway Service Control record and shown above.
The authorised source of this definition is contained in the NWCS User Guide.


top


MHMDS TIME CREATED

Change to Data Element: New Data Element

MHMDS TIME CREATED

Format/length: See TIME
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is the time when the MHMDS File was created.

Usage:
This is a mandatory data element when submitting the MHMDS.
Used in the NHS standard format which is the e-GIF compliant format of HH:MM:SS (and an optional.sss).
This data element is populated by the MHMDS Assembler program.
 


top


MHMDS TRAILER RECORD IDENTIFIER

Change to Data Element: New Data Element

MHMDS TRAILER RECORD IDENTIFIER

Format/length: an9
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This is a text literal used to identify the MHMDS Trailer Record. 
A default value of "MHMDSTLR*" must be used, where * has a value = space.

Usage:
This is a mandatory data element when submitting The MHMDS. 
This data element is populated by the MHMDS Assembler program.
 


top


MHMDS TRANSLATION REFERENCE

Change to Data Element: New Data Element

MHMDS TRANSLATION REFERENCE

Format/length: an7
HES item:
National Codes:
Default Codes:

Notes:

Definition:
A value allocated by the IINTERFACE GATEWAY SERVICE (IGS) provider to identify the particular IGS translator map to be used for this submission.

Usage:
This is a mandatory data element when submitting MHMDS. 
This data element is populated by the MHMDS Assembler program.
 


top


ORGANISATION CODE TYPE CDS COPY RECIPIENT

Change to Data Element: New Data Element

ORGANISATION CODE TYPE CDS COPY RECIPIENT

Format/length: See ORGANISATION CODE TYPE
HES item:
National Codes:
Default Codes:


Notes:
This is the ORGANISATION CODE TYPE of the CDS COPY RECIPIENT IDENTITY. 


top


ORGANISATION CODE TYPE CDS PRIME RECIPIENT

Change to Data Element: New Data Element

ORGANISATION CODE TYPE CDS PRIME RECIPIENT

Format/length: See ORGANISATION CODE TYPE
HES item:
National Codes:
Default Codes:

Notes:
This is the ORGANISATION CODE TYPE of the CDS PRIME RECIPIENT IDENTITY.
 


top


ORGANISATION CODE TYPE CDS SENDER IDENTITY

Change to Data Element: New Data Element

ORGANISATION CODE TYPE CDS SENDER IDENTITY

Format/length: See ORGANISATION CODE TYPE
HES item:
National Codes:
Default Codes:

Notes:
This is the ORGANISATION CODE TYPE of the CDS SENDER IDENTITY.
 


top


PROCEDURE SCHEME IN USE

Change to Data Element: Change to Aliases
Format/length: n3
Format/length: an2
HES item:
National Codes:
Default Codes:

Notes:
Notes:

Definition:
A value to identify the procedure scheme in use and corresponds to the NHSCDS EDIFACT Message data element 1131 as defined in the NHS CDS Manual, Chapter B5. This is used in the Clinical Activity Group of the CDS to denote the scheme basis of an Intervention, Operation or A&E Treatment. 

This is used in the Clinical Information Group of several CDS Types to denote the scheme basis of Operation Procedures, A&E Investigations and A&E Treatments which can be:

Permitted values are:

* Accident & Emergency Investigation
CODE NHSCDS EDIFACT CODE DESCRIPTION
01 706 Accident & Emergency Treatment
02 822 OPCS-4
03 901 Read Version 1 (READ 4)
04 921 Read Version 2 (READ 5)
05 941 Read Version 3.0

Read Version 3.1 is not supported in the CDS.

CDS-XML Message:
* Accident & Emergency Treatment

The CDS-XML codes as specified above must be used.
NHSCDS EDIFACT Message:
* OPCS-4

In the NHSCDS EDIFACT Message the value used to identify the PROCEDURE SCHEME IN USE is carried in the EDIFACT data element 1131 as defined in the NHS CDS Manual, Chapter B. Where necessary, EDI gateway management and translation software must interpret these code sets when interfacing to the NHSCDS EDIFACT Message.
* Read Version 1 (Read 4)

* Read Version 2 (Read 5)
* Read Version 3.0

Read Version 3.1 is not supported in the CDS. 

This data element is also known by these names:

Context Alias
plural PROCEDURE SCHEME IN USES
plural PROCEDURE SCHEMES IN USE


top


REPORTING PERIOD END DATE MENTAL HEALTH

Change to Data Element: New Data Element

REPORTING PERIOD END DATE MENTAL HEALTH

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This data element defines the end date (for the date range of the data being exchanged) for the MHMDS time period.

Usage:
This is a mandatory data item when the MHMDS data is being submitted. 
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.
The REPORTING PERIOD END DATE MENTAL HEALTH must be a valid date and must not be before the REPORTING PERIOD START DATE MENTAL HEALTH. 


top


REPORTING PERIOD START DATE MENTAL HEALTH

Change to Data Element: New Data Element

REPORTING PERIOD START DATE MENTAL HEALTH

Format/length: See DATE
HES item:
National Codes:
Default Codes:

Notes:

Definition:
This data element defines the start date (for the date range of the data being exchanged) for the MHMDS time period.

Usage:
This is a mandatory data item when the MHMDS data is being submitted. 
Used in the NHS standard format which is the e-GIF compliant format of CCYY-MM-DD.
The REPORTING PERIOD START DATE MENTAL HEALTH must be a valid date and must not be after the REPORTING PERIOD END DATE MENTAL HEALTH. 


top


CDS INTERCHANGE HEADER

Change to Data Set (CDS, CMDS, HES): New Data Set (CDS, CMDS, HES)

CDS INTERCHANGE HEADER

CDS INTERCHANGE HEADER
CDS Interchanges submitted or received must use the correct CDS Header and Trailer Controls to provide Interchange and Message addressing and identification.

Every CDS Interchange must consist of:
CDS INTERCHANGE HEADER - Mandatory - One per CDS Interchange
CDS MESSAGE HEADER - Mandatory - One per CDS Message
CDS MESSAGE DATA - As defined for the specific CDS Type
CDS MESSAGE TRAILER - Mandatory - One per CDS Message
CDS INTERCHANGE TRAILER - Mandatory - One per CDS Interchange

Multiple CDS messages are usually sent in a single CDS Interchange.
Multiple CDS Interchanges may be sent in a single network transport session.

The CDS Interchange Header defines identity and addressing information for the CDS.

Opt Data Element Note
M CDS INTERCHANGE SENDER IDENTITY  
M CDS INTERCHANGE RECEIVER IDENTITY  
M CDS INTERCHANGE CONTROL REFERENCE  
M CDS INTERCHANGE DATE OF PREPARATION  
M CDS INTERCHANGE TIME OF PREPARATION  
M CDS INTERCHANGE APPLICATION REFERENCE  
O CDS INTERCHANGE TEST INDICATOR  

top


CDS INTERCHANGE TRAILER

Change to Data Set (CDS, CMDS, HES): New Data Set (CDS, CMDS, HES)

CDS INTERCHANGE TRAILER

CDS INTERCHANGE TRAILER

CDS Interchanges submitted or received must use the correct CDS Header and Trailer Controls to provide Interchange and Message addressing and identification.

Every CDS Interchange must consist of:
CDS INTERCHANGE HEADER - Mandatory - One per CDS Interchange
CDS MESSAGE HEADER - Mandatory - One per CDS Message
CDS MESSAGE DATA - As defined for the specific CDS Type
CDS MESSAGE TRAILER - Mandatory - One per CDS Message
CDS INTERCHANGE TRAILER - Mandatory - One per CDS Interchange

Multiple CDS messages are usually sent in a single CDS Interchange.
Multiple CDS nterchanges may be sent in a single network transport session.

The CDS Interchange Trailer signifies the end of a CDS Interchange and contains control information for the Interchange.

Opt Data Element Note
M CDS INTERCHANGE CONTROL REFERENCE  
M CDS INTERCHANGE CONTROL COUNT  
O CDS INTERCHANGE SENDER IDENTITY  
O CDS INTERCHANGE RECEIVER IDENTITY  

top


CDS MESSAGE HEADER

Change to Data Set (CDS, CMDS, HES): New Data Set (CDS, CMDS, HES)

CDS MESSAGE HEADER

CDS MESSAGE HEADER
CDS Interchanges submitted or received must use the correct CDS Header and Trailer Controls to provide Interchange and Message addressing and identification.

Every CDS Interchange must consist of:
CDS INTERCHANGE HEADER - Mandatory - One per CDS Interchange
CDS MESSAGE HEADER - Mandatory - One per CDS Message
CDS MESSAGE DATA - As defined for the specific CDS Type
CDS MESSAGE TRAILER - Mandatory - One per CDS Message
CDS INTERCHANGE TRAILER - Mandatory - One per CDS Interchange

Multiple CDS messages are usually sent in a single CDS Interchange.
Multiple CDS Interchanges may be sent in a single network transport session.

The CDS MESSAGE HEADER signifies the start of each CDS Message and contains control information for the Message.

Opt Data Element Note
M CDS MESSAGE TYPE  
M CDS MESSAGE VERSION NUMBER  
M CDS MESSAGE REFERENCE  

top


CDS MESSAGE TRAILER

Change to Data Set (CDS, CMDS, HES): New Data Set (CDS, CMDS, HES)

CDS MESSAGE TRAILER

CDS MESSAGE TRAILER
CDS Interchanges submitted or received must use the correct CDS Header and Trailer Controls to provide Interchange and Message addressing and identification.

Every CDS Interchange must consist of:
CDS INTERCHANGE HEADER - Mandatory - One per CDS Interchange
CDS MESSAGE HEADER - Mandatory - One per CDS Message
CDS MESSAGE DATA - As defined for the specific CDS Type
CDS MESSAGE TRAILER - Mandatory - One per CDS Message
CDS INTERCHANGE TRAILER - Mandatory - One per CDS Interchange

Multiple CDS messages are usually sent in a single CDS Interchange.
Multiple CDS Interchanges may be sent in a single network transport session.

The CDS Message Trailer signifies the end of a CDS Message and contains control information for the Message.

Opt Data Element Note
M NO OF SEGMENTS IN MESSAGE (NHSCDS EDIFACT Message only)  
M CDS MESSAGE REFERENCE  

top


CDS TRANSACTION HEADER GROUP BULK UPDATE

Change to Data Set (CDS, CMDS, HES): New Data Set (CDS, CMDS, HES)

CDS TRANSACTION HEADER GROUP BULK UPDATE

CDS TRANSACTION HEADER GROUP BULK UPDATE
Every CDS submitted or received must include a CDS Transaction Header Group which is used to carry CDS identification and addressing data and the data indicating the specific use of one of the Update Mechanisms of the CDS Exchange Protocol.

All CDS Types using the CDS Bulk Replacement Update Mechanism of the CDS Exchange Protocol must begin with this mandatory Data Group.

Note:
1. The CDS UNIQUE IDENTIFIER may be provided as an optional data item when using the Bulk Update Protocol.
In all cases, care must be taken to ensure that the value generated for the CDS UNIQUE IDENTIFIER is unique across all NHS organisations by prefixing the locally maintained value with an NHS Organisation Code, usually that of the originator of the data.
2. For CDS Type 170, the Detained and/or Long Term Psychiatric Census, the CDS CENSUS DATE is mandatory and contains the DETAINED AND/OR LONG TERM PSYCHIATRIC CENSUS DATE.
3. For the following CDS Types, the CDS CENSUS DATE is mandatory and must contain the DATE OF ELECTIVE ADMISSION LIST CENSUS:
CDS Type 030 Elective Admission List End of Period Census (Standard)
CDS Type 040 Elective Admission List End of Period Census (Old)
CDS Type 050 Elective Admission List End of Period Census (New)
4. There may be up to 7 CDS COPY RECIPIENT IDENTITY occurrences specified.

Opt CDS data element Note
M CDS TYPE  
M CDS PROTOCOL IDENTIFIER  
M CDS UNIQUE IDENTIFIER 1
M CDS BULK REPLACEMENT GROUP  
O CDS TEST INDICATOR  
M CDS CENSUS DATE 2,3
M CDS EXTRACT DATE  
M CDS EXTRACT TIME  
M CDS REPORT PERIOD START DATE  
M CDS REPORT PERIOD END DATE  
M CDS SENDER IDENTITY 2,3
M ORGANISATION CODE TYPE  
M CDS PRIME RECIPIENT IDENTITY  
M ORGANISATION CODE TYPE  
O CDS COPY RECIPIENT IDENTITY 4
O ORGANISATION CODE TYPE  

top


CDS TRANSACTION HEADER GROUP NET CHANGE

Change to Data Set (CDS, CMDS, HES): New Data Set (CDS, CMDS, HES)

CDS TRANSACTION HEADER GROUP NET CHANGE

CDS TRANSACTION HEADER GROUP NET CHANGE
Every CDS submitted or received must include a CDS Transaction Header Group which is used to carry CDS identification and addressing data and the data indicating the specific use of one of the Update Mechanisms of the CDS Exchange Protocol.

All CDS Types using the CDS Net Change Update Mechanism of the CDS Exchange Protocol must begin with this mandatory Data Group.

Note:
1. The CDS UNIQUE IDENTIFIER must be provided as a mandatory data item when using the Net Change Protocol.
In all cases, care must be taken to ensure that the value generated for the CDS UNIQUE IDENTIFIER is unique across all NHS organisations by prefixing the locally maintained value with an NHS Organisation Code, usually that of the originator of the data.
2. For CDS Type 170, the Detained and/or Long Term Psychiatric Census, the CDS CENSUS DATE is mandatory and contains the DETAINED AND/OR LONG TERM PSYCHIATRIC CENSUS DATE.
3. For the following CDS Types, the CDS CENSUS DATE is mandatory and must contain the DATE OF ELECTIVE ADMISSION LIST CENSUS:
CDS Type 030 Elective Admission List End of Period Census (Standard)
CDS Type 040 Elective Admission List End of Period Census (Old)
CDS Type 050 Elective Admission List End of Period Census (New)
4. There may be up to 7 CDS COPY RECIPIENT IDENTITY occurrences specified.

Opt CDS data element Note
M CDS TYPE  
M CDS PROTOCOL IDENTIFIER  
M CDS UNIQUE IDENTIFIER 1
M CDS UPDATE TYPE  
O CDS TEST INDICATOR  
M CDS APPLICABLE DATE  
M CDS APPLICABLE TIME  
M CDS CENSUS DATE 2,3
M CDS SENDER IDENTITY  
M ORGANISATION CODE TYPE  
M CDS PRIME RECIPIENT IDENTITY  
M ORGANISATION CODE TYPE  
O CDS COPY RECIPIENT IDENTITY 4
O ORGANISATION CODE TYPE  

top


CDS TYPE LIST NAVIGATION

Change to Supporting Information: Change to Supporting Information

CDS Interchange and Message Controls:

CDS Transaction Header Group:

Accident and Emergency CDS Type List:


Admitted Patient Care CDS Type List:


Out-patient Attendance CDS Type List:


Ward Attendance CDS Type List:


top


Irvine Webb