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

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: 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-07-20 Computable Name: ConsumerCOVIDRatResultQuestionnaire
Other Identifiers: ConsumerCOVIDRATResultQuestionnaire (use: official, period: 7/19/23 --> (ongoing))

Usage:Workflow Setting: 

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
... metaPhoneNumberPhone number0..1stringiconiconDefinition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString
Value Set:
Initial Value: string = Placeholder
... extractPhoneNumberCodenull0..1choiceiconiconDefinition: 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"
... submit-modalEnter result0..1groupValue Set:
.... submit-modal-textThe RAT result will be recorded against the official health record for this person.0..1displayValue Set:
.... nlineModal-otherLinesIf your RAT has other lines or markings, consult the product information leaflet.0..1displayValue Set:
.... nlineModal-contactHealthlineContact Healthline for further information on 0800 358 5453.0..1displayValue Set:
... highRiskModalOther risk factors or medical conditions:0..1groupValue Set:
.... highRiskModal-conditionsList of conditions0..1displayValue Set:
... reportResultReport a COVID-19 Rapid Antigen Test (RAT) result0..1groupValue Set:
.... reportResult-containernull0..1groupValue Set:
..... reportResult-container-diagramA diagram showing what a positive COVID RAT Result looks like0..1displayValue Set:
..... reportResult-container-controlLineIs the control line (C) visible?1..1booleanValue Set:
..... reportResult-container-testLineIs the test line (T) visible?1..1booleanValue Set:
..... reportResult-container-faintLinesFaint lines0..1displayValue Set:
..... reportResult-container-faintLinesDetailIf a line is faint it should still be recorded as visible.0..1displayValue Set:
A small number of RATs have an ‘N’ line0..1displayValue Set:
..... reportResult-container-testDateDay test was taken1..1choiceValue Set:
Options: 8 options
..... reportResult.container.onlyThisWeekYou can only report a test taken within the last 7 days.0..1displayValue Set:
..... reportResult-container-householdContactAre you a household contact of someone who has tested positive for COVID-19?1..1booleanEnable When:
Value Set:
... aveSymptomsAntiviral Eligibility0..1groupValue Set:
.... aveSymptoms-containernull0..1groupValue Set:
..... aveSymptoms-container-intronull0..1groupValue Set:
...... aveSymptoms-container-intro-headingAbout these questions0..1displayValue Set:
...... 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.0..1displayValue Set:
..... aveSymptoms-container-detailsnull0..1groupValue Set:
...... aveSymptoms-container-details-headingSymptoms of COVID-19 can include one or more of the following:0..1displayValue Set:
...... aveSymptoms-container-details-listSneezing and runny nose, sore throat, body aches, cough, feeling tired, headache, nausea and vomiting, diarrhoea, fever0..1displayValue Set:
...... aveSymptoms-container-details-moreInfoHeadingVisit this page for more information about COVID-19 symptoms:0..1displayValue Set:
COVID-19 symptoms0..1displayValue Set:
...... aveSymptoms-container-details-hasSymptomsHave you been experiencing any symptoms?1..1booleanValue Set:
..... aveSymptoms-container-symptomDateHeadingWhen did you start experiencing any of these symptoms?0..1displayValue Set:
..... aveSymptoms-container-symptomDateSelect the date that your symptoms started1..1choiceValue Set:
Options: 8 options
... aveCriteriaAntiviral Eligibility0..1groupValue Set:
.... aveCriteria-containernull0..1groupValue Set:
..... aveCriteria-container-intronull0..1groupValue Set:
...... aveCriteria-container-intro-headingAbout these questions0..1displayValue Set:
...... 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.0..1displayValue Set:
..... aveCriteria-container-vulnerableTextEligible people include:0..1displayValue Set:
..... aveCriteria-container-vulnerableContainernull0..1groupValue Set:
...... aveCriteria-container-vulnerableContainer-isVulnerableDo any of these apply to you?1..1booleanValue Set:
..... aveCriteria-container-highRiskContainernull0..1groupEnable When: aveCriteria-container-vulnerableContainer-isVulnerable = false
Value Set:
...... aveCriteria-container-highRiskContainer-textThese are some reasons you might be at high risk of becoming very sick from COVID-19:0..1displayValue Set:
...... aveCriteria-container-highRiskContainer-isHighRiskDo any of these apply to you?1..1booleanValue Set:
... postSubmitnull0..1groupValue Set:
.... postSubmit-containernull0..1groupValue Set:
..... postSubmit-container-failedResult: Failed. A result could not be determined.0..1displayValue Set:
..... postSubmit-container-testResultnull0..1groupValue Set:
...... postSubmit-container-testResult-positiveResult: Positive. COVID-19 was detected.0..1displayValue Set:
...... postSubmit-container-testResult-negativeResult: Negative. COVID-19 was not detected.0..1displayValue Set:
..... postSubmit-container-eligibilitynull0..1groupValue Set:
...... postSubmit-container-eligibility-headingAntiviral eligibility0..1displayValue Set:
...... postSubmit-container-eligibility-maybeEligibleBased on the information you have provided, you may be eligible for free oral COVID-19 antiviral medication.0..1displayValue Set:
...... postSubmit-container-eligibility-notEligibleNot eligible0..1displayValue Set:
..... postSubmit-container-isolationnull0..1groupValue Set:
...... postSubmit-container-isolation-headingRecommended isolation0..1displayValue Set:
...... 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.0..1displayValue Set:
...... postSubmit-container-isolation-stayAwayFromFacilitiesRecommended isolation0..1displayValue Set:
...... 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.0..1displayValue Set:
..... postSubmit-container-nextStepsnull0..1groupValue Set:
...... postSubmit-container-nextSteps-headingWhat to do next0..1displayValue Set:
...... 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.0..1displayValue Set:
...... postSubmit-container-nextSteps-currentAdvicePositiveContinue to follow current advice: https://info.health.nz/conditions-treatments/infectious-diseases/covid-19/if-you-have-covid-19/0..1displayValue Set:
...... postSubmit-container-nextSteps-testAt24And48HoursIf symptoms persist, test again at 24 and 48 hours.0..1displayValue Set:
...... postSubmit-container-nextSteps-currentAdviceNegativeContinue to follow current advice: https://info.health.nz/conditions-treatments/infectious-diseases/covid-19/testing-and-reporting/0..1displayValue Set:
...... postSubmit-container-nextSteps-failedComplete a new RAT and report the result.0..1displayValue Set:
...... 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.0..1displayValue Set:
..... postSubmit-container-furtherSupportnull0..1groupValue Set:
...... postSubmit-container-furtherSupport-headingFurther support0..1displayValue Set:
...... 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.0..1displayValue Set:
...... 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.0..1displayValue Set:
...... 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.0..1displayValue Set:
..... postSubmit-container-exitCompleteExit0..1displayValue Set:
... extractnull0..1groupiconiconValue Set:
.... 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
.... 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
.... 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
.... 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"
.... extract-diagnosticReportnull0..1groupValue Set:
..... extract-diagnosticReport-codenull0..1choiceDefinition: DiagnosticReport.code.coding[]
Value Set:
Initial Value: Coding = [not stated]#XNZ5530 "SARS-CoV-2 RAT Self"
..... extract-diagnosticReport-identifierSystemnull0..1choiceDefinition: DiagnosticReport.identifier[0].system
Value Set:
Initial Value: string = https://standards.digital.health.nz/ns/SendingApplication
..... extract-diagnosticReport-identifierValuenull0..1choiceDefinition: DiagnosticReport.identifier[0].value
Value Set:
Initial Value: string = RAT Catcher
..... extract-diagnosticReport-resultnull0..1choiceDefinition: DiagnosticReport.result[]
Value Set:
Initial Value: Reference = urn:uuid:observation-result: SARS-CoV-2 RAT Self
..... extract-diagnosticReport-phonenull0..1choiceDefinition: DiagnosticReport.result[]
Value Set:
Initial Value: Reference = urn:uuid:observation-phone: Text patient com
..... extract-diagnosticReportSubjectnull0..1booleanValue Set:
Initial Value: boolean = true
..... extract-diagnosticReportPerformernull0..1booleanValue Set:
Initial Value: boolean = true
.... subjectNamesubject name1..1stringiconiconValue 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")