Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 75 additions & 3 deletions schemas/home-test-supplier-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ openapi: 3.0.3
info:
title: Home Test Supplier API
description: API for supplier domain operations - managing test results and order status updates
version: 1.1.6
version: 1.1.7
contact:
name: NHS England - Digital Prevention Services Portfolio - Home Test Team
email: england.hometest@nhs.net
Expand Down Expand Up @@ -178,7 +178,7 @@ components:
type: array
minItems: 1
items:
$ref: '#/components/schemas/FHIRCodeableConcept'
$ref: '#/components/schemas/FHIRDiagnosticCoding'
description: Category of the diagnostic report (should be LAB/Laboratory for test results)
example:
- coding:
Expand Down Expand Up @@ -256,7 +256,7 @@ components:
type: array
minItems: 1
items:
$ref: '#/components/schemas/FHIRCodeableConcept'
$ref: '#/components/schemas/FHIRObservationCoding'
description: Category of the observation (should be laboratory/Laboratory for observation category)
example:
- coding:
Expand Down Expand Up @@ -418,6 +418,13 @@ components:
- description: Responsible individual for the task
example:
reference: "Organization/SUP001"
businessStatus:
allOf:
- $ref: '#/components/schemas/FHIRBusinessStatusCoding'
- description: Domain-specific business status (should be one of: "order-accepted", "dispatched", "received-at-lab", "test-processed")
example:
text: "dispatched"

FHIROperationOutcome:
type: object
description: FHIR OperationOutcome resource for reporting errors and warnings
Expand Down Expand Up @@ -553,6 +560,71 @@ components:
description: The purpose of this identifier
enum: [usual, official, temp, secondary, old]
example: "official"
FHIRBusinessStatusCoding:
type: object
description: A specific example of a CodeableConcept for status updates, using the businessStatus field of the FHIRTask
required:
- text
properties:
coding:
type: array
description: Code defined by a terminology system
items:
$ref: '#/components/schemas/FHIRCoding'
text:
$ref: '#/components/schemas/FHIRBusinessStatusText'
example:
text: dispatched
FHIRBusinessStatusText:
type: string
description: Domain-specific business status values for status updates
enum: [dispatched, received-at-lab, test-processed]
FHIRDiagnosticCoding:
type: object
description: A specific example of a CodeableConcept for DiagnosticReport category.
required:
- text
properties:
coding:
type: array
description: Code defined by a terminology system
items:
$ref: '#/components/schemas/FHIRCoding'
text:
$ref: '#/components/schemas/FHIRDiagnosticCodingText'
example:
coding:
- system: "http://terminology.hl7.org/CodeSystem/v2-0074"
code: "LAB"
display: "Laboratory"
text: Laboratory
FHIRDiagnosticCodingText:
type: string
description: Diagnostic report category text values
enum: [Laboratory]
FHIRObservationCoding:
type: object
description: A specific example of a CodeableConcept for Observation category.
required:
- text
properties:
coding:
type: array
description: Code defined by a terminology system
items:
$ref: '#/components/schemas/FHIRCoding'
text:
$ref: '#/components/schemas/FHIRObservationCodingText'
example:
coding:
- system: "http://terminology.hl7.org/CodeSystem/observation-category"
code: "laboratory"
display: "Laboratory"
text: Laboratory
FHIRObservationCodingText:
type: string
description: Observation category text values
enum: [Laboratory]
examples:
FHIRBundleResultsExample:
summary: Example FHIR Bundle for test results submission
Expand Down