Change Request
 

NHS Connecting for Health

NHS Data Model and Dictionary Service

Reference: Change Request 1064
Version No:1.0
Subject:Update to CR901
Effective Date:Immediate
Reason for Change:Patch
Publication Date:16 April 2009

Background:

This patch updates the NHS Data Model and Dictionary following the incorporation of CR901 "Removal of references to EDIFACT and the NHS Wide Clearing Service (NWCS)".

It removes all remaining references to NWCS and incorrect references to EDIFACT

Summary of changes:

Supporting Information
COMMISSIONING DATA SET MESSAGE SCHEMA VERSIONS   Changed Description
NHS TRUST MERGERS   Changed Description
PAEDIATRIC CRITICAL CARE MINIMUM DATA SET OVERVIEW   Changed Description
 
Data Elements
CDS INTERCHANGE INTERFACE GATEWAY SERVICE REFERENCE (RETIRED) renamed from CDS INTERCHANGE INTERFACE GATEWAY SERVICE REFERENCE   Changed status to Retired, Name
PERSON FULL NAME   Changed Description
PERSON NAME SUFFIX   Changed Description
POSTCODE OF USUAL ADDRESS   Changed Description
SEX (BABY)   Changed Description
 
Packages
CDS   New Package
 

Date:16 April 2009
Sponsor:Richard Kavanagh, NHS Connecting for Health

Note: New text is shown with a blue background. Deleted text is crossed out. 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 MESSAGE SCHEMA VERSIONS

Change to Supporting Information: Changed Description

The following tables set out the authorised versions of the Commissioning Data Set. 

Commissioning Data Set Version 6

The Commissioning Data Set Version 6 derivatives consists of several components identified in the CDS Version CDS006 Type List.

CDS
Version
 
Available
From
 
Mandated
From
 
Usable
To
 
Message
Format
 
Message
Version
 
CDS00601/04/200801/04/2009-XML Schema

CDS-XML-Message-Schema-V6-1-2008-04-01
and 
CDS-XML-Message-Documentation-V6-1-2008-04-01
and
CDS-XML-Message-Release-Notes-V6-1-2008-04-01

CDS00614/01/200814/01/2008-XML Schema

CDS-XML-Message-Schema-V6-0-2008-01-14 
and 
CDS-XML-Message-Documentation-V6-0-2008-01-14
and
CDS-XML-Message-Release-Notes-V6-0-2008-01-14

CDS00631/12/200701/04/2008Superceded before live useXML Schema

Message Schema V6.0-2007-10-26
and
CDS XML Message Documentation V6-0-2007-10-26
and
CDS XML Release Notes V6-0-2007-10-26

CDS00631/12/200701/04/2008Superceded before live useXML SchemaMessage Schema v6.0-2007-03-01
and
CDS XML Message Documentation V6-0-2007-03-01

Commissioning Data Set Version 5Commissioning Data Set Version 5
The Commissioning Data Set Version NHS005 consists of several components identified in the CDS Version NHS005 Type List.The Commissioning Data Set Version NHS005 consists of several components identified in the
CDS Version NHS005 Type List.

CDS
Version
 
Available
From
 
Mandated
From
 
Usable
To
 
Message
Format
 
Message
Version
 
CDS
Version
 
Available
From
 
Mandated
From
 
Usable
To
 
Message
Format
 
Message
Version
 
NHS00501/10/200701/10/200731/03/2009XML SchemaMessage Schema v5-0-2007-06-01 and Message Documentation v5-0-2007-06-01 
NHS00501/09/200606/11/200601/10/2007XML SchemaMessage Schema v5-0-2006-08-04 and Message Documentation v5-0-2006-08-04 
NHS00501/04/200601/09/2006Superceded before live useXML SchemaV-5-0 schema and documentation 
NHS00501/10/200701/10/200731/03/2009XML SchemaMessage Schema v5-0-2007-06-01 and Message Documentation v5-0-2007-06-01 
NHS00501/09/200606/11/200601/10/2007XML SchemaMessage Schema v5-0-2006-08-04 and Message Documentation v5-0-2006-08-04 
NHS00501/04/200601/09/2006Superceded before live useXML SchemaV-5-0 schema and documentation 

Commissioning Data Set Version 5-0-2007-06-01 is backward compatible with CDS Version 5-0-2006-08-04.Commissioning Data Set Version 5-0-2007-06-01 is backward compatible with CDS Version 5-0-2006-08-04. Any data conforming with Commissioning Data Set Version 5-0-2006-08-04 conforms with Commissioning Data Set Version 5-0-2007-06-01. Commissioning Data Set Version 5-0-2006-08-04 includes all standards updates to DSCN 14/2005. In addition In addition

  • value 8 has been included in the enumeration for ADMISSION OFFER OUTCOME to correct an error in Commissioning Data Set Version 5-0-2006-08-04
  • value 3 has been included in the enumeration for PRIORITY TYPE - DSCN 13/2006
  • values 304, 371, 401, 812 and 840 have been included in the enumeration for TREATMENT FUNCTION CODE - DSCN 02/2007
  • values 12, 13,14,15,16, 17 and 97 have been included in the enumeration for SOURCE OF REFERRAL FOR OUT-PATIENTS - DSCN 16/2007. Code 8 'Other', which is retired in DSCN 16/2007, has been retained in Commissioning Data Set Version 5-0-2007-06-01 for backward compatibility.
  • value 8 has been included in the enumeration for ADMISSION OFFER OUTCOME to correct an error in Commissioning Data Set Version 5-0-2006-08-04
  • value 3 has been included in the enumeration for PRIORITY TYPE - DSCN 13/2006
  • values 304, 371, 401, 812 and 840 have been included in the enumeration for TREATMENT FUNCTION CODE - DSCN 02/2007
  • values 12, 13,14,15,16, 17 and 97 have been included in the enumeration for SOURCE OF REFERRAL FOR OUT-PATIENTS - DSCN 16/2007. Code 8 'Other', which is retired in DSCN 16/2007, has been retained in Commissioning Data Set Version 5-0-2007-06-01 for backward compatibility.
The major enhancement is the inclusion of DSCNs 02/2005 and 13/2005 which introduce the Critical Care Minimum Data Set as an integral component of the Commissioning Data Set. The implementation of this version will therefore enable Trusts to submit the Critical Care Minimum Data Set to the Secondary Uses Service.The major enhancement is the inclusion of DSCNs 02/2005 and 13/2005 which introduce the Critical Care Minimum Data Set as an integral component of the Commissioning Data Set. The implementation of this version will therefore enable Trusts to submit the Critical Care Minimum Data Set to the Secondary Uses Service.

V-5-0-2006-08-04 corrects an error in V-5-0 in the definition of the data type supporting CRITICAL CARE UNIT FUNCTION and restricts the length of CRITICAL CARE LOCAL IDENTIFIER to 8 characters.V-5-0-2006-08-04 corrects an error in V-5-0 in the definition of the data type supporting CRITICAL CARE UNIT FUNCTION and restricts the length of CRITICAL CARE LOCAL IDENTIFIER to 8 characters.

Commissioning Data Set Versions 3 and 4 - These Version have been withdrawn (November 2007).
Commissioning Data Set Versions 3 and 4 - These Versions have been withdrawn (November 2007).
CDS
Version
 
Available
From
 
Mandated
From
 
Usable
To
 
Message
Format
 
Message
Version
 
NHS00401/10/2005Only for NWCS-SUS migrationXML SchemaV-4-2-a

This Commissioning Data Set version was released to support the initial implementation of the CDS-XML processes submitting data to the Secondary Uses Service and must be used only for migration.

CDS
Version
 
Available
From
 
Mandated
From
 
Usable
To
 
Message
Format
 
Message
Version
 
NHS0032001200131 March 2007UN/EDIFACTCDSM - MIG V4

top


NHS TRUST MERGERS

Change to Supporting Information: Changed Description


Introduction
  1. This guidance explains the circumstances under which Hospital Provider Spells should close and reopen as a result of a merger or demerger, in terms of NHS data standards. It specifies which codes should be used for those Hospital Provider Spells which must be closed and reopened,

    Note that the NHS-wide Clearing Service (NWCS) has also issued Guidance Note NWCS/GN-003 which explains the use of NWCS Exchange Protocols when NHS Trusts merge.

  2. This guidance explains the circumstances under which Hospital Provider Spells should close and reopen as a result of a merger or demerger, in terms of NHS data standards. It specifies which codes should be used for those Hospital Provider Spells which must be closed and reopened,
When Hospital Provider Spells Should be Closed and Reopened
  1. A Hospital Provider Spell is provided by one ORGANISATION acting as a Health Care Provider. This means that the spell is linked to the ORGANISATION CODE of the provider. If the ORGANISATION CODE changes, the spell must end and another begin with the new ORGANISATION CODE. If the spell does end, the Consultant Episode (Hospital Provider) within the spell must also end.

    The following scenarios explain what this means in terms of NHS Trust mergers or demergers. Note that these assume that nothing changes other than the fact that the NHS Trusts merge or demerge, e.g. the CONSULTANT stays the same, etc.

Mergers
  1. Trust A merges with Trust B to produce Trust C, which has a new ORGANISATION CODE. The ORGANISATION CODE will change for both Trust A and B. Therefore Hospital Provider Spells in both Trust A and B should close, and new spells should be opened using the new ORGANISATION CODE for Trust C.
  2. Trust A merges with Trust B to produce an ORGANISATION which uses Trust A's ORGANISATION CODE. For those Hospital Provider Spells in Trust A, the ORGANISATION CODE will not change. Therefore Trust A's Hospital Provider Spells should not be closed just as a result of the merger. However, for Trust B the ORGANISATION CODE will change. Therefore Hospital Provider Spells in Trust B should close, and new spells should be opened using the new ORGANISATION CODE for Trust A.
Demergers
  1. Trust A splits into Trust B and Trust C, both of which have a new ORGANISATION CODE. The ORGANISATION CODE will change for both Trust B and C. Therefore all Hospital Provider Spells in Trust A should close, and new spells should be opened in Trust B and C using the new ORGANISATION CODES for each.
  2. Trust A splits into Trust B and C. Trust B retains Trust A's ORGANISATION CODE and Trust C is issued with a new one. The ORGANISATION CODE for Hospital Provider Spells in Trust A which are taken over by Trust B will not change. Therefore they should not be closed just as a result of the merger. However, Trust A's Hospital Provider Spells which are taken over by Trust C should close, and new spells should be opened using the new ORGANISATION CODE for Trust C.
The Codes Used when Hospital Provider Spells are Closed and Reopened
  1. If Hospital Provider Spells are to be closed and reopened only as a result of NHS Trust mergers or demergers, for most cases the codes below should be used.
    1. If Hospital Provider Spells are to be closed and reopened only as a result of NHS Trust Mergers or demergers, for most cases the codes below should be used.
    The CLOSED Hospital Provider Spell

    DISCHARGE DESTINATIONS

    This depends on the type of WARD the PATIENT is in, but will be either:

    51     NHS Hospital Provider - WARD for general PATIENTS or the younger physically disabled

    52     NHS Hospital Provider - WARD for maternity PATIENTS or neonates

    53     NHS Hospital Provider - WARD for PATIENTS who are mentally ill or have learning disabilities

    DISCHARGE METHOD

    1     PATIENT discharged on clinical advice or with clinical consent

    The REOPENED Hospital Provider Spell

    ADMISSION METHOD

    81     Transfer of any admitted PATIENT from other Hospital Provider other than in an emergency

    Note that this ADMISSION METHOD is classed under "Other Admission". It is not elective and the PATIENT does therefore not have an entry on an Elective Admission List.
    SOURCE OF ADMISSION

    Again, this depends on the type of WARD the PATIENT is in, but will be either:

    51     NHS Hospital Provider - WARD for general PATIENTS or the younger physically disabled or Accident And Emergency Department

    52     NHS Hospital Provider - WARD for maternity PATIENTS or neonates

    53     NHS Hospital Provider - WARD for PATIENTS who are mentally ill or have learning disabilities

    REFERRER CODE

    This will be the referrer to the Hospital Provider Spell within which the PATIENT was receiving care before the merger, i.e. the "original" Hospital Provider Spell.

top


PAEDIATRIC CRITICAL CARE MINIMUM DATA SET OVERVIEW

Change to Supporting Information: Changed Description

Introduction

The Paediatric Critical Care Minimum Data Set has been specified as a simple data specification but will be carried within the existing framework of the Commissioning Data Set as supported by the Secondary Uses Service.

Note that this enhancement is only intended to be implemented as a new version in the Commissioning Data Set-XML Message and will not be implemented in the current Commissioning Data Set-EDIFACT Message (NHS005).

Scope:

The definition of Paediatric Critical Care is linked to the definition of Paediatric Critical Care Healthcare Resource Groups.

The scope of the Paediatric Critical Care Minimum Data Set is:

a)All PATIENTS on a WARD with a CRITICAL CARE UNIT FUNCTION Paediatric Intensive Care Unit regardless of care being delivered
b)All PATIENTS on a WARD with a CRITICAL CARE UNIT FUNCTION with National Code of either:
  • 04 Paediatric Intensive Care Unit (Paediatric critical care patients predominate)
  • 16 Ward for children and young people
  • 17 High Dependency Unit for children and young people
  • 18 Renal Unit for children and young people
  • 19 Burns Unit for children and young people
  • 92 Non standard location using the operating department for children and young people
to whom one or more of the following CRITICAL CARE ACTIVITIES applies for a period greater than 4 hours:
  
04Exchange transfusion
05Peritoneal dialysis (acute patients only i.e. excluding chronic)
06Continuous infusion of inotrope, pulmonary vasodilator or prostaglandin
09Supplemental oxygen therapy (irrespective of ventilatory state)
13Tracheostomy cared for by nursing staff
16Haemofiltration
50Continuous electrocardiogram monitoring
51Invasive ventilation via endotracheal tube
52Invasive ventilation via tracheostomy tube
53Non-invasive ventilatory support
55Nasopharyngeal airway
56Advanced ventilatory support (Jet or Oscillatory ventilation)
57Upper airway obstruction requiring nebulised Epinephrine/ Adrenaline
58Apnoea requiring intervention
59Acute severe asthma requiring intravenous bronchodilator therapy or continuous nebuliser
60Arterial line monitoring
61Cardiac pacing via an external box (pacing wires or external pads or oesophageal pacing)
62Central venous pressure monitoring
63Bolus intravenous fluids (> 80 ml/kg/day) in addition to maintenance intravenous fluids
64Cardio-pulmonary resuscitation (CPR)
65Extracorporeal membrane oxygenation (ECMO) or Ventricular Assist Device (VAD) or aortic balloon pump
66Haemodialysis (acute patients only i.e. excluding chronic)
67Plasma filtration or Plasma exchange
68ICP-intracranial pressure monitoring
69Intraventricular catheter or external ventricular drain
70Diabetic ketoacidosis (DKA) requiring continuous infusion of insulin
71Intravenous infusion of thrombolytic agent (limited to tissue plasminogen activator [tPA] and streptokinase)
72Extracorporeal liver support using Molecular Absorbent Recirculating System (MARS)
73Continuous pulse oximetry
74Patient nursed in single occupancy cubicle


If one or more of these items apply to a PATIENT, then the PATIENT would be counted as receiving Paediatric Critical Care at one of the levels of Intensive Care or High Dependency Care depending on the conditions/interventions which apply.

A number of these interventions will only occur in a Paediatric Intensive Care Unit environment where all PATIENTS are covered by the Paediatric Critical Care Minimum Data Set regardless of treatment. Care for PATIENTS outside of a Paediatric Intensive Care Unit will in practice be dealing with a shorter list of interventions. The Paediatric Critical Care Minimum Data Set should not be collected in facilities other than those with  CRITICAL CARE UNIT FUNCTION:

  • Paediatric Intensive Care Unit; or
  • Ward for children and young people; or
  • High Dependency Unit for children and young people; or
  • Renal Unit for children and young people; or
  • Burns Unit for children and young people; or
  • Non standard location using the operating department for children and young people.

The Commissioning Data Set message will prevent submission of Paediatric Critical Care Minimum Data Set when submitted with a  CRITICAL CARE UNIT FUNCTION other than those listed above.

The Paediatric Critical Care Minimum Data Set will be carried as part of the following Admitted Patient Care Commissioning Data Set Types:

  • The Admitted Patient Care Finished General Episode (Commissioning Data Set TYPE 130)
  • The Admitted Patient Care Unfinished General Episode (Commissioning Data Set TYPE 190)
  • The Admitted Patient Care Delivery Episode (Commissioning Data Set TYPE 140)
  • The Admitted Patient Care Unfinished Delivery Episode (Commissioning Data Set TYPE 200)
  • The Admitted Patient Care Finished Birth Episode (Commissioning Data Set TYPE 120)
  • The Admitted Patient Care Unfinished Birth Episode (Commissioning Data Set TYPE 180)

top


CDS INTERCHANGE INTERFACE GATEWAY SERVICE REFERENCE (RETIRED)  renamed from CDS INTERCHANGE INTERFACE GATEWAY SERVICE REFERENCE

Change to Data Element: Changed status to Retired, Name

  • Retired CDS INTERCHANGE INTERFACE GATEWAY SERVICE REFERENCE
  • Changed Name from Data_Dictionary.Data_Field_Notes.C.CDS.CDS_INTERCHANGE_INTERFACE_GATEWAY_SERVICE_REFERENCE to Retired.Data_Dictionary.Data_Field_Notes.C.CDS.CDS_INTERCHANGE_INTERFACE_GATEWAY_SERVICE_REFERENCE

top


PERSON FULL NAME

Change to Data Element: Changed Description

Format/length:max 70 characters
HES item: 
National Codes: 
Default Codes: 

Notes:
The full name of a PERSON. This is an unstructured concatenation of some or all of the PERSON TITLE, PERSON GIVEN NAME, PERSON FAMILY NAME and PERSON NAME SUFFIX elements, or other elements that make up a PERSON's full name.

References:
UK Government Data Standards Catalogue (GDSC), Version 1.0, Agreed 01.01.02. GDSC:
http://www.govtalk.gov.uk/gdsc/html/default.htm

This is the e-GIF standard that should be used for all new and developing systems and for XML messages. For existing CDS EDIFACT messages however, PATIENT NAME should be used.

UK Government Data Standards Catalogue

Data Element Person Full Name 
Is Part Of 
Person Name
 
Has Parts  
Version 1.0 
Status Release 
Previous Versions  
Later Versions  
Date Agreed 1 January 2002 

Meta Data Value 
Name Person Full Name 
Description The full name of a person. This is an unstructured concatenation of some or all of the Person Title, Person Given Name, Person Family Name and Person Name Suffix elements, or other elements that make up a person's full name.
Business Format Max 70 Characters
Element Type Data Type
Validations 
1. Any allowable character from UNICODE set of characters.
2. Each element of the name must be separated by a space.
3. Consecutive spaces are not allowed.
 
Value  
Default Value  
Owner OeE
Based On  
Verification  
Comment 
This standard is for use where it is not necessary to process the individual elements of a person's name and the structure is unknown.
 
 

top


PERSON NAME SUFFIX

Change to Data Element: Changed Description

Format/length:35 characters (max)
HES item: 
National Codes: 
Default Codes: 

Notes:
A textual suffix that may be added to the end of a PERSON's name, for example, OBE, MBE, BSc, JP, GM.

References:
UK Government Data Standards Catalogue (GDSC), Version 1.0, Agreed 01.01.02. GDSC:
http://www.govtalk.gov.uk/gdsc/html/default.htm

PERSON NAME SUFFIX is the same as PERSON NAME WORD TEXT where the PERSON NAME WORD TYPE equals 'd. Person Name Suffix'.

This is the e-GIF standard that should be used for all new and developing systems and for XML messages. For existing CDS EDIFACT messages however, PATIENT NAME should be used.

UK Government Data Standards Catalogue

Data Element Person Name Suffix 
Is Part Of 
Person Name
 
Has Parts  
Version 1.0 
Status Release 
Previous Versions  
Later Versions  
Date Agreed 1 January 2002 

Meta Data Value 
Name Person Name Suffix 
Description A textual suffix that may be added to the end of a person's name, for example, OBE, MBE, BSc, JP, GM.
Business Format Max. 35 characters
Element Type Data Type
Validations 
1. The first character of each occurrence must be A - Z.
2. Consecutive spaces are not allowed.
3. Each occurrence must be separated by a space.
 
Value  
Default Value  
Owner OeE
Based On BSEN 7372:1993
Verification  
Comment  
 

top


POSTCODE OF USUAL ADDRESS

Change to Data Element: Changed Description

Format/length:see POSTCODE 
HES item:HOMEADD
National Codes: 
Default Codes: 

Notes:
References:
UK Government Data Standards Catalogue (GDSC), Version 2.1, Agreed 01.09.02. GDSC:
http://www.govtalk.gov.uk/gdsc/html/default.htm

This is a type of POSTCODE.

The POSTCODE of the ADDRESS nominated by the PATIENT with ADDRESS ASSOCIATION TYPE 'Main Permanent Residence' or 'Other Permanent Residence'.

If a PATIENT has no fixed abode this should be recorded with the appropriate code (ZZ99 3VZ).

For overseas visitors the POSTCODES OF USUAL ADDRESS field must show the relevant country pseudo postcode commencing ZZ99 plus space followed by a numeric, then an alpha character, then a Z. For example, ZZ99 6CZ is the pseudo-postcode for India. Pseudo-Country postcodes can be found in the NHS Postcode Directory.

The 8 characters field allows a space to be inserted to differentiate between the inward and outward segments of the code, enabling full use to be made of Royal Mail postcode functionality.

See NHS Postcode Directory and Contact Details.

The e-GIF standard POSTCODE should be used for all new and developing systems and for XML messages. For existing CDS EDIFACT messages however, POSTCODE OF USUAL ADDRESS should be used, due to the need to use the exceptional codes listed above.

 

top


SEX (BABY)

Change to Data Element: Changed Description

Format/length:n1
HES item:SEXBABY
National Codes:See PERSON GENDER CODE for the National Codes
Default Codes: 

Notes:
SEX (BABY) is the same as the attribute PERSON GENDER CODE.

The e-GIF standard PERSON GENDER AT REGISTRATION should be used for all new and developing systems and for XML messages. For existing CDS EDIFACT messages however, SEX (BABY) should be used.

 

top


CDS

Change to Package: New Package

top


For enquiries, please email datastandards@nhs.net