ADDRESS_FORMAT_NHS |
VARCHAR(2) |
Y |
A code to determine the format of the associated PATIENT USUAL ADDRESS data. |
ADMINISTRATIVE_CATEGORY_NHS |
VARCHAR(2) |
Y |
Identifies if a PATIENT is required to pay for treatment provided within a particular ACTIVITY or for transport. The same ADMINISTRATIVE CATEGORY will usually apply during the whole of a spell or episode but it may change, e.g. a PATIENT may start as an NHS patient, but then opt to change to a private patient. |
BIRTH_DT_TM |
DATETIME |
Y |
The date on which a person was born or is officially deemed to have been born. |
CARER_SUPPORT_NHS |
VARCHAR(2) |
Y |
An indication of whether or not carer support is available to the PATIENT at their normal residence. This does not include any paid support or support from a voluntary organisation, unless the PATIENT is normally resident in a Care Home. |
CDS_ACTIVITY_DT_TM |
DATETIME |
Y |
Every CDS Type has a ""CDS Originating Date"" contained within the CDS data that must be used to populate the CDS ACTIVITY DATE. The CDS ACTIVITY DATE is held in the CDS Transaction Header Group and is a mandatory data element for all uses of the CDS for both Bulk Update and Net Change Protocols. |
CDS_APPLICABLE_DT_TM |
DATETIME |
Y |
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. |
CDS_BATCH_CONTENT_SK |
VARCHAR(40) |
N |
Unique identifier for each cds item. This is the unique CDS ID reported to the NHS. |
CDS_BULK_REPLACEMENT_GRP_NHS |
VARCHAR(3) |
N |
The CDS Group into which CDS Types must be grouped when using the CDS Bulk Replacement Update Mechanism. |
CDS_COPY_RECIPIENT1_NACS |
VARCHAR(12) |
Y |
CDS COPY RECIPIENT IDENTITY is the same as the attribute ORGANISATION CODE. The 5-character NHS ORGANISATION CODE (or valid default code) for an organisation indicated as a CDS COPY RECIPIENT IDENTITY of the CDS Message. |
CDS_COPY_RECIPIENT2_NACS |
VARCHAR(12) |
Y |
CDS COPY RECIPIENT IDENTITY is the same as the attribute ORGANISATION CODE. The 5-character NHS ORGANISATION CODE (or valid default code) for an organisation indicated as a CDS COPY RECIPIENT IDENTITY of the CDS Message. |
CDS_COPY_RECIPIENT3_NACS |
VARCHAR(12) |
Y |
CDS COPY RECIPIENT IDENTITY is the same as the attribute ORGANISATION CODE. The 5-character NHS ORGANISATION CODE (or valid default code) for an organisation indicated as a CDS COPY RECIPIENT IDENTITY of the CDS Message. |
CDS_COPY_RECIPIENT4_NACS |
VARCHAR(12) |
Y |
CDS COPY RECIPIENT IDENTITY is the same as the attribute ORGANISATION CODE. The 5-character NHS ORGANISATION CODE (or valid default code) for an organisation indicated as a CDS COPY RECIPIENT IDENTITY of the CDS Message. |
CDS_COPY_RECIPIENT5_NACS |
VARCHAR(12) |
Y |
CDS COPY RECIPIENT IDENTITY is the same as the attribute ORGANISATION CODE. The 5-character NHS ORGANISATION CODE (or valid default code) for an organisation indicated as a CDS COPY RECIPIENT IDENTITY of the CDS Message. |
CDS_COPY_RECIPIENT6_NACS |
VARCHAR(12) |
Y |
CDS COPY RECIPIENT IDENTITY is the same as the attribute ORGANISATION CODE. The 5-character NHS ORGANISATION CODE (or valid default code) for an organisation indicated as a CDS COPY RECIPIENT IDENTITY of the CDS Message. |
CDS_COPY_RECIPIENT7_NACS |
VARCHAR(12) |
Y |
CDS COPY RECIPIENT IDENTITY is the same as the attribute ORGANISATION CODE. The 5-character NHS ORGANISATION CODE (or valid default code) for an organisation indicated as a CDS COPY RECIPIENT IDENTITY of the CDS Message. |
CDS_EXTRACT_DT_TM |
DATETIME |
Y |
The date & time (with an associated CDS EXTRACT TIME ) of the update event (or the nearest equivalent) that resulted in the need to exchange this CDS. |
CDS_PRIMARY_RECIPIENT_NACS |
VARCHAR(12) |
Y |
CDS PRIME RECIPIENT IDENTITY is the same as the attribute 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 Commissioning Data Set Overview. |
CDS_PROTOCOL_NHS |
VARCHAR(3) |
Y |
A code to identify the CDS Exchange Protocol and Update Mechanism associated with the transaction. |
CDS_RECORD_TYPE_NHS |
VARCHAR(3) |
N |
A code to identify the specific type of Commissioning Data Set data. |
CDS_SENDER_NACS |
VARCHAR(12) |
Y |
This is the identity of the ORGANISATION acting as the Sender of a CDS submission and is represented by that Organisation's ORGANISATION CODE. |
CDS_TEST_IND_TXT |
VARCHAR(1) |
N |
This optional data item enables the individual CDS message to be classified as a normal or a test transaction. |
CDS_UNIQUE_IDENT |
VARCHAR(35) |
Y |
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. |
CDS_UPDATE_DEL_FLG |
DOUBLE |
Y |
A code to indicate the required database update process for the submitted CDS Message. |
CDS_UPDT_DT_TM |
DATETIME |
Y |
The date and time the CDS was last updated. |
COMMISSIONER_ORG_NACS |
VARCHAR(12) |
Y |
This is the ORGANISATION CODE of the ORGANISATION commissioning health care. This should always be the ORGANISATION CODE of the original commissioner for Commissioning Data Sets to support Payment by Results. |
COMMISSIONER_REF_IDENT |
VARCHAR(17) |
Y |
A number (alphanumeric) allocated by the commissioner to a REFERRAL REQUEST. |
COMMISSIONING_SERIAL_NBR_IDENT |
VARCHAR(6) |
Y |
A number used to uniquely identify a NHS SERVICE AGREEMENT by an ORGANISATION acting as commissioner of patient care services. |
CONSULTANT_IDENT |
VARCHAR(8) |
Y |
This is the GENERAL MEDICAL COUNCIL (GMC) NUMBER for the CONSULTANT. For GENERAL MEDICAL PRACTITIONERS working as CONSULTANTS, the GENERAL MEDICAL PRACTITIONER's GENERAL MEDICAL COUNCIL (GMC) NUMBER should be used, see data item note for GENERAL MEDICAL PRACTITIONER (SPECIFIED). |
DIRECT_ACCESS_REFERRAL_IND_NHS |
VARCHAR(1) |
Y |
An indication of whether a PATIENT was referred to a Direct Access Service. |
EARLIEST_RSNBL_OFFER_DT_TM |
DATETIME |
Y |
It is the date of the earliest of the reasonable offers made to a patient for an appointment or elective admission. it should only be included on the commissioning data sets where the patient has declined at least two reasonable offers. |
EC_ACCESS_INFO_PROF_REQ_SCT |
VARCHAR(100) |
Y |
The SNOMED CT concept ID which is used to identify that the patient requires support from a communication professional. |
EC_ACCOMMODATION_STATUS_SCT |
VARCHAR(100) |
Y |
The SNOMED CT concept ID which is used to identify the details of the accommodation of the person. |
EC_INTERPRETER_LANGUAGE_SCT |
VARCHAR(100) |
Y |
The SNOMED CT concept ID which is used to record the language of the interpreter required by the person. |
EC_OVERSEAS_VIST_CHRG_CATG_NHS |
VARCHAR(1) |
Y |
The charging category relating to an overseas visitor status recorded at the cds activity date. |
EC_PERSON_STATED_GENDER_CD_NHS |
VARCHAR(1) |
Y |
The self declared or inferred by observation for those unable to declare their person stated gender. |
EC_PREFERRED_SPOKEN_LANG_SCT |
VARCHAR(100) |
Y |
The SNOMED CT concept ID which is used to capture the preferred spoken language of the person. |
ETHNIC_CATEGORY_2021_NHS |
VARCHAR(3) |
Y |
The ethnicity of a PERSON, as specified by the PERSON using classification code used for the 2021 census. |
ETHNIC_CATEGORY_NHS |
VARCHAR(2) |
Y |
The ethnicity of a PERSON, as specified by the PERSON. |
FIRST_PROCESS_DT_TM |
DATETIME |
N |
The date/time that the first ETL process started that created this record. |
HEALTH_SYSTEM_ID |
DOUBLE |
N |
Unique number assigned by Health Facts. Typically the universal Cerner assigned client id of the health system. |
HEALTH_SYSTEM_SOURCE_ID |
DOUBLE |
N |
Unique number assigned by Health Facts. Typically the universal Cerner assigned client id of the sending health system but may be adjusted if there is >1 HF feed from the client. |
HRG_DRGVP_TXT |
VARCHAR(4) |
Y |
HRG DOMINANT GROUPING VARIABLE-PROCEDURES is a field derived by the Healthcare Resource Group Acute Inpatient Grouper. It represents the procedure that the Healthcare Resource Group grouping algorithm has identified as having the greatest effect upon the resources consumed by a PATIENT. It is required for the production of the National Schedule of Reference Costs reports. |
HRG_PROCEDURE_SCHEME_TXT |
VARCHAR(2) |
Y |
This is used in the Clinical Activity Group of the CDS to denote the scheme basis of an Intervention Operation or A&E Treatment |
HRG_TXT |
VARCHAR(3) |
Y |
This is the HRG Code |
HRG_VERSION_NBR_NHS |
VARCHAR(3) |
Y |
HEALTHCARE RESOURCE GROUP CODE-VERSION NUMBERS identify which version of the Healthcare Resource Group has been used to identify the Healthcare Resource Group. |
LAST_PROCESS_DT_TM |
DATETIME |
N |
The date/time that the last ETL process started that updated this record. |
LEAD_CARE_ACTIVITY_NHS |
VARCHAR(1) |
Y |
An indicator that the first PERSON in the PERSON RELATIONSHIP is a lead contact to the second PERSON. That is the PERSON acting as a lead contact or proxy for the other PERSON, in circumstances where the second PERSON is unable to communicate effectively or lacks the capacity to make medical decisions and the proxy is authorised to act for that PERSON. This may be the case if the PERSON requiring a lead contact is an infant, has a disability or has an illness preventing direct communication. |
LINE1_ADDR |
VARCHAR(35) |
Y |
The first text string comprising one line of an ADDRESS. |
LINE2_ADDR |
VARCHAR(35) |
Y |
The second text string comprising one line of an ADDRESS. |
LINE3_ADDR |
VARCHAR(35) |
Y |
The third text string comprising one line of an ADDRESS. |
LINE4_ADDR |
VARCHAR(35) |
Y |
The fourth text string comprising one line of an ADDRESS. |
LINE5_ADDR |
VARCHAR(35) |
Y |
The fifth text string comprising one line of an ADDRESS. |
LOCAL_PATIENT_IDENT |
VARCHAR(10) |
Y |
An identifier, other than a name, which identifies a PERSON. |
LOCAL_PATIENT_ID_ORG_NACS |
VARCHAR(12) |
Y |
This is the identification of a PATIENT having a relationship with a particular ORGANISATION such as a PATIENT having been registered with a Trust for SERVICES. |
LOCAL_SPECIALTY_NHS |
VARCHAR(3) |
Y |
A local code identifying each local specialty designated by the NHS organisation. These are usually related to main specialty codes. |
LOCAL_SUBSPECIALTY_NHS |
VARCHAR(8) |
Y |
A local code identifying each local sub-specialty designated by the NHS organisation. These are usually related to local specialty codes. |
LOC_EARLIEST_RSNBL_OFFER_DT_TM |
DATETIME |
Y |
It is the date of the earliest of the reasonable offers made to a patient for an appointment or elective admission. it should only be included on the commissioning data sets where the patient has declined at least two reasonable offers. |
MAIN_SPECIALTY_NHS |
VARCHAR(3) |
Y |
A unique code identifying each main specialty designated by Royal Colleges. This is the same as the occupation codes describing specialties. |
MARITAL_STATUS_NHS |
VARCHAR(1) |
Y |
An indicator to identify the legal marital status of a PERSON. |
NAME_FORMAT_NHS |
VARCHAR(2) |
Y |
This is used in the CDS to identify the format of a PATIENT NAME, with the classification values indicating whether it is a PERSON NAME STRUCTURED or PERSON NAME UNSTRUCTURED. |
NHS_NBR_IDENT |
VARCHAR(10) |
Y |
A number used to identify a person uniquely within the NHS in England and Wales. This field contains the NHS Number of the patient, which is the primary identifier of a person registered for health care; it is unique. Records for babies under six weeks of age and for patients admitted through accident and emergency tend to have null entries for this field. |
NHS_NBR_STATUS_NHS |
VARCHAR(2) |
Y |
Codes in this field indicate whether the patients' NHS Number is present, and if it is verified. If the NHS Number is absent, the indicator gives the reason why. |
NHS_SRVC_AGREEMENT_LINE_IDENT |
VARCHAR(10) |
Y |
A number used to uniquely identify a NHS SERVICE AGREEMENT by an ORGANISATION acting as commissioner of patient care services. |
OVERSEAS_VISITOR_STATUS_NHS |
VARCHAR(1) |
Y |
The status of a PATIENT who is an Overseas Visitor |
OVERSEAS_VISITOR_STATUS_NHS_2 |
VARCHAR(1) |
Y |
The status of a PATIENT who is an Overseas Visitor |
OVERSEAS_VISITOR_STATUS_NHS_3 |
VARCHAR(1) |
Y |
The status of a PATIENT who is an Overseas Visitor |
OVERSEAS_VISITOR_STATUS_NHS_4 |
VARCHAR(1) |
Y |
The status of a PATIENT who is an Overseas Visitor |
OVERSEAS_VISITOR_STATUS_NHS_5 |
VARCHAR(1) |
Y |
The status of a PATIENT who is an Overseas Visitor |
OVERSEAS_VS_END_DT_TM |
DATETIME |
Y |
The end datetime of patient's Overseas Visitor status |
OVERSEAS_VS_END_DT_TM_2 |
DATETIME |
Y |
The end datetime of patient's Overseas Visitor status |
OVERSEAS_VS_END_DT_TM_3 |
DATETIME |
Y |
The end datetime of patient's Overseas Visitor status |
OVERSEAS_VS_END_DT_TM_4 |
DATETIME |
Y |
The end datetime of patient's Overseas Visitor status |
OVERSEAS_VS_END_DT_TM_5 |
DATETIME |
Y |
The end datetime of patient's Overseas Visitor status |
OVERSEAS_VS_START_DT_TM |
DATETIME |
Y |
The start datetime of patient's Overseas Visitor status |
OVERSEAS_VS_START_DT_TM_2 |
DATETIME |
Y |
The start datetime of patient's Overseas Visitor status |
OVERSEAS_VS_START_DT_TM_3 |
DATETIME |
Y |
The start datetime of patient's Overseas Visitor status |
OVERSEAS_VS_START_DT_TM_4 |
DATETIME |
Y |
The start datetime of patient's Overseas Visitor status |
OVERSEAS_VS_START_DT_TM_5 |
DATETIME |
Y |
The start datetime of patient's Overseas Visitor status |
PATIENT_FORENAME |
VARCHAR(35) |
Y |
The specific first name of a patient by which a PERSON may be known. |
PATIENT_FULL_NAME |
VARCHAR(70) |
Y |
Patient's first and last name |
PATIENT_INITIALS |
VARCHAR(35) |
Y |
Patient Initials |
PATIENT_NAME_SUFFIX |
VARCHAR(35) |
Y |
Patient Suffix |
PATIENT_PATHWAY_IDENT |
VARCHAR(20) |
Y |
An identifier, which together with the ORGANISATION CODE of the issuer, uniquely identifies a PATIENT PATHWAY. |
PATIENT_PATHWAY_ISSUER_NACS |
VARCHAR(12) |
Y |
The ORGANISATION CODE of the issuer, which is used to uniquely identify a PATIENT PATHWAY. |
PATIENT_REQUESTED_NAME |
VARCHAR(70) |
Y |
Patient's requested name |
PATIENT_SURNAME |
VARCHAR(35) |
Y |
The specific surname / last name of a patient by which a PERSON may be known. |
PATIENT_TITLE |
VARCHAR(35) |
Y |
Patient's title |
PATIENT_UNSTRUCTURED_ADDRESS |
VARCHAR(175) |
Y |
Patient's full unstructured address |
PCT_RESIDENCE_NACS |
VARCHAR(12) |
Y |
The Organisation code of the responsible commissioner for a specific geographic area where PATIENTS not registered with a General Medical Practitioner Practice but resident in the GEOGRAPHIC AREA covered by a Primary Care Trust are the responsibility of that Primary Care Trust. The National Administrative Codes Service provides postcode files which link postcodes to PCT OF RESIDENCES. |
POSTCODE |
VARCHAR(25) |
Y |
The code allocated by the Post Office to identify a group of postal delivery points. A code used primarily for the delivery of correspondence to ADDRESSES. POSTCODES may also be used to define a GEOGRAPHIC AREA. |
PROVIDER_ORG_NACS |
VARCHAR(12) |
Y |
An ORGANISATION providing patient care services within a NHS SERVICE AGREEMENT. |
PROVIDER_REF_IDENT |
VARCHAR(17) |
Y |
A convention agreed locally between a provider and Commissioner for use within a CDS message. |
PT_AGE_AT_ACTIVITY_YEARS |
DOUBLE |
Y |
This is derived as the number of completed years between the PERSON BIRTH DATE of the PATIENT and the ATTENDANCE DATE or the estimated age of the PATIENT. |
REFERRER_IDENT |
VARCHAR(8) |
Y |
This requires the code of the PERSON making the referral. This will normally be a CARE PROFESSIONAL - a GENERAL MEDICAL PRACTITIONER or a CONSULTANT. |
REFERRER_ORG_NACS |
VARCHAR(12) |
Y |
This is the ORGANISATION CODE of the ORGANISATION from which the referral is made, such as GP Practice or NHS Trust. This information is essential for managing service agreements which are based on patterns of referral. The National Cancer Waiting Times Monitoring Data Set (22/2002) does not require GP Practices and stipulates a maximum length of an5 to record the appropriate NHS Trust. |
REGISTERED_GMP_IDENT |
VARCHAR(8) |
Y |
This is the code of the GENERAL MEDICAL PRACTITIONER specified by the PATIENT. |
REGISTERED_GP_PRCTC_ORG_NACS |
VARCHAR(12) |
Y |
This is the code of the GP Practice that the PATIENT is registered with. |
RTT_PERIOD_END_DT_TM |
DATETIME |
Y |
The end date of a REFERRAL TO TREATMENT PERIOD. |
RTT_PERIOD_START_DT_TM |
DATETIME |
Y |
The start date of a REFERRAL TO TREATMENT PERIOD. |
RTT_PERIOD_STATUS_NHS |
VARCHAR(2) |
Y |
The status of an ACTIVITY (or anticipated ACTIVITY) for the 18 week REFERRAL TO TREATMENT PERIOD decided by the lead CARE PROFESSIONAL. |
RTT_WAIT_TIME_MEAS_TYPE_NHS |
VARCHAR(2) |
Y |
The type of waiting time measurement methodology which may be applied during a PATIENT PATHWAY. |
SECURITY_KEY |
DOUBLE |
Y |
The identifier associated to the reference object selected for row-level security. |
SEX_CD_NHS |
VARCHAR(1) |
Y |
SEX is the same as the attribute PERSON GENDER CODE. |
TOTAL_UPDATES |
DOUBLE |
N |
The numbers of updates that have occurred on this table. |
TREATMENT_FUNCTION_NHS |
VARCHAR(3) |
Y |
This is the TREATMENT FUNCTION under which the PATIENT is treated. |
UBRN_IDENT |
VARCHAR(12) |
Y |
The unique booking reference number assigned by the NHS Connecting for Health Choose and Book system when a PATIENT accepts an APPOINTMENT DATE OFFERED of an APPOINTMENT OFFER where the offer was made via the NHS Connecting for Health Choose and Book system. |
UKRWH_CDS_HEADER_KEY |
DOUBLE |
N |
This is the value of the unique primary identifier of the ukrwh cds header table. It is an internal system assigned number. |
UKRWH_CDS_LOAD_KEY |
DOUBLE |
N |
Uniquely identifies the load id related to this cds load. |
UPDATE_USER |
VARCHAR(40) |
N |
The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. |
UPDT_APPLCTX |
DOUBLE |
N |
The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
UPDT_CNT |
DOUBLE |
N |
Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
UPDT_DT_TM |
DATETIME |
N |
The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
UPDT_TASK |
DOUBLE |
N |
The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
WITHHELD_FLG |
VARCHAR(1) |
Y |
Indicates whether patient data has been anonymised |
WITHHELD_IDENTITY_REASON_NHS |
VARCHAR(2) |
Y |
NHS values which identifys that the record has been purposely anonymised for a valid reason |