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

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-03-03 | 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

LinkID | Text | Cardinality | Type | Flags | Description & Constraints
--- | --- | --- | --- | --- | ---
ConsumerCOVIDRatResultQuestionnaire | Consumer COVID RAT Result Questionnaire |  | Questionnaire |  | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/Questionnaire/ConsumerCOVIDRATResultQuestionnaire#1.0.5
metaPhoneNumber | Phone number | 0..1 | string |  | Definition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString Initial Value: string = Placeholder
extractPhoneNumberCode | null | 0..1 | choice |  | Definition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.code.coding[] Initial Value: Coding = [not stated]#8497 "Text patient com"
submit-modal | Enter result | 0..1 | group |  |
submit-modal-text | The RAT result will be recorded against the official health record for this person. | 0..1 | display |  |
nlineModal | RATs with other lines | 0..1 | group |  |
nlineModal-otherLines | If your RAT has other lines or markings, consult the product information leaflet. | 0..1 | display |  |
nlineModal-contactHealthline | Contact Healthline for further information on 0800 358 5453. | 0..1 | display |  |
highRiskModal | Other risk factors or medical conditions: | 0..1 | group |  |
highRiskModal-conditions | List of conditions | 0..1 | display |  |
reportResult | Report a COVID-19 Rapid Antigen Test (RAT) result | 0..1 | group |  |
reportResult-container | null | 0..1 | group |  |
reportResult-container-diagram | A diagram showing what a positive COVID RAT Result looks like | 0..1 | display |  |
reportResult-container-controlLine | Is the control line (C) visible? | 1..1 | boolean |  |
reportResult-container-testLine | Is the test line (T) visible? | 1..1 | boolean |  |
reportResult-container-faintLines | Faint lines | 0..1 | display |  |
reportResult-container-faintLinesDetail | If a line is faint it should still be recorded as visible. | 0..1 | display |  |
reportResult-container-nLineLink | A small number of RATs have an ‘N’ line | 0..1 | display |  |
reportResult-container-testDate | Day test was taken | 1..1 | choice |  | Options: 8 options
reportResult.container.onlyThisWeek | You can only report a test taken within the last 7 days. | 0..1 | display |  |
reportResult-container-householdContact | Are you a household contact of someone who has tested positive for COVID-19? | 1..1 | boolean |  | Enable When: reportResult-container-controlLine = reportResult-container-testLine =
aveSymptoms | Antiviral Eligibility | 0..1 | group |  |
aveSymptoms-container | null | 0..1 | group |  |
aveSymptoms-container-intro | null | 0..1 | group |  |
aveSymptoms-container-intro-heading | About these questions | 0..1 | display |  |
aveSymptoms-container-intro-text | The following questions will give you an indication of whether you might be eligible to receive free oral COVID-19 antiviral medicine. | 0..1 | display |  |
aveSymptoms-container-details | null | 0..1 | group |  |
aveSymptoms-container-details-heading | Symptoms of COVID-19 can include one or more of the following: | 0..1 | display |  |
aveSymptoms-container-details-list | Sneezing and runny nose, sore throat, body aches, cough, feeling tired, headache, nausea and vomiting, diarrhoea, fever | 0..1 | display |  |
aveSymptoms-container-details-moreInfoHeading | Visit this page for more information about COVID-19 symptoms: | 0..1 | display |  |
aveSymptoms-container-details-moreInfoLink | COVID-19 symptoms | 0..1 | display |  |
aveSymptoms-container-details-hasSymptoms | Have you been experiencing any symptoms? | 1..1 | boolean |  |
aveSymptoms-container-symptomDateHeading | When did you start experiencing any of these symptoms? | 0..1 | display |  |
aveSymptoms-container-symptomDate | Select the date that your symptoms started | 1..1 | choice |  | Options: 8 options
aveCriteria | Antiviral Eligibility | 0..1 | group |  |
aveCriteria-container | null | 0..1 | group |  |
aveCriteria-container-intro | null | 0..1 | group |  |
aveCriteria-container-intro-heading | About these questions | 0..1 | display |  |
aveCriteria-container-intro-text | The following questions will give you an indication of whether you might be eligible to receive free oral COVID-19 antiviral medicine. | 0..1 | display |  |
aveCriteria-container-vulnerableText | Eligible people include: | 0..1 | display |  |
aveCriteria-container-vulnerableContainer | null | 0..1 | group |  |
aveCriteria-container-vulnerableContainer-isVulnerable | Do any of these apply to you? | 1..1 | boolean |  |
aveCriteria-container-highRiskContainer | null | 0..1 | group |  | Enable When: aveCriteria-container-vulnerableContainer-isVulnerable =
aveCriteria-container-highRiskContainer-text | These are some reasons you might be at high risk of becoming very sick from COVID-19: | 0..1 | display |  |
aveCriteria-container-highRiskContainer-isHighRisk | Do any of these apply to you? | 1..1 | boolean |  |
postSubmit | null | 0..1 | group |  |
postSubmit-container | null | 0..1 | group |  |
postSubmit-container-failed | Result: Failed. A result could not be determined. | 0..1 | display |  |
postSubmit-container-testResult | null | 0..1 | group |  |
postSubmit-container-testResult-positive | Result: Positive. COVID-19 was detected. | 0..1 | display |  |
postSubmit-container-testResult-negative | Result: Negative. COVID-19 was not detected. | 0..1 | display |  |
postSubmit-container-eligibility | null | 0..1 | group |  |
postSubmit-container-eligibility-heading | Antiviral eligibility | 0..1 | display |  |
postSubmit-container-eligibility-maybeEligible | Based on the information you have provided, you may be eligible for free oral COVID-19 antiviral medication. | 0..1 | display |  |
postSubmit-container-eligibility-notEligible | Not eligible | 0..1 | display |  |
postSubmit-container-isolation | null | 0..1 | group |  |
postSubmit-container-isolation-heading | Recommended isolation | 0..1 | display |  |
postSubmit-container-isolation-isolateFiveDays | We 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..1 | display |  |
postSubmit-container-isolation-stayAwayFromFacilities | Recommended isolation | 0..1 | display |  |
postSubmit-container-isolation-testDailyForFiveDays | We 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..1 | display |  |
postSubmit-container-nextSteps | null | 0..1 | group |  |
postSubmit-container-nextSteps-heading | What to do next | 0..1 | display |  |
postSubmit-container-nextSteps-antivirals | Talk 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..1 | display |  |
postSubmit-container-nextSteps-currentAdvicePositive | Continue to follow current advice: https://info.health.nz/conditions-treatments/infectious-diseases/covid-19/if-you-have-covid-19/ | 0..1 | display |  |
postSubmit-container-nextSteps-testAt24And48Hours | If symptoms persist, test again at 24 and 48 hours. | 0..1 | display |  |
postSubmit-container-nextSteps-currentAdviceNegative | Continue to follow current advice: https://info.health.nz/conditions-treatments/infectious-diseases/covid-19/testing-and-reporting/ | 0..1 | display |  |
postSubmit-container-nextSteps-failed | Complete a new RAT and report the result. | 0..1 | display |  |
postSubmit-container-nextSteps-failedCall111 | Call 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..1 | display |  |
postSubmit-container-furtherSupport | null | 0..1 | group |  |
postSubmit-container-furtherSupport-heading | Further support | 0..1 | display |  |
postSubmit-container-furtherSupport-monitorSymptoms | Monitor COVID-19 symptoms and if they get worse or you need medical care, call a healthcare provider or Healthline on 0800 358 5453. | 0..1 | display |  |
postSubmit-container-furtherSupport-testIfSymptomatic | Monitor for COVID-19 symptoms, and test if you become symptomatic.If you return a positive RAT, report the result using this form. | 0..1 | display |  |
postSubmit-container-furtherSupport-call111 | Call 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..1 | display |  |
postSubmit-container-exitComplete | Exit | 0..1 | display |  |
extract | null | 0..1 | group |  |
extract-resultObservationValuePositive | Extract - test result positive | 0..1 | string |  | Definition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString Initial Value: string = DETECTED
extract-resultObservationValueNegative | Extract - test result negative | 0..1 | string |  | Definition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString Initial Value: string = NOT DETECTED
extract-resultObservationValueFailed | Extract - test result failed | 0..1 | string |  | Definition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.valueString Initial Value: string = FAILED
extract-resultObservationCode | null | 0..1 | choice |  | Definition: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation#Observation.code.coding[] Initial Value: Coding = [not stated]#XNZ5530 "SARS-CoV-2 RAT Self"
extract-diagnosticReport | null | 0..1 | group |  |
extract-diagnosticReport-code | null | 0..1 | choice |  | Definition: DiagnosticReport.code.coding[] Initial Value: Coding = [not stated]#XNZ5530 "SARS-CoV-2 RAT Self"
extract-diagnosticReport-identifierSystem | null | 0..1 | choice |  | Definition: DiagnosticReport.identifier[0].system Initial Value: string = https://standards.digital.health.nz/ns/SendingApplication
extract-diagnosticReport-identifierValue | null | 0..1 | choice |  | Definition: DiagnosticReport.identifier[0].value Initial Value: string = RAT Catcher
extract-diagnosticReport-result | null | 0..1 | choice |  | Definition: DiagnosticReport.result[] Initial Value: Reference = urn:uuid:observation-result: SARS-CoV-2 RAT Self
extract-diagnosticReport-phone | null | 0..1 | choice |  | Definition: DiagnosticReport.result[] Initial Value: Reference = urn:uuid:observation-phone: Text patient com
extract-diagnosticReportSubject | null | 0..1 | boolean |  | Initial Value: boolean = true
extract-diagnosticReportPerformer | null | 0..1 | boolean |  | Initial Value: boolean = true
subjectName | subject name | 1..1 | string |  |
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")