Publisher API Code Sets: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
No edit summary
(Latest Version)
 
(21 intermediate revisions by one other user not shown)
Line 1: Line 1:
This page details the various code sets that are supported by the DDS Publisher API.
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 [https://isd.digital.nhs.uk/trud3/user/guest/group/41/pack/34 ITK HL7 V2 standard] (version 1.1)


=== 0001-AdministrativeSex ===
=== AdministrativeSex ===
{| class="wikitable"
{| class="wikitable"
!Code
!Code
!Description
!Description
|-
|-
|0
|U
|Not Known
|Unknown
|-
|-
|1
|M
|Male
|Male
|-
|-
|2
|F
|Female
|Female
|-
|-
|9
|I
|Not specified
|Other
|}
|}
=== 0002-MaritalStatus ===
=== PatientClass ===
{| class="wikitable"
{| class="wikitable"
!Code
!Code
!Description
!Description
|-
|D
|Divorced / Person whose Civil Partnership has been dissolved
|-
|M
|Married / Civil Partner
|-
|N
|Not disclosed
|-
|P
|Separated
|-
|S
|Single
|-
|W
|Widowed / Surviving Civil Partner
|-
|8
|Not applicable
|-
|9
|Not known
|}
=== 0004-PatientClass ===
{| class="wikitable"
!Code
!Description
|-
|B
|Obstetrics
|-
|C
|Commercial Account
|-
|-
|E
|E
Line 63: Line 28:
|I
|I
|Inpatient
|Inpatient
|-
|N
|Not Applicable
|-
|-
|O
|O
|Outpatient
|Outpatient
|-
|P
|Preadmit
|-
|R
|Recurring patient
|-
|U
|Unknown
|-
|W
|Waiting List
|}
=== 0006-Religion ===
{| class="wikitable"
!Code
!Description
|-
|A1
|Baha'i
|-
|B1
|Buddhist
|-
|B2
|Mahayana Buddhist
|-
|B3
|New Kadampa Tradition Buddhist
|-
|B4
|Nichiren Buddhist
|-
|B5
|Pure Land Buddhist
|-
|B6
|Theravada Buddhist
|-
|B7
|Tibetan Buddhist
|-
|B8
|Zen Buddhist
|-
|C1
|Christian
|-
|C2
|Amish
|-
|C3
|Anabaptist
|-
|C4
|Anglican
|-
|C5
|Apostolic Pentecostalist
|-
|C6
|Armenian Catholic
|-
|C7
|Armenian Orthodox
|-
|C8
|Baptist
|-
|C9
|Brethren
|-
|C10
|Bulgarian Orthodox
|-
|C11
|Calvinist
|-
|C12
|Catholic: Not Roman Catholic
|-
|C13
|Celtic Christian
|-
|C14
|Celtic Orthodox Christian
|-
|C15
|Chinese Evangelical Christian
|-
|C16
|Christadelphian
|-
|C17
|Christian Existentialist
|-
|C18
|Christian Humanist
|-
|C19
|Christian Scientists
|-
|C20
|Christian Spiritualist
|-
|C21
|Church in Wales
|-
|C22
|Church of England
|-
|C23
|Church of God of Prophecy
|-
|C24
|Church of Ireland
|-
|C25
|Church of Scotland
|-
|C26
|Congregationalist
|-
|C27
|Coptic Orthodox
|-
|C28
|Eastern Catholic
|-
|C29
|Eastern Orthodox
|-
|C30
|Elim Pentecostalist
|-
|C31
|Ethiopian Orthodox
|-
|C32
|Evangelical Christian
|-
|C33
|Exclusive Brethren
|-
|C34
|Free Church
|-
|C35
|Free Church of Scotland
|-
|C36
|Free Evangelical Presbyterian
|-
|C37
|Free Methodist
|-
|C38
|Free Presbyterian
|-
|C39
|French Protestant
|-
|C40
|Greek Catholic
|-
|C41
|Greek Orthodox
|-
|C42
|Independent Methodist
|-
|C43
|Indian Orthodox
|-
|C44
|Jehovah's Witness
|-
|C45
|Judaic Christian
|-
|C46
|Lutheran
|-
|C47
|Mennonite
|-
|C48
|Messianic Jew
|-
|C49
|Methodist
|-
|C50
|Moravian
|-
|C51
|Mormon
|-
|C52
|Nazarene Church Synonym: Nazarene
|-
|C53
|New Testament Pentacostalist
|-
|C54
|Nonconformist
|-
|C55
|Old Catholic
|-
|C56
|Open Brethren
|-
|C57
|Orthodox Christian
|-
|C58
|Pentecostalist Synonym: Pentacostal Christian
|-
|C59
|Presbyterian
|-
|C60
|Protestant
|-
|C61
|Plymouth Brethren
|-
|C62
|Quaker
|-
|C63
|Rastafari
|-
|C64
|Reformed Christian
|-
|C65
|Reformed Presbyterian
|-
|C66
|Reformed Protestant
|-
|C67
|Roman Catholic
|-
|C68
|Romanian Orthodox
|-
|C69
|Russian Orthodox
|-
|C70
|Salvation Army Member
|-
|C71
|Scottish Episcopalian
|-
|C72
|Serbian Orthodox
|-
|C73
|Seventh Day Adventist
|-
|C74
|Syrian Orthodox
|-
|C75
|Ukrainian Catholic
|-
|C76
|Ukrainian Orthodox
|-
|C77
|Uniate Catholic
|-
|C78
|Unitarian
|-
|C79
|United Reform
|-
|C80
|Zwinglian
|-
|D1
|Hindu
|-
|D2
|Advaitin Hindu
|-
|D3
|Arya Samaj Hindu
|-
|D4
|Shakti Hindu
|-
|D5
|Shiva Hindu
|-
|D6
|Vaishnava Hindu Synonym: Hare Krishna
|-
|E1
|Jain
|-
|F1
|Jewish
|-
|F2
|Ashkenazi Jew
|-
|F3
|Haredi Jew
|-
|F4
|Hasidic Jew
|-
|F5
|Liberal Jew
|-
|F6
|Masorti Jew
|-
|F7
|Orthodox Jew
|-
|F8
|Reform Jew
|-
|G1
|Muslim
|-
|G2
|Ahmadi
|-
|G3
|Druze
|-
|G4
|Ismaili Muslim
|-
|G5
|Shi'ite Muslim
|-
|G6
|Sunni Muslim
|-
|H1
|Pagan
|-
|H2
|Asatruar
|-
|H3
|Celtic Pagan
|-
|H4
|Druid
|-
|H5
|Goddess
|-
|H6
|Heathen
|-
|H7
|Occultist
|-
|H8
|Shaman
|-
|H9
|Wiccan
|-
|I1
|Sikh
|-
|J1
|Zoroastrian
|-
|K1
|Agnostic
|-
|K2
|Ancestral Worship
|-
|K3
|Animist
|-
|K4
|Anthroposophist
|-
|K5
|Black Magic
|-
|K6
|Brahma Kumari
|-
|K7
|British Israelite
|-
|K8
|Chondogyo
|-
|K9
|Confucianist
|-
|K10
|Deist
|-
|K11
|Humanist
|-
|K12
|Infinite Way
|-
|K13
|Kabbalist
|-
|K14
|Lightworker
|-
|K15
|New Age Practitioner
|-
|K16
|Native American Religion
|-
|K17
|Pantheist
|-
|K18
|Peyotist
|-
|K19
|Radha Soami Synonym: Sant Mat
|-
|K20
|Religion (Other Not Listed)
|-
|K21
|Santeri
|-
|K22
|Satanist
|-
|K23
|Scientologist
|-
|K24
|Secularist
|-
|K25
|Shumei
|-
|K26
|Shinto
|-
|K27
|Spiritualist
|-
|K28
|Swedenborgian Synonym: Neo-Christian
|-
|K29
|Taoist
|-
|K30
|Unitarian-Universalist
|-
|K31
|Universalist
|-
|K32
|Vodun
|-
|K33
|Yoruba
|-
|L1
|Atheist
|-
|L2
|Not Religious
|-
|M1
|Religion not given - PATIENT refused
|-
|N1
|Religion Unknown
|}
=== 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
|}
=== 0189-EthnicGroup ===
{| class="wikitable"
!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
|-
|Z
|Not stated
|-
|99
|Not known
|}
=== 0136-Yes/noIndicator  ===
{| class="wikitable"
!Code
!Description
|-
|N
|No
|}
|}
=== 0136-Yes/noIndicator ===
=== 0136-Yes/noIndicator ===
Line 1,980: Line 812:
|ZWE
|ZWE
|Zimbabwe
|Zimbabwe
|}
=== NHSStatusIndicatorCodes ===
{| class="wikitable"
!Code
!Description
|-
|1
|Number present and verified
|-
|2
|Number present but not traced
|-
|3
|Trace required
|-
|4
|Trace attempted - No match or multiple match found
|-
|5
|Trace needs to be resolved - (NHS NUMBER or PATIENT detail conflict)
|-
|6
|Trace in progress
|-
|7
|Number not present and trace not required
|-
|8
|Trace postponed (baby under six weeks old)
|}
=== 0069-HospitalService ===
{| class="wikitable"
!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 ===
=== 0092-Re-AdmissionIndicator ===
Line 2,307: Line 820:
|R
|R
|Re-admission
|Re-admission
|}
=== 0023-AdmitSource ===
{| class="wikitable"
!Code
!Description
|-
|19
|Usual place of residence
|-
|29
|Temporary place of residence when usually resident elsewhere (e.g. hotels, residential educational establishments)
|-
|39
|Penal establishment, Court, or police station
|-
|49
|NHS other hospital provider - high security psychiatric accommodation in an NHS hospital provider (NHS trust)
|-
|51
|NHS other hospital provider - ward for general patients or the younger physically disabled or A & E department
|-
|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
|Babies born in or on the way to hospital
|-
|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
|}
=== 0009-AmbulatoryStatus ===
{| class="wikitable"
!Code
!Description
|-
|A0
|No functional limitations
|-
|A1
|Ambulates with assistive device
|-
|A2
|Wheelchair/stretcher bound
|-
|A3
|Comatose; non-responsive
|-
|A4
|Disoriented
|-
|A5
|Vision impaired
|-
|A6
|Hearing impaired
|-
|A7
|Speech impaired
|-
|A8
|Non-English speaking
|-
|A9
|Functional level unknown
|-
|B1
|Oxygen therapy
|-
|B2
|Special equipment (tubes, IVs, catheters)
|-
|B3
|Amputee
|-
|B4
|Mastectomy
|-
|B5
|Paraplegic
|-
|B6
|Pregnant
|}
=== 0099-VIPIndicator ===
{| class="wikitable"
!Code
!Description
|-
|I
|Invalid
|-
|N
|Not stop noted
|-
|S
|Sensitive
|-
|Y
|Stop noted
|}
=== 0112-DischargeDisposition ===
{| class="wikitable"
!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 ===
{| class="wikitable"
!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
|}
=== 0114-DietType ===
{| class="wikitable"
!Code
!Description
|-
|1
|Non-specific
|-
|02A
|Healthcare Prescribed - Gluten Free Diet
|-
|02B
|Healthcare Prescribed - Wheat Free Diet
|-
|02C
|Healthcare Prescribed - Diabetic Diet
|-
|02Z
|Healthcare Prescribed - Other (specify)
|-
|03A
|Non Healthcare Prescribed - Weight loss diet
|-
|03B
|Non Healthcare Prescribed - Weight gain diet
|-
|03C
|Non Healthcare Prescribed - Vegetarian diet
|-
|03D
|Non Healthcare Prescribed - Vegan diet
|-
|03E
|Non Healthcare Prescribed - Halal Diet
|-
|03F
|Non Healthcare Prescribed - Kosher Diet
|-
|03Z
|Non Healthcare Prescribed - Other (specify)
|-
|98
|Other (specify)
|-
|99
|Not known
|}
=== 0217-VisitPriorityCode  ===
{| class="wikitable"
!Code
!Description
|-
|1
|Emergency
|-
|2
|Urgent
|-
|3
|Elective
|}
=== 0430-ModeOfArrivalCode ===
{| class="wikitable"
!Code
!Description
|-
|A
|Ambulance
|-
|C
|Car
|-
|F
|On foot
|-
|H
|Helicopter
|-
|O
|Other
|-
|P
|Public Transport
|-
|U
|Unknown
|}
=== 0063-Relationship ===
{| class="wikitable"
!Code
!Description
|-
|1
|Spouse
|-
|10
|Dependant
|-
|11
|Non-dependant
|-
|12
|Mother
|-
|13
|Father
|-
|14
|Sister
|-
|15
|Brother
|-
|16
|Relative
|-
|17
|Proxy - Contact
|-
|18
|Proxy - Communication
|-
|19
|Proxy - Contact and Communication
|-
|2
|Partner
|-
|20
|Carer
|-
|21
|Self
|-
|3
|Parent
|-
|4
|Next of kin
|-
|5
|Guardian
|-
|6
|Foster parent
|-
|61
|Step parent
|-
|62
|Polygamous partner
|-
|9
|Child
|-
|98
|Not Known
|-
|99
|Not specified
|}
|}
=== 0125-ValueType ===
=== 0125-ValueType ===
Line 2,711: Line 825:
!Code
!Code
!Description
!Description
|-
|AD
|Address
|-
|-
|CE
|CE
|Coded Entry
|Coded Entry
|-
|CF
|Coded Element With Formatted Values
|-
|CK
|Composite ID With Check Digit
|-
|CN
|Composite ID And Name
|-
|CP
|Composite Price
|-
|CX
|Extended Composite ID With Check Digit
|-
|DT
|Date
|-
|-
|ED
|ED
Line 2,741: Line 834:
|FT
|FT
|Formatted Text (Display)
|Formatted Text (Display)
|-
|MO
|Money
|-
|-
|NM
|NM
|Numeric
|Numeric
|-
|PN
|Person Name
|-
|RP
|Reference Pointer
|-
|-
|SN
|SN
Line 2,759: Line 843:
|ST
|ST
|String Data.
|String Data.
|-
|TM
|Time
|-
|TN
|Telephone Number
|-
|TS
|Time Stamp (Date & Time)
|-
|-
|TX
|TX
|Text Data (Display)
|Text Data (Display)
|-
|XAD
|Extended Address
|-
|XCN
|Extended Composite Name And Number For Persons
|-
|XON
|Extended Composite Name And Number For Organizations
|-
|XPN
|Extended Person Name
|-
|XTN
|Extended Telecommunications Number
|}
=== 0078-AbnormalFlags ===
{| class="wikitable"
!Code
!Description
|-
|<
|Below absolute low-off instrument scale
|-
|>
|Above absolute high-off instrument scale
|-
|A
|Abnormal (applies to non-numeric results)
|-
|AA
|Very abnormal (applies to non-numeric units, analogous to panic limits for numeric units)
|-
|B
|Better--use when direction not relevant
|-
|D
|Significant change down
|-
|H
|Above high normal
|-
|HH
|Above upper panic limits
|-
|I
|Intermediate. Indicates for microbiology susceptibilities only.
|-
|L
|Below low normal
|-
|LL
|Below lower panic limits
|-
|MS
|Moderately susceptible. Indicates for microbiology susceptibilities only.
|-
|N
|Normal (applies to non-numeric results)
|-
|null
|No range defined, or normal ranges don't apply
|-
|R
|Resistant. Indicates for microbiology susceptibilities only.
|-
|S
|Susceptible. Indicates for microbiology susceptibilities only.
|-
|U
|Significant change up
|-
|VS
|Very susceptible. Indicates for microbiology susceptibilities only.
|-
|W
|Worse--use when direction not relevant
|-
|CC
|Highly Significant Change
|-
|UU
|Highly Significant Change Up
|-
|DD
|Highly Significant Change Down
|-
|C
|Significant Change
|}
|}
=== 0127-AllergenType ===
=== 0127-AllergenType ===
Line 2,924: Line 910:
|9
|9
|Very Severe
|Very Severe
|}
=== 0052-DiagnosisType ===
{| class="wikitable"
!Code
!Description
|-
|A
|Admitting
|-
|F
|Final
|-
|W
|Working
|}
=== 0359-DiagnosisPriority ===
{| class="wikitable"
!Code
!Description
|-
|0
|Not included in diagnosis ranking
|-
|1
|The primary diagnosis
|-
|2
|For ranked secondary diagnoses
|}
|}
=== 0228-DiagnosisClassification ===
=== 0228-DiagnosisClassification ===
Line 2,982: Line 940:
|Tissue diagnosis
|Tissue diagnosis
|}
|}
=== DDS-HL7v2-EventType ===
{| class="wikitable"
!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 ===
{| class="wikitable"
!Code
!Description
|-
|ADT
|ADT message
|-
|ORU
|ORU message
|-
|ACK
|General acknowledgment message
|}
=== DDS-HL7v2-AckCode ===
{| class="wikitable"
!Code
!Description
|-
|AA
|Application Accept
|-
|AE
|Application Error
|-
|AR
|Application Reject
|}
=== 0062-EventReason ===
{| class="wikitable"
!Code
!Description
|-
|01
|Patient request
|-
|02
|Physician/health practitioner order
|-
|03
|Census management
|}
=== DDS-ResultStatus ===
{| class="wikitable"
!Code
!Description
|-
|C
|Correction to results
|-
|F
|Final results; results stored and verified. Can only be changed with a corrected result.
|}
=== NHSEOrganisationRole ===
* URL - https://directory.spineservices.nhs.uk/STU3/CodeSystem/ODSAPI-OrganizationRole-1
* Version - 1.24.0
=== 0074-DiagnosticServiceSectionID ===
* URL - http://terminology.hl7.org/CodeSystem/v2-0074
* Version - 2.9
=== HL7v3-EncounterType ===
* URL - http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
* Version - 2014-03-26
=== FHIR-ProcedureCode ===
[TODO - is this the right valueset to use?]
* URL - http://hl7.org/fhir/ValueSet/procedure-code
* Version - 4.0.1

Latest revision as of 13:40, 10 January 2022

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)

AdministrativeSex

Code Description
U Unknown
M Male
F Female
I Other

PatientClass

Code Description
E Emergency
I Inpatient
O Outpatient

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

0092-Re-AdmissionIndicator

Code Description
R Re-admission

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

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.

NHSEOrganisationRole

0074-DiagnosticServiceSectionID

HL7v3-EncounterType

FHIR-ProcedureCode

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

Retrieved from ‘https://wiki.discoverydataservice.org/index.php?title=Publisher_API_Code_Sets&oldid=5894’