Publisher API Code Sets: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
Line 52: Line 52:
|W
|W
|Waiting List
|Waiting List
|}
=== 0296-PrimaryLanguage ===
{| class="wikitable"
!Code
!Description
|-
|aa
|Afar
|-
|ab
|Abkhazian
|-
|ae
|Avestan
|-
|af
|Afrikaans
|-
|ak
|Akan
|-
|am
|Amharic
|-
|an
|Aragonese
|-
|ar
|Arabic
|-
|as
|Assamese
|-
|av
|Avaric
|-
|ay
|Aymara
|-
|az
|Azerbaijani
|-
|ba
|Bashkir
|-
|be
|Belarusian
|-
|bg
|Bulgarian
|-
|bh
|Bihari languages
|-
|bi
|Bislama
|-
|bm
|Bambara
|-
|bn
|Bengali
|-
|bo
|Tibetan
|-
|br
|Breton
|-
|bs
|Bosnian
|-
|ca
|Catalan; Valencian
|-
|ce
|Chechen
|-
|ch
|Chamorro
|-
|co
|Corsican
|-
|cr
|Cree
|-
|cs
|Czech
|-
|cu
|Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
|-
|cv
|Chuvash
|-
|cy
|Welsh
|-
|da
|Danish
|-
|de
|German
|-
|dv
|Divehi; Dhivehi; Maldivian
|-
|dz
|Dzongkha
|-
|ee
|Ewe
|-
|el
|Greek, Modern (1453-)
|-
|en
|English
|-
|eo
|Esperanto
|-
|es
|Spanish; Castilian
|-
|et
|Estonian
|-
|eu
|Basque
|-
|fa
|Persian
|-
|ff
|Fulah
|-
|fi
|Finnish
|-
|fj
|Fijian
|-
|fo
|Faroese
|-
|fr
|French
|-
|fy
|Western Frisian
|-
|ga
|Irish
|-
|gd
|Gaelic; Scottish Gaelic
|-
|gl
|Galician
|-
|gn
|Guarani
|-
|gu
|Gujarati
|-
|gv
|Manx
|-
|ha
|Hausa
|-
|he
|Hebrew
|-
|hi
|Hindi
|-
|ho
|Hiri Motu
|-
|hr
|Croatian
|-
|ht
|Haitian; Haitian Creole
|-
|hu
|Hungarian
|-
|hy
|Armenian
|-
|hz
|Herero
|-
|ia
|Interlingua (International Auxiliary Language Association)
|-
|id
|Indonesian
|-
|ie
|Interlingue; Occidental
|-
|ig
|Igbo
|-
|ii
|Sichuan Yi; Nuosu
|-
|ik
|Inupiaq
|-
|io
|Ido
|-
|is
|Icelandic
|-
|it
|Italian
|-
|iu
|Inuktitut
|-
|ja
|Japanese
|-
|jv
|Javanese
|-
|ka
|Georgian
|-
|kg
|Kongo
|-
|ki
|Kikuyu; Gikuyu
|-
|kj
|Kuanyama; Kwanyama
|-
|kk
|Kazakh
|-
|kl
|Kalaallisut; Greenlandic
|-
|km
|Central Khmer
|-
|kn
|Kannada
|-
|ko
|Korean
|-
|kr
|Kanuri
|-
|ks
|Kashmiri
|-
|ku
|Kurdish
|-
|kv
|Komi
|-
|kw
|Cornish
|-
|ky
|Kirghiz; Kyrgyz
|-
|la
|Latin
|-
|lb
|Luxembourgish; Letzeburgesch
|-
|lg
|Ganda
|-
|li
|Limburgan; Limburger; Limburgish
|-
|ln
|Lingala
|-
|lo
|Lao
|-
|lt
|Lithuanian
|-
|lu
|Luba-Katanga
|-
|lv
|Latvian
|-
|mg
|Malagasy
|-
|mh
|Marshallese
|-
|mi
|Maori
|-
|mk
|Macedonian
|-
|ml
|Malayalam
|-
|mn
|Mongolian
|-
|mr
|Marathi
|-
|ms
|Malay
|-
|mt
|Maltese
|-
|my
|Burmese
|-
|na
|Nauru
|-
|nb
|Bokmål, Norwegian; Norwegian Bokmål
|-
|nd
|Ndebele, North; North Ndebele
|-
|ne
|Nepali
|-
|ng
|Ndonga
|-
|nl
|Dutch; Flemish
|-
|nn
|Norwegian Nynorsk; Nynorsk, Norwegian
|-
|no
|Norwegian
|-
|nr
|Ndebele, South; South Ndebele
|-
|nv
|Navajo; Navaho
|-
|ny
|Chichewa; Chewa; Nyanja
|-
|oc
|Occitan (post 1500)
|-
|oj
|Ojibwa
|-
|om
|Oromo
|-
|or
|Oriya
|-
|os
|Ossetian; Ossetic
|-
|pa
|Panjabi; Punjabi
|-
|pi
|Pali
|-
|pl
|Polish
|-
|ps
|Pushto; Pashto
|-
|pt
|Portuguese
|-
|q1
|Braille
|-
|q2
|American Sign Language
|-
|q3
|Australian.Sign Language
|-
|q4
|British Sign Language
|-
|q5
|Makaton
|-
|qu
|Quechua
|-
|rm
|Romansh
|-
|rn
|Rundi
|-
|ro
|Romanian; Moldavian; Moldovan
|-
|ru
|Russian
|-
|rw
|Kinyarwanda
|-
|sa
|Sanskrit
|-
|sc
|Sardinian
|-
|sd
|Sindhi
|-
|se
|Northern Sami
|-
|sg
|Sango
|-
|si
|Sinhala; Sinhalese
|-
|sk
|Slovak
|-
|sl
|Slovenian
|-
|sm
|Samoan
|-
|sn
|Shona
|-
|so
|Somali
|-
|sq
|Albanian
|-
|sr
|Serbian
|-
|ss
|Swati
|-
|st
|Sotho, Southern
|-
|su
|Sundanese
|-
|sv
|Swedish
|-
|sw
|Swahili
|-
|ta
|Tamil
|-
|te
|Telugu
|-
|tg
|Tajik
|-
|th
|Thai
|-
|ti
|Tigrinya
|-
|tk
|Turkmen
|-
|tl
|Tagalog
|-
|tn
|Tswana
|-
|to
|Tonga (Tonga Islands)
|-
|tr
|Turkish
|-
|ts
|Tsonga
|-
|tt
|Tatar
|-
|tw
|Twi
|-
|ty
|Tahitian
|-
|ug
|Uighur; Uyghur
|-
|uk
|Ukrainian
|-
|ur
|Urdu
|-
|uz
|Uzbek
|-
|ve
|Venda
|-
|vi
|Vietnamese
|-
|vo
|Volapük
|-
|wa
|Walloon
|-
|wo
|Wolof
|-
|xh
|Xhosa
|-
|yi
|Yiddish
|-
|yo
|Yoruba
|-
|za
|Zhuang; Chuang
|-
|zh
|Chinese
|-
|zu
|Zulu
|-
|q4
|British sign language
|-
|q5
|Makaton
|}
|}
=== 0189-EthnicGroup ===
=== 0189-EthnicGroup ===

Revision as of 10:11, 21 October 2021

This page details the various code sets that are supported by the DDS Publisher API. The majority of these code sets have previously been published by NHS Digital as part of the ITK HL7 V2 standard (version 1.1)

0001-AdministrativeSex

Code Description
0 Not Known
1 Male
2 Female
9 Not specified

0004-PatientClass

Code Description
B Obstetrics
C Commercial Account
E Emergency
I Inpatient
N Not Applicable
O Outpatient
P Preadmit
R Recurring patient
U Unknown
W Waiting List

0189-EthnicGroup

Code Description
A British
B Irish
C Any other White background
D White and Black Caribbean
E White and Black African
F White and Asian
G Any other mixed background
H Indian
J Pakistani
K Bangladeshi
L Any other Asian background
M Caribbean
N African
P Any other Black background
R Chinese
S Any other ethnic group
SE Any other ethnic group
Z Not stated
99 Not known

0136-Yes/noIndicator

Code Description
Y Yes

0399-CountryCode

Code Description
1 England
10 Channel Islands
2 Scotland
3 Wales
4 Northern Ireland
7 Sark
9 Alderney
ABW Aruba
AFG Afghanistan
AGO Angola
AIA Anguilla
ALA Ã…land Islands
ALB Albania
AND Andorra
ARE United Arab Emirates
ARG Argentina
ARM Armenia
ASM American Samoa
ATA Antarctica
ATF French Southern Territories
ATG Antigua and Barbuda
AUS Australia
AUT Austria
AZE Azerbaijan
BDI Burundi
BEL Belgium
BEN Benin
BES Bonaire, Sint Eustatius and Saba
BFA Burkina Faso
BGD Bangladesh
BGR Bulgaria
BHR Bahrain
BHS Bahamas
BIH Bosnia and Herzegovina
BLM Saint Barthélemy
BLR Belarus
BLZ Belize
BMU Bermuda
BOL Bolivia, Plurinational State of
BRA Brazil
BRB Barbados
BRN Brunei Darussalam
BTN Bhutan
BVT Bouvet Island
BWA Botswana
CAF Central African Republic
CAN Canada
CCK Cocos (Keeling) Islands
CHE Switzerland
CHL Chile
CHN China
CIV Côte d'Ivoire
CMR Cameroon
COD Congo, the Democratic Republic of the
COG Congo
COK Cook Islands
COL Colombia
COM Comoros
CPV Cape Verde
CRI Costa Rica
CUB Cuba
CUW Curaçao
CXR Christmas Island
CYM Cayman Islands
CYP Cyprus
CZE Czech Republic
DEU Germany
DJI Djibouti
DMA Dominica
DNK Denmark
DOM Dominican Republic
DZA Algeria
ECU Ecuador
EGY Egypt
ERI Eritrea
ESH Western Sahara
ESP Spain
EST Estonia
ETH Ethiopia
FIN Finland
FJI Fiji
FLK Falkland Islands (Malvinas)
FRA France
FRO Faroe Islands
FSM Micronesia, Federated States of
GAB Gabon
GBR United Kingdom
GEO Georgia
GGY Guernsey
GHA Ghana
GIB Gibraltar
GIN Guinea
GLP Guadeloupe
GMB Gambia
GNB Guinea-Bissau
GNQ Equatorial Guinea
GRC Greece
GRD Grenada
GRL Greenland
GTM Guatemala
GUF French Guiana
GUM Guam
GUY Guyana
HKG Hong Kong
HMD Heard Island and McDonald Islands
HND Honduras
HRV Croatia
HTI Haiti
HUN Hungary
IDN Indonesia
IMN Isle of Man
IND India
IOT British Indian Ocean Territory
IRL Ireland
IRN Iran, Islamic Republic of
IRQ Iraq
ISL Iceland
ISR Israel
ITA Italy
JAM Jamaica
JEY Jersey
JOR Jordan
JPN Japan
KAZ Kazakhstan
KEN Kenya
KGZ Kyrgyzstan
KHM Cambodia
KIR Kiribati
KNA Saint Kitts and Nevis
KOR Korea, Republic of
KWT Kuwait
LAO Lao People's Democratic Republic
LBN Lebanon
LBR Liberia
LBY Libya
LCA Saint Lucia
LIE Liechtenstein
LKA Sri Lanka
LSO Lesotho
LTU Lithuania
LUX Luxembourg
LVA Latvia
MAC Macao
MAF Saint Martin (French part)
MAR Morocco
MCO Monaco
MDA Moldova, Republic of
MDG Madagascar
MDV Maldives
MEX Mexico
MHL Marshall Islands
MKD Macedonia, the former Yugoslav Republic of
MLI Mali
MLT Malta
MMR Myanmar
MNE Montenegro
MNG Mongolia
MNP Northern Mariana Islands
MOZ Mozambique
MRT Mauritania
MSR Montserrat
MTQ Martinique
MUS Mauritius
MWI Malawi
MYS Malaysia
MYT Mayotte
NAM Namibia
NCL New Caledonia
NER Niger
NFK Norfolk Island
NGA Nigeria
NIC Nicaragua
NIU Niue
NLD Netherlands
NOR Norway
NPL Nepal
NRU Nauru
NZL New Zealand
OMN Oman
PAK Pakistan
PAN Panama
PCN Pitcairn
PER Peru
PHL Philippines
PLW Palau
PNG Papua New Guinea
POL Poland
PRI Puerto Rico
PRK Korea, Democratic People's Republic of
PRT Portugal
PRY Paraguay
PSE Palestinian Territory, Occupied
PYF French Polynesia
QAT Qatar
REU Réunion
ROU Romania
RUS Russian Federation
RWA Rwanda
SAU Saudi Arabia
SDN Sudan
SEN Senegal
SGP Singapore
SGS South Georgia and the South Sandwich Islands
SHN Saint Helena, Ascension and Tristan da Cunha
SJM Svalbard and Jan Mayen
SLB Solomon Islands
SLE Sierra Leone
SLV El Salvador
SMR San Marino
SOM Somalia
SPM Saint Pierre and Miquelon
SRB Serbia
SSD South Sudan
STP Sao Tome and Principe
SUR Suriname
SVK Slovakia
SVN Slovenia
SWE Sweden
SWZ Swaziland
SXM Sint Maarten (Dutch part)
SYC Seychelles
SYR Syrian Arab Republic
TCA Turks and Caicos Islands
TCD Chad
TGO Togo
THA Thailand
TJK Tajikistan
TKL Tokelau
TKM Turkmenistan
TLS Timor-Leste
TON Tonga
TTO Trinidad and Tobago
TUN Tunisia
TUR Turkey
TUV Tuvalu
TWN Taiwan, Province of China
TZA Tanzania, United Republic of
UGA Uganda
UKR Ukraine
UMI United States Minor Outlying Islands
URY Uruguay
USA United States
UZB Uzbekistan
VAT Holy See (Vatican City State)
VCT Saint Vincent and the Grenadines
VEN Venezuela, Bolivarian Republic of
VGB Virgin Islands, British
VIR Virgin Islands, U.S.
VNM Viet Nam
VUT Vanuatu
WLF Wallis and Futuna
WSM Samoa
YEM Yemen
ZAF South Africa
ZMB Zambia
ZWE Zimbabwe

0069-HospitalService

Code Description
100 General Surgery
101 Urology
107 Vascular Surgery
110 Trauma and Orthopaedics
120 Ear Nose and Throat
130 Ophthalmology
140 Oral Surgery
141 Restorative Dentistry
142 Paediatric Dentistry
143 Orthodontics
145 Oral and Maxillofacial Surgery
146 Endodontics
147 Periodontics
148 Prosthodontics
149 Surgical Dentistry
150 Neurosurgery
160 Plastic Surgery
170 Cardiothoracic Surgery
171 Paediatric Surgery
191 Pain Management (Retired 1 April 2004)
180 Emergency Medicine
190 Anaesthetics
192 Intensive Care Medicine
200 Aviation and Space Medicine
300 General Internal Medicine
301 Gastroenterology
302 Endocrinology and Diabetes
303 Clinical Haematology
304 Clinical Physiology
305 Clinical Pharmacology
310 Audio Vestibular Medicine
311 Clinical Genetics
312 CLINICAL CYTOGENETICS and MOLECULAR GENETICS (Retired 1 April 2010) National Code 312 is retained for CONSULTANTS qualified in this Main Specialty prior to 1 April 2010
313 Clinical Immunology
314 Rehabilitation Medicine
315 Palliative Medicine
317 Allergy
320 Cardiology
321 Paediatric Cardiology
325 Sport and Exercise Medicine
326 Acute Internal Medicine
330 Dermatology
340 Respiratory Medicine
350 Infectious Diseases
352 Tropical Medicine
360 Genitourinary Medicine
361 Renal Medicine
370 Medical Oncology
371 Nuclear Medicine
400 Neurology
401 Clinical Neurophysiology
410 Rheumatology
420 Paediatrics
421 Paediatric Neurology
430 Geriatric Medicine
450 Dental Medicine
451 Special Care Dentistry
460 Medical Ophthalmology
500 Obstetrics and Gynaecology
501 Obstetrics
502 Gynaecology
504 Community Sexual and Reproductive Health
510 Antenatal Clinic (Retired 1 April 2004)
520 Postnatal Clinic (Retired 1 April 2004)
560 Midwifery
600 General Medical Practice
601 General Dental Practice
610 Maternity Function (Retired 1 April 2004)
620 Other than Maternity (Retired 1 April 2004)
700 Learning Disability
710 Adult Mental Illness
711 Child and Adolescent Psychiatry
712 Forensic Psychiatry
713 Medical Psychotherapy
715 Old Age Psychiatry
800 Clinical Oncology
810 Radiology
820 General Pathology
821 Blood Transfusion
822 Chemical Pathology
823 Haematology
824 Histopathology
830 Immunopathology
831 Medical Microbiology and Virology
832 Neuropathology (Retired 1 April 2004)
833 Medical Microbiology
834 Medical Virology
900 Community Medicine
901 Occupational Medicine
902 Community Health Services Dental
903 Public Health Medicine
904 Public Health Dental
950 Nursing
960 Allied Health Professional
990 Joint Consultant Clinics (Retired 1 April 2004)

0092-Re-AdmissionIndicator

Code Description
R Re-admission

0112-DischargeDisposition

Code Description
3 No Follow Up Required
2 GP Follow Up
12 Left Department Before Treatment
13 Left Department - Refused Treatment
14 Other
4 Referred to AandE Clinic
6 Referral to Outpatient Clinic
5 Stillbirth
11 Referred to Other Health Care Profession
7 Transferred to Other Health Care Provide
10 Died in Department
1 Admitted as inpatient
8 Not applicable
9 Not known

0113-DischargedToLocation

Code Description
19 Usual Place of Residence
29 Temporary Place of Residence
30 Repatriation from high security psychiatric accommodation in an NHS hospital provider (NHS trust)
37 Court
38 Penal establishment or police station
48 High Security Psychiatric Hospital Scotland
49 NHS other hospital provider - high security psychiatric accommodation
50 NHS other hospital provider - medium secure unit
51 NHS other hospital provider - ward for general patients or the younger physically disabled
52 NHS other hospital provider - ward for maternity patients or neonates
53 NHS other hospital provider - ward for patients who are mentally ill or have learning disabilities
54 NHS run care home
65 Local Authority residential accommodation ie where care is provided
66 Local Authority foster care
79 Not applicable - patient died or still birth
84 Non-NHS run hospital - medium secure unit
85 Non-NHS (other than Local Authority) run care home
87 Non-NHS run hospital
88 Non-NHS (other than Local Authority) run Hospice
98 Not applicable
99 Not known

0125-ValueType

Code Description
CE Coded Entry
ED Encapsulated Data
FT Formatted Text (Display)
NM Numeric
SN Structured Numeric
ST String Data.
TX Text Data (Display)

0127-AllergenType

Code Description
AA Animal Allergy
DA Drug allergy
EA Environmental Allergy
FA Food allergy
IC Inorganic Chemicals
IN Insects
IO Iodine
LA Pollen Allergy
MA Miscellaneous allergy
MC Miscellaneous contraindication
OC Organic Chemicals
PA Plant Allergy

0128-AllergySeverity

Code Description
0 Unknown
1 Insignificant/Minimal
3 Mild
5 Moderate
7 Moderate-Severe
9 Very Severe

0228-DiagnosisClassification

Code Description
C Consultation
D Diagnosis
I Invasive procedure not classified elsewhere (I.V., catheter, etc.)
M Medication (antibiotic)
O Other
R Radiological scheduling (not using ICDA codes)
S Sign and symptom
T Tissue diagnosis

0007-AdmissionType

Code Description
11 Waiting list
12 Booked
13 Planned
21 Accident and emergency or dental casualty department of the Health Care Provider
22 GENERAL PRACTITIONER: after a request for immediate admission has been made direct to a Hospital Provider, i.e. not through a Bed bureau, by a GENERAL PRACTITIONER or deputy
23 Bed bureau
24 Consultant Clinic, of this or another Health Care Provider
28 Other means
31 Admitted ante-partum
32 Admitted post-partum
81 Transfer of any admitted PATIENT from other Hospital Provider other than in an emergency
82 The birth of a baby in this Health Care Provider
83 Baby born outside the Health Care Provider except when born at home as intended.
98 Not applicable
99 Not known
2A Emergency Admission: Emergency Care Department of another provider where the patient had not been admitted
2B Emergency Admission: Transfer of an admitted patient from another Hospital Provider in an emergency
2C Emergency Admission: Baby born at home as intended
2D Emergency Admission: Other emergency admission

DDS-HL7v2-EventType

Code Description
A28 ADT A28 - create patient record
A31 ADT A31 - update patient record
A40 ADT A40 - merge patient records
A05 ADT A05 - pre-admit a patient
A38 ADT A38 - cancel a pre-admit
A01 ADT A01 - admit a patient
A11 ADT A11 - cancel admit
A02 ADT A02 - transfer a patient
A12 ADT A12 - cancel transfer
A03 ADT A03 - discharge a patient
A13 ADT A13 - cancel discharge
R01 ORU R01 - send observations

DDS-HL7v2-MessageType

Code Description
ADT ADT message
ORU ORU message
ACK General acknowledgment message

DDS-HL7v2-AckCode

Code Description
AA Application Accept
AE Application Error
AR Application Reject

0062-EventReason

Code Description
01 Patient request
02 Physician/health practitioner order
03 Census management

DDS-ResultStatus

Code Description
C Correction to results
F Final results; results stored and verified. Can only be changed with a corrected result.

DDS-AdmissionSource

Code Description
79 Babies born in or on the way to hospital
41 Court
66 Local authority foster care
65 Local authority residential accommodation i.e. where care is provided
54 NHS run care home
53 NHS other hospital provider - ward for patients who are mentally ill or have learning disabilities
49 NHS other hospital provider - high security psychiatric accommodation in an NHS hospital provider (NHS trust or NHS foundation trust)
51 NHS other hospital provider - ward for general patients or the younger physically disabled or emergency care department
52 NHS other hospital provider - ward for maternity patients or neonates
87 Non-NHS run hospital
85 Non-NHS (other than local authority) run care home
88 Non-NHS (other than local authority) run hospice
39 Penal establishment, court, or police station / police custody suite
29 Temporary place of residence when usually resident elsewhere (e.g. hotels, residential educational establishments)
19 Usual place of residence unless listed below, for example, a private dwelling whether owner occupied or owned by local authority, housing association or other landlord. This includes wardened accommodation but not residential accommodation where health care is provided. It also includes patients with no fixed abode.

NHSEOrganisationRole

0074-DiagnosticServiceSectionID

HL7v3-EncounterType

FHIR-ProcedureCode

[TODO - is this the right valueset to use?]