Health New Zealand Te Whatu Ora Shared Care FHIR API
1.4.8 - release New Zealand flag

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

Questionnaire: Report a Rapid Antigen Test (RAT) result (Experimental)

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/Questionnaire/ConsumerCOVIDRATResultQuestionnaire Version: 1.0.5
Draft as of 2026-11-16 Computable Name: ConsumerCOVIDRatResultQuestionnaire
Other Identifiers: ConsumerCOVIDRATResultQuestionnaire (use: official, period: 7/19/23 --> (ongoing))

Usage:Workflow Setting: Consumer COVID RAT Result Questionnaire

Consumer COVID RAT Result Questionnaire

Report a Rapid Antigen Test (RAT) result

version: 1; Last updated: 2024-01-23 21:19:39+0000; Language: en-NZ

Structure
LinkIDTextCardinalityTypeFlagsDescription & Constraintsdoco
ConsumerCOVIDRatResultQuestionnaireConsumer COVID RAT Result QuestionnaireQuestionnairehttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/Questionnaire/ConsumerCOVIDRATResultQuestionnaire#1.0.5
ConsumerCOVIDRatResultQuestionnaire / metaPhoneNumberPhone number0..1stringDefinition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString
Value Set:
Initial Value: string = Placeholder
ConsumerCOVIDRatResultQuestionnaire / extractPhoneNumberCodenull0..1choiceDefinition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.code.coding[]
Value Set:
Initial Value: Coding = [not stated]#8497 "Text patient com"
ConsumerCOVIDRatResultQuestionnaire / submit-modalEnter result0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / submit-modal / submit-modal-textThe RAT result will be recorded against the official health record for this person.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / nlineModalRATs with other lines0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / nlineModal / nlineModal-otherLinesIf your RAT has other lines or markings, consult the product information leaflet.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / nlineModal / nlineModal-contactHealthlineContact Healthline for further information on 0800 358 5453.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / highRiskModalOther risk factors or medical conditions:0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / highRiskModal / highRiskModal-conditionsList of conditionsdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResultReport a COVID-19 Rapid Antigen Test (RAT) result0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-containernull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-container / reportResult-container-diagramA diagram showing what a positive COVID RAT Result looks likedisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-container / reportResult-container-controlLineIs the control line (C) visible?1..1booleanValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-container / reportResult-container-testLineIs the test line (T) visible?1..1booleanValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-container / reportResult-container-faintLinesFaint linesdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-container / reportResult-container-faintLinesDetailIf a line is faint it should still be recorded as visible.displayValue Set:
A small number of RATs have an ‘N’ linedisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-container / reportResult-container-testDateDay test was taken1..1choiceValue Set:
Options: 8 options
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-container / reportResult.container.onlyThisWeekYou can only report a test taken within the last 7 days.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / reportResult / reportResult-container / reportResult-container-householdContactAre you a household contact of someone who has tested positive for COVID-19?1..1booleanEnable When:
Value Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptomsAntiviral Eligibility0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-containernull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-intronull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-intro / aveSymptoms-container-intro-headingAbout these questionsdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-intro / aveSymptoms-container-intro-textThe following questions will give you an indication of whether you might be eligible to receive free oral COVID-19 antiviral medicine.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-detailsnull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-details / aveSymptoms-container-details-headingSymptoms of COVID-19 can include one or more of the following:displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-details / aveSymptoms-container-details-listSneezing and runny nose, sore throat, body aches, cough, feeling tired, headache, nausea and vomiting, diarrhoea, feverdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-details / aveSymptoms-container-details-moreInfoHeadingVisit this page for more information about COVID-19 symptoms:displayValue Set:
COVID-19 symptomsdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-details / aveSymptoms-container-details-hasSymptomsHave you been experiencing any symptoms?1..1booleanValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-symptomDateHeadingWhen did you start experiencing any of these symptoms?displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveSymptoms / aveSymptoms-container / aveSymptoms-container-symptomDateSelect the date that your symptoms started1..1choiceValue Set:
Options: 8 options
ConsumerCOVIDRatResultQuestionnaire / aveCriteriaAntiviral Eligibility0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-containernull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-intronull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-intro / aveCriteria-container-intro-headingAbout these questionsdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-intro / aveCriteria-container-intro-textThe following questions will give you an indication of whether you might be eligible to receive free oral COVID-19 antiviral medicine.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-vulnerableTextEligible people include:displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-vulnerableContainernull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-vulnerableContainer / aveCriteria-container-vulnerableContainer-isVulnerableDo any of these apply to you?1..1booleanValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-highRiskContainernull0..1groupEnable When: aveCriteria-container-vulnerableContainer-isVulnerable = false
Value Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-highRiskContainer / aveCriteria-container-highRiskContainer-textThese are some reasons you might be at high risk of becoming very sick from COVID-19:displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / aveCriteria / aveCriteria-container / aveCriteria-container-highRiskContainer / aveCriteria-container-highRiskContainer-isHighRiskDo any of these apply to you?1..1booleanValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmitnull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-containernull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-failedResult: Failed. A result could not be determined.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-testResultnull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-testResult / postSubmit-container-testResult-positiveResult: Positive. COVID-19 was detected.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-testResult / postSubmit-container-testResult-negativeResult: Negative. COVID-19 was not detected.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-eligibilitynull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-eligibility / postSubmit-container-eligibility-headingAntiviral eligibilitydisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-eligibility / postSubmit-container-eligibility-maybeEligibleBased on the information you have provided, you may be eligible for free oral COVID-19 antiviral medication.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-eligibility / postSubmit-container-eligibility-notEligibleNot eligibledisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-isolationnull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-isolation / postSubmit-container-isolation-headingRecommended isolationdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-isolation / postSubmit-container-isolation-isolateFiveDaysWe recommend you stay home and isolate for five days from either the date you developed symptoms or the date you tested positive, whichever was earlier. You can leave your recommended isolation on the sixth day if you are feeling well.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-isolation / postSubmit-container-isolation-stayAwayFromFacilitiesRecommended isolationdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-isolation / postSubmit-container-isolation-testDailyForFiveDaysWe recommend you test daily for 5 days and stay at home until 24 hours after your symptoms are gone. If symptoms persist, continue to test.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-nextStepsnull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-nextSteps / postSubmit-container-nextSteps-headingWhat to do nextdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-nextSteps / postSubmit-container-nextSteps-antiviralsTalk to your doctor, healthcare provider, pharmacist, or hauora provider if you think that you, or a member of your whānau, may be eligible for antiviral medicines.You can get a prescription for antivirals from your doctor, healthcare provider, or hauora provider. Some pharmacies can supply antivirals without a prescription.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-nextSteps / postSubmit-container-nextSteps-currentAdvicePositiveContinue to follow current advice: https://info.health.nz/conditions-treatments/infectious-diseases/covid-19/if-you-have-covid-19/displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-nextSteps / postSubmit-container-nextSteps-testAt24And48HoursIf symptoms persist, test again at 24 and 48 hours.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-nextSteps / postSubmit-container-nextSteps-currentAdviceNegativeContinue to follow current advice: https://info.health.nz/conditions-treatments/infectious-diseases/covid-19/testing-and-reporting/displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-nextSteps / postSubmit-container-nextSteps-failedComplete a new RAT and report the result.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-nextSteps / postSubmit-container-nextSteps-failedCall111Call 111 if you find it difficult to breathe, pass out, or find it very difficult to wake up, are blue around the mouth, or very pale and cold, or are having severe chest pain.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-furtherSupportnull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-furtherSupport / postSubmit-container-furtherSupport-headingFurther supportdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-furtherSupport / postSubmit-container-furtherSupport-monitorSymptomsMonitor COVID-19 symptoms and if they get worse or you need medical care, call a healthcare provider or Healthline on 0800 358 5453.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-furtherSupport / postSubmit-container-furtherSupport-testIfSymptomaticMonitor for COVID-19 symptoms, and test if you become symptomatic.If you return a positive RAT, report the result using this form.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-furtherSupport / postSubmit-container-furtherSupport-call111Call 111 if you find it difficult to breathe, pass out, or find it very difficult to wake up, are blue around the mouth, or very pale and cold, or are having severe chest pain.displayValue Set:
ConsumerCOVIDRatResultQuestionnaire / postSubmit / postSubmit-container / postSubmit-container-exitCompleteExitdisplayValue Set:
ConsumerCOVIDRatResultQuestionnaire / extractnull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / extract / extract-resultObservationValuePositiveExtract - test result positive0..1stringDefinition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString
Value Set:
Initial Value: string = DETECTED
ConsumerCOVIDRatResultQuestionnaire / extract / extract-resultObservationValueNegativeExtract - test result negative0..1stringDefinition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString
Value Set:
Initial Value: string = NOT DETECTED
ConsumerCOVIDRatResultQuestionnaire / extract / extract-resultObservationValueFailedExtract - test result failed0..1stringDefinition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString
Value Set:
Initial Value: string = FAILED
ConsumerCOVIDRatResultQuestionnaire / extract / extract-resultObservationCodenull0..1choiceDefinition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.code.coding[]
Value Set:
Initial Value: Coding = [not stated]#XNZ5530 "SARS-CoV-2 RAT Self"
ConsumerCOVIDRatResultQuestionnaire / extract / extract-diagnosticReportnull0..1groupValue Set:
ConsumerCOVIDRatResultQuestionnaire / extract / extract-diagnosticReport / extract-diagnosticReport-codenull0..1choiceDefinition: DiagnosticReport.code.coding[]
Value Set:
Initial Value: Coding = [not stated]#XNZ5530 "SARS-CoV-2 RAT Self"
ConsumerCOVIDRatResultQuestionnaire / extract / extract-diagnosticReport / extract-diagnosticReport-identifierSystemnull0..1choiceDefinition: DiagnosticReport.identifier[0].system
Value Set:
Initial Value: string = https://standards.digital.health.nz/ns/SendingApplication
ConsumerCOVIDRatResultQuestionnaire / extract / extract-diagnosticReport / extract-diagnosticReport-identifierValuenull0..1choiceDefinition: DiagnosticReport.identifier[0].value
Value Set:
Initial Value: string = RAT Catcher
ConsumerCOVIDRatResultQuestionnaire / extract / extract-diagnosticReport / extract-diagnosticReport-resultnull0..1choiceDefinition: DiagnosticReport.result[]
Value Set:
Initial Value: Reference = urn:uuid:observation-result: SARS-CoV-2 RAT Self
ConsumerCOVIDRatResultQuestionnaire / extract / extract-diagnosticReport / extract-diagnosticReport-phonenull0..1choiceDefinition: DiagnosticReport.result[]
Value Set:
Initial Value: Reference = urn:uuid:observation-phone: Text patient com
ConsumerCOVIDRatResultQuestionnaire / extract / extract-diagnosticReport / extract-diagnosticReportSubjectnull0..1booleanValue Set:
Initial Value: boolean = true
ConsumerCOVIDRatResultQuestionnaire / extract / extract-diagnosticReport / extract-diagnosticReportPerformernull0..1booleanValue Set:
Initial Value: boolean = true
ConsumerCOVIDRatResultQuestionnaire / extract / subjectNamesubject name1..1stringValue Set:

doco Documentation for this format

Options Sets

Answer options for reportResult-container-testDate

  • null#placeholder ("Today")
  • null#placeholder ("Yesterday")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")

Answer options for aveSymptoms-container-symptomDate

  • null#placeholder ("Today")
  • null#placeholder ("Yesterday")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")
  • null#placeholder ("placeholder")