|
object
|
FHIR Bundle containing the query results - a list of matching COVID-19 test results and optionally associated patients. |
|
resourceType
string
required
|
FHIR resource type. Always Bundle. Example: Bundle
|
|
type
string
required
|
Indicates how the bundle is intended to be used. Always searchset. Example: searchset
|
|
total
integer
required
|
Number of matching COVID-19 test results found. Example: 2
|
|
entry
array
required
|
List of matching COVID-19 test results and associated patients. If there were no matching tests, this is an empty list. |
|
object
|
|
|
fullUrl
string
required
|
URI for the Observation or Patient resource. Example: urn:uuid:edea022a-2d81-11eb-adc1-0242ac120001
|
|
resource
required
|
The Observation or Patient resource. |
|
oneOf
|
|
|
object
|
Observation result related to the requested patient. |
|
resourceType
string
required
|
FHIR resource type. Always Observation. Example: Observation
|
|
id
string
|
Example: ASD32145123
|
|
status
string
|
COVID-19 test status. Always final. Example: final
|
|
identifier
array
required
|
Unique identifier for this COVID-19 test result record, as generated by the source system. Min items: 1
Max items: 1
|
|
object
|
|
|
system
string
required
|
URI of the namespace of this identifier. Always https://fhir.nhs.uk/Id/SpecimenId. Example: https://fhir.nhs.uk/Id/SpecimenId
|
|
value
string
required
|
Identifier value within system. Example: ASD32145123
|
|
subject
object
|
The patient who took the COVID-19 test. |
|
reference
string
required
|
URI for the associated Patient resource in the bundle. Example: Patient/9000000009
|
|
type
string
|
Type of resource this reference refers to. Always Patient. Example: Patient
|
|
identifier
object
required
|
Business identifier for linked Patient. Always an NHS number. |
|
system
string
required
|
URI of coding system used to identify linked patient. Example: https://fhir.nhs.uk/Id/nhs-number
|
|
value
string
required
|
Value in coding system representing linked patient. Example: 9000000009
|
|
category
array
|
The category of test result. Indicates Pillar of the data only Min items: 1
Max items: 1
|
|
object
|
|
|
system
string
|
Coding system used to indicate Pillar1 data Example: https://fhir.nhs.uk/CodeSystem/covid-test-pillar
|
|
code
string
|
Code indicating Pillar1 data. Allowed values: pillar-1, pillar-2, private
|
|
display
string
|
Description indicating Pillar1 data. Allowed values: pillar 1, pillar 2, private
|
|
code
object
|
The category of test result. Describes COVID-19 detection method. |
|
coding
array
required
|
Wrapper for the test result detection method. Min items: 1
Max items: 1
|
|
object
|
|
|
system
string
required
|
Coding system used to describe COVID-19 detection method. Always SNOMED. Example: http://snomed.info/sct
|
|
code
string
required
|
Code for the COVID-19 detection method. Allowed values: 871555000, 871552002, 871553007
|
|
display
string
required
|
Description of the COVID-19 detection method. Example: Detection of ribonucleic acid of Severe acute respiratory syndrome coronavirus 2
|
|
effectiveDateTime
string
|
Date and time of the COVID-19 test. Example: 2021-04-20T00:00:00+00:00
|
|
valueCodeableConcept
object
|
The COVID-19 test result for the specimen analysed. |
|
coding
array
required
|
Wrapper for the test result. Min items: 1
Max items: 1
|
|
object
|
|
|
system
string
required
|
Coding system used to describe COVID-19 test result. Always SNOMED. Example: http://snomed.info/sct
|
|
code
string
required
|
Code for the COVID-19 test result. Example: 1322791000000100
|
|
display
string
required
|
Description of the COVID-19 test result. Example: SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) antigen detection result negative
|
|
device
object
|
The type of test kit used to take the COVID-19 test. |
|
identifier
object
required
|
|
|
system
string
required
|
Coding system used for the test kit identifier. Always https://fhir.nhs.uk/Id/Covid19-TestKit. Example: https://fhir.nhs.uk/Id/Covid19-TestKit
|
|
value
string
required
|
Allowed values: blank (i.e. empty), lampore, rnalamp, directrtlamp, lft, ePCR, rtPCR, elisa
|
|
display
string
required
|
Decsription of the test kit. Example: Lateral Flow Test
|
|
performer
array
|
Information where the test was taken (Test Centre) and where it was analysed (e.g. a laboratory). Min items: 1
Max items: 2
|
|
oneOf
|
|
|
object
|
|
|
type
string
required
|
Example: Organization
|
|
identifier
object
required
|
|
|
type
object
required
|
|
|
coding
array
required
|
Min items: 1
Max items: 1
|
|
object
|
|
|
system
string
required
|
Coding system used to describe laboratory type. Always https://fhir.nhs.uk/CodeSystem/organisation-role. Example: https://fhir.nhs.uk/CodeSystem/organisation-role
|
|
code
string
required
|
Code for the laboratory type within system. Always 173. Example: 173
|
|
display
string
required
|
Example: PATHOLOGY LAB
|
|
value
string
required
|
Unique identifier of the pathology lab. Example: MK
|
|
object
|
|
|
type
string
required
|
Example: Organization
|
|
identifier
object
required
|
|
|
type
object
required
|
|
|
text
string
required
|
Example: Testing Centre
|
|
value
string
required
|
Unique identifier of the Testing Centre. Example: BBC
|
|
extension
array
|
COVID-19 test results extensions to cover elements not defined in standard FHIR. Min items: 1
Max items: 1
|
|
object
|
|
|
url
string
required
|
URI for the type of extension. Always https://fhir.nhs.uk/StructureDefinition/Extension-COVID19-TestResult. Example: https://fhir.nhs.uk/StructureDefinition/Extension-COVID19-TestResult
|
|
extension
array
required
|
Min items: 1
Max items: 2
|
|
oneOf
|
|
|
object
|
Source of record creation. |
|
url
string
required
|
|
|
valueCodeableConcept
object
required
|
|
|
text
string
required
|
Unique indentifier of the source. Allowed values: admin, bulk, electiveCare, home, lite, liteSelf, user, assistedExistingBarcode
|
|
object
|
Used to convey how the test was administered. |
|
url
string
required
|
Always administrationMethod. |
|
valueCodeableConcept
object
required
|
|
|
text
string
required
|
Unique indentifier of the admin method. Allowed values: self, health_care_professional
|
|
object
|
Demographic information about the patient whose tests are retrieved. |
|
resourceType
string
required
|
FHIR resource type. Always Patient. Example: Patient
|
|
identifier
array
required
|
Unique identifier for this patient. Always an NHS number. Min items: 1
|
|
object
|
|
|
system
string
required
|
Coding system used to identify patients. Example: https://fhir.nhs.uk/Id/nhs-number
|
|
value
string
required
|
Code identifying the patient. Example: 9000000009
|
|
birthDate
string
required
|
Example: 1965-02-28
|
|
search
object
required
|
Search-related information for the Observation or Patient resource. |
|
mode
string
required
|
Indicates why this resource is in the result set. For Observation resources this is always match and for Patient resources it is always include. Allowed values: match, include
|
