Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release NZ

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Questionnaire: Sleep Service Questionnaire

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/Questionnaire/DHOSleepQuestionnaire Version: 1.0
Active as of 2026-05-19 Computable Name: DHOSleepQuestionnaire
Other Identifiers: DHOSleepQuestionnaire (use: official, )

The Questionnaire collects patient-reported sleep symptoms, habits, and risk factors to support assessment of sleep disorders such as sleep apnoea.

Enables clinicians to evaluate risk and guide further investigation and care.

Structure
LinkIDTextCardinalityTypeFlagsDescription & Constraintsdoco
.. DHOSleepQuestionnaireThe Questionnaire collects patient-reported sleep symptoms, habits, and risk factors to support assessment of sleep disorders such as sleep apnoea.Questionnairehttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/Questionnaire/DHOSleepQuestionnaire#1.0
... introWe have received a referral to our Sleep Service from your doctor. Please note we cannot consider your referral/sleep study results until we have this information completed by you.0..1group
.... measurements1. Measurements0..1display
.... weightWeight (kg)0..1decimal
.... heightHeight (cm)0..1decimal
.... neckNeck circumference (cm) - Please use tape measure provided0..1decimal
.... denturesDo you have dentures? (full or partial)0..1string
... sleep-apnoea2. Sleep Apnoea0..1group
.... snoringAccording to what others have told you, how often do you think you snore?0..1choiceOptions: 5 options
.... chokingSelect all that apply0..*choiceOptions: 5 options
... daytime3. Sleepiness during the Day0..1group
.... refreshedDo you wake feeling refreshed?0..1choiceOptions: 5 options
.... sleepyHow often do you feel sleepy and want to fall asleep in the daytime?0..1choiceOptions: 5 options
.... OftenNapsDo you often have a nap during the day?0..1string
... epworth4. Epworth Sleepiness Score0..1group
.... fallasleepHow likely are you to doze off or fall asleep in the following situations - in contrast to feeling tired. This refers to your usual way of life in recent times. Even if you have not done some of these things recently, try to work out how they would have affected you.0..1display
.... sittingandreadingSitting & Reading0..1choiceOptions: 4 options
.... watchingTVWatching TV0..1choiceOptions: 4 options
.... sittingactivitySitting inactive in a public place (theatre, meeting, etc)0..1choiceOptions: 4 options
.... incarforanhourA passenger in a car for one hour0..1choiceOptions: 4 options
.... lyingdownLying down in the afternoon (if circumstances permit)0..1choiceOptions: 4 options
.... sittingtalkingSitting talking to someone0..1choiceOptions: 4 options
.... sittingQuitelySitting quietly after lunch without alcohol0..1choiceOptions: 4 options
.... trafficlightsIn a car whilst stopped in traffic or at traffic lights0..1choiceOptions: 4 options
.... totalscoreTOTAL SCORE out of 24:0..1integericonicon
... medical5. Medical History: Select all that apply.0..1group
.... hayfeverSelect all that apply:0..*choiceOptions: 7 options
.... bpHigh blood pressure0..1boolean
.... controldifficultyIf yes, is it difficult to control?0..1booleanEnable When: bp =
.... diabetesDiabetes0..1boolean
.... yescontroldifficultyIf yes, is it difficult to control?0..1booleanEnable When: diabetes =
.... epilepsyEpilepsy0..1boolean
.... neurodiseaseIf yes, is it difficult to control?0..1stringEnable When: epilepsy =
.... depressionDepression0..1boolean
.... depression_11If yes, is it difficult to control?0..1booleanEnable When: depression =
... lifestyle6. Lifestyle0..1group
.... breathDo you get short of breath during your daily activities?0..1boolean
.... occupationWhat is your Occupation?0..1string
.... job-riskHas your job been at risk due to sleepiness or loss of concentration?0..1boolean
.... licencedetailsIf you have a vehicle licence, what classes and endorsements does it have?0..1group
..... licenseclassClass:0..1choiceOptions: 6 options
..... licenseendorsementEndorcements:0..*choiceOptions: 9 options
.... dozedwhiledrivingHave you ever dozed at the wheel?0..1boolean
.... dozingdateWhen did this happen?0..1dateEnable When: dozedwhiledriving =
.... dozingdetailsTell us about it:0..1stringEnable When: dozedwhiledriving =
.... CaffeineIntakeCaffeine intake (amount per day especially mid-afternoon to late evening)0..1group
..... TeaIntakeTea:0..1string
..... coffieeIntakeCoffee:0..1string
..... lifeStyleDrinksCoke, Pepsi, life style drinks:0..1string
..... EnergyDrinksEnergy drinks:0..1string
..... ChocolateDrinksBarsChocolate drinks or bars:0..1string
.... AlcholicDrinksHow many alcoholic drinks do you have, on average, per week?0..1string
... SleepHistory7. Previous Sleep Studies0..1group
.... PrevSleepStudyHave you ever had a sleep study?0..1boolean
.... HowLongApproximately how long ago?0..1stringEnable When: PrevSleepStudy =
.... ConductedWas it conducted by:0..1groupEnable When: PrevSleepStudy =
..... PrivateLabPrivate specialist0..1boolean
..... DHOLabSleep Laboratory (Dunedin or Invercargill Hospital)0..1boolean
..... OtherSleepLabAnother Sleep Laboratory, please specify0..1string
... RestlessLeg8. Restless Legs0..1group
.... RestlessLeg1When you try to relax in the evening or sleep at night, do you ever have unpleasant, restless feelings in your legs that can be relieved by walking or movement?0..1boolean
.... RestlessLeg2If yes, please describe your symptoms:0..1stringEnable When: RestlessLeg1 =
... SleepHours9. Hours of Sleep0..1group
.... SleepHours1What time do you go to sleep at night?0..1string
.... SleepHours2What time do you get up in the morning?0..1string
.... SleepHours3Do you do shift work?0..1boolean
.... SleepHours4Please describe your usual hours of work:0..1string
... SleepDifficulty10. Difficulty Sleeping0..1group
.... SleepDifficulty1How long does it take you to get to sleep?0..1string
.... SleepDifficulty2How many times do you usually wake up during the night?0..1string
.... SleepDifficulty3When you wake up, how long does it usually take you to get back to sleep?0..1string
.... SleepDifficulty4Do you have pain that disturbs your sleep?0..1string
... OtherSymptoms11. Other Symptoms0..1group
.... OtherSymptoms1Do you have hallucinations (you see, feel or hear things that aren’t there) while falling asleep or waking up?0..1boolean
.... OtherSymptoms2If yes, please describe your symptoms:0..1stringEnable When: OtherSymptoms1 =
.... OtherSymptoms3Do you ever feel you can’t move or talk at all for 1 to 2 minutes after you wake up?0..1string
.... OtherSymptoms4Do you have sudden bouts of muscle weakness brought on by laughter or emotion?0..1boolean
.... OtherSymptoms5If yes, please describe your symptoms:0..1stringEnable When: OtherSymptoms4 =
.... OtherSymptoms7Do you have any other difficulties with sleep, like nightmares, acting out dreams, sleep walking?0..1boolean
.... OtherSymptoms6If yes, please describe your symptoms:0..1stringEnable When: OtherSymptoms7 =
... Medication12. Medications0..1group
.... listMedsList all medications or attach a sheet with them listed0..1string
... SmokeHistorySmoke History0..1group
.... SmokeHistory1Have you ever smoked:0..1boolean
.... SmokeHistory2Current smoker0..1boolean
.... SmokeHistory3Years smoked:0..1string
.... SmokeHistory4Average per day:0..1string
.... SmokeHistory5Years Quit:0..1string

doco Documentation for this format

Options Sets

Answer options for snoring

  • https://fhir-ig.digital.health.nz/cs/general-scale#Always ("Always")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Often ("Often")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Sometimes ("Sometimes")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Rarely ("Rarely")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Never ("Never")

Answer options for choking

  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#1 ("Has anyone heard you stop breathing in your sleep?")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#2 ("Do you sometimes wake with a choking or gasping sensation?")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#3 ("Does anyone in your family have obstructive sleep apnoea?")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#4 ("Do you get up to go to the toilet more than once a night?")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#5 ("Do you regularly wake with headaches in the morning?")

Answer options for refreshed

  • https://fhir-ig.digital.health.nz/cs/general-scale#Always ("Always")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Often ("Often")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Sometimes ("Sometimes")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Rarely ("Rarely")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Never ("Never")

Answer options for sleepy

  • https://fhir-ig.digital.health.nz/cs/general-scale#Always ("Always")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Often ("Often")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Sometimes ("Sometimes")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Rarely ("Rarely")
  • https://fhir-ig.digital.health.nz/cs/general-scale#Never ("Never")

Answer options for sittingandreading

  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#0 ("0 -- NEVER doze")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#1 ("1 -- SLIGHT chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#2 ("2 -- MODERATE chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#3 ("3 -- HIGH chance of dozing")

Answer options for watchingTV

  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#0 ("0 -- NEVER doze")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#1 ("1 -- SLIGHT chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#2 ("2 -- MODERATE chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#3 ("3 -- HIGH chance of dozing")

Answer options for sittingactivity

  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#0 ("0 -- NEVER doze")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#1 ("1 -- SLIGHT chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#2 ("2 -- MODERATE chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#3 ("3 -- HIGH chance of dozing")

Answer options for incarforanhour

  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#0 ("0 -- NEVER doze")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#1 ("1 -- SLIGHT chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#2 ("2 -- MODERATE chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#3 ("3 -- HIGH chance of dozing")

Answer options for lyingdown

  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#0 ("0 -- NEVER doze")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#1 ("1 -- SLIGHT chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#2 ("2 -- MODERATE chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#3 ("3 -- HIGH chance of dozing")

Answer options for sittingtalking

  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#0 ("0 -- NEVER doze")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#1 ("1 -- SLIGHT chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#2 ("2 -- MODERATE chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#3 ("3 -- HIGH chance of dozing")

Answer options for sittingQuitely

  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#0 ("0 -- NEVER doze")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#1 ("1 -- SLIGHT chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#2 ("2 -- MODERATE chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#3 ("3 -- HIGH chance of dozing")

Answer options for trafficlights

  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#0 ("0 -- NEVER doze")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#1 ("1 -- SLIGHT chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#2 ("2 -- MODERATE chance of dozing")
  • https://fhir-ig.digital.health.nz/cs/EpworthSleepScale#3 ("3 -- HIGH chance of dozing")

Answer options for hayfever

  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#1 ("Hayfever or constantly blocked nose")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#2 ("Previous nasal surgery")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#3 ("Previous airway surgery? (e.g. tonsils removed)")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#4 ("Heart disease (heart failure, heart attack, angina, arrhythmia e.g. atrial fibrillation, stent or bypass?)")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#5 ("Previous stroke or TIA ‘mini-stroke’?")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#6 ("Asthma/COPD")
  • https://fhir-ig.digital.health.nz/cs/sleep-questionnaire-options#7 ("Neuromuscular disease")

Answer options for licenseclass

  • https://fhir-ig.digital.health.nz/cs/Licence-Class#1 ("Class 1 - Car licence")
  • https://fhir-ig.digital.health.nz/cs/Licence-Class#2 ("Class 2 - Medium rigid vehicle licence")
  • https://fhir-ig.digital.health.nz/cs/Licence-Class#3 ("Class 3 - Medium combination vehicle licence")
  • https://fhir-ig.digital.health.nz/cs/Licence-Class#4 ("Class 4 - Heavy rigid vehicle licence")
  • https://fhir-ig.digital.health.nz/cs/Licence-Class#5 ("Class 5 - Heavy combination vehicle licence")
  • https://fhir-ig.digital.health.nz/cs/Licence-Class#6 ("Class 6 - Motorcycle licence")

Answer options for licenseendorsement

  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#P ("P - Passenger")
  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#V ("V - Vehicle Recovery")
  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#D ("D - Dangerous Goods")
  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#F ("F - Forklift")
  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#R ("R - Rollers")
  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#T ("T - Tracks")
  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#W ("W - Wheels")
  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#I ("I - Instructor")
  • https://fhir-ig.digital.health.nz/cs/Vehicle-licence-endorsement#O ("O - Testing Officer")