Test Results
Test Results & Appointments
Important: The Acknowledgement Framework is currently a draft version. Please contact the
Interoperability Standards Team if you are interested to discuss this solution for your use case.
Background
These are a collection of use case examples covering test results. This includes positive and negative acknowledgement responses. This is to illustrate how the generic and agnostic Acknowledgement Framework can support a specific project use case.
This use case uses the Messaging paradigm within FHIR.
Use Case Examples
As a results receiver
I can send an acknowledgement to the results provider
So that I can acknowledge receipt of test results
As an appointment fulfiller
I can send an acknowledgement to an appointment requester
So that I can acknowledge receipt of appointments
Positive Acknowledgement
Positive Acknowledgement of Appointment
An Example of a positive acknowledgement response
JSON
XML
< Bundle xmlns = " http://hl7.org/fhir " >
< id value = " aa09cccc-2c9b-4238-91d2-66fa6ee845e3 " />
< fullUrl value = " http://example.org/MessageHeader/ba09cccc-2c9b-4238-91d2-66fa6ee845f4 " />
< MessageHeader >
< id value = " ba09cccc-2c9b-4238-91d2-66fa6ee845f4 " />
< system value = " https://fhir.nhs.uk/CodeSystem/message-event " />
< code value = " notification " />
< display value = " Event Notification " />
</ eventCoding >
< name value = " Destination Org Ltd " />
< endpoint value = " https://destination.nhs.uk/api " />
</ destination >
< endpoint value = " https://source.nhs.uk/api " />
</ source >
< identifier value = " 6e7b1dbb-77d2-4ddd-ae0d-e4862a306c1c " />
</ response >
</ MessageHeader >
</ resource >
</ entry >
</ Bundle >
{
" id " : " aa09cccc-2c9b-4238-91d2-66fa6ee845e3 " ,
{
" fullUrl " : " http://example.org/MessageHeader/ba09cccc-2c9b-4238-91d2-66fa6ee845f4 " ,
" id " : " ba09cccc-2c9b-4238-91d2-66fa6ee845f4 " ,
" system " : " https://fhir.nhs.uk/CodeSystem/message-event " ,
} ,
{
" name " : " Destination Org Ltd " ,
" endpoint " : " https://destination.nhs.uk/api "
}
] ,
} ,
" identifier " : " 6e7b1dbb-77d2-4ddd-ae0d-e4862a306c1c " ,
}
}
}
]
}
Positive Acknowledgement of Test Report
An Example of a positive test report acknowledgement response
JSON
XML
< Bundle xmlns = " http://hl7.org/fhir " >
< id value = " ff09cccc-2c9b-4238-91d2-66fa6ee845d3 " />
< fullUrl value = " http://example.org/MessageHeader/df09cezc-2c9b-4238-91d2-66fa6ee845d3 " />
< MessageHeader >
< id value = " df09cezc-2c9b-4238-91d2-66fa6ee845d3 " />
< system value = " https://fhir.nhs.uk/CodeSystem/message-event " />
< code value = " notification " />
< display value = " Event Notification " />
</ eventCoding >
< name value = " Destination Org Ltd " />
< endpoint value = " https://destination.nhs.uk/api " />
</ destination >
< endpoint value = " https://source.nhs.uk/api " />
</ source >
< identifier value = " f862ec24-e05a-42d1-aea5-d0a9c092e6ae " />
</ response >
</ MessageHeader >
</ resource >
</ entry >
</ Bundle >
{
" id " : " ff09cccc-2c9b-4238-91d2-66fa6ee845d3 " ,
{
" fullUrl " : " http://example.org/MessageHeader/df09cezc-2c9b-4238-91d2-66fa6ee845d3 " ,
" id " : " df09cezc-2c9b-4238-91d2-66fa6ee845d3 " ,
" system " : " https://fhir.nhs.uk/CodeSystem/message-event " ,
} ,
{
" name " : " Destination Org Ltd " ,
" endpoint " : " https://destination.nhs.uk/api "
}
] ,
} ,
" identifier " : " f862ec24-e05a-42d1-aea5-d0a9c092e6ae " ,
}
}
}
]
}
Negative Acknowledgement
The appointment should be in a JSON format. However, the appointment message was sent in an XML format. So a negative acknowledgement is sent.
An Example of a Receive Negative acknowledgement response
JSON
XML
< Bundle xmlns = " http://hl7.org/fhir " >
< id value = " 6e7b1dbb-77d2-4ddd-ae0d-e4862a306c1d " />
< fullUrl value = " http://example.org/MessageHeader/6g7b1dbb-77d2-4ddd-ae0d-e4862a306c1b " />
< MessageHeader >
< id value = " 6g7b1dbb-77d2-4ddd-ae0d-e4862a306c1b " />
< system value = " https://fhir.nhs.uk/CodeSystem/message-event " />
< code value = " notification " />
< display value = " Event Notification " />
</ eventCoding >
< name value = " Destination Org Ltd " />
< endpoint value = " https://destination.nhs.uk/api " />
</ destination >
< endpoint value = " https://source.nhs.uk/api " />
</ source >
< identifier value = " f50c58ea-543f-4530-99fa-ceb7b9dbbed5 " />
< code value = " fatal-error " />
< reference value = " OperationOutcome/d9c93f48-abb9-4aa4-aa22-ef2f76485477 " />
</ details >
</ response >
</ MessageHeader >
</ resource >
</ entry >
< fullUrl value = " http://example.org/OperationOutcome/d9c93f48-abb9-4aa4-aa22-ef2f76485477 " />
< OperationOutcome >
< id value = " d9c93f48-abb9-4aa4-aa22-ef2f76485477 " />
< code value = " structure " />
</ issue >
</ OperationOutcome >
</ resource >
</ entry >
</ Bundle >
{
" id " : " 6e7b1dbb-77d2-4ddd-ae0d-e4862a306c1d " ,
{
" fullUrl " : " http://example.org/MessageHeader/6g7b1dbb-77d2-4ddd-ae0d-e4862a306c1b " ,
" id " : " 6g7b1dbb-77d2-4ddd-ae0d-e4862a306c1b " ,
" system " : " https://fhir.nhs.uk/CodeSystem/message-event " ,
} ,
{
" name " : " Destination Org Ltd " ,
" endpoint " : " https://destination.nhs.uk/api "
}
] ,
} ,
" identifier " : " f50c58ea-543f-4530-99fa-ceb7b9dbbed5 " ,
" reference " : " OperationOutcome/d9c93f48-abb9-4aa4-aa22-ef2f76485477 "
}
}
}
} ,
{
" fullUrl " : " http://example.org/OperationOutcome/d9c93f48-abb9-4aa4-aa22-ef2f76485477 " ,
" id " : " d9c93f48-abb9-4aa4-aa22-ef2f76485477 " ,
]
}
}
]
}
Negative Acknowledgement of a Test Result - Missing Mandatory Element
The test result should include all FHIR elements that are mandatory (with a minimum cardinality of 1). However, the test result sent is missing a FHIR element that is mandatory. So a negative acknowledgement is sent.
An Example of a Test Report Negative acknowledgement response
JSON
XML
< Bundle xmlns = " http://hl7.org/fhir " >
< id value = " cf09cccc-2c9b-4238-91d2-66fa6ee845d3 " />
< fullUrl value = " http://example.org/MessageHeader/6g7b1dbb-77d2-4ddd-ae0d-e4862a306cb2 " />
< MessageHeader >
< id value = " 6g7b1dbb-77d2-4ddd-ae0d-e4862a306cb2 " />
< system value = " https://fhir.nhs.uk/CodeSystem/message-event " />
< code value = " notification " />
< display value = " Event Notification " />
</ eventCoding >
< name value = " Destination Org Ltd " />
< endpoint value = " https://destination.nhs.uk/api " />
</ destination >
< endpoint value = " https://source.nhs.uk/api " />
</ source >
< identifier value = " f862ec24-e05a-42d1-aea5-d0a9c092e6ae " />
< code value = " fatal-error " />
< reference value = " OperationOutcome/e747c4e4-9228-4ba4-b3e0-6e34b928edac " />
</ details >
</ response >
</ MessageHeader >
</ resource >
</ entry >
< fullUrl value = " http://example.org/OperationOutcome/e747c4e4-9228-4ba4-b3e0-6e34b928edac " />
< OperationOutcome >
< id value = " e747c4e4-9228-4ba4-b3e0-6e34b928edac " />
< code value = " required " />
</ issue >
</ OperationOutcome >
</ resource >
</ entry >
</ Bundle >
{
" id " : " cf09cccc-2c9b-4238-91d2-66fa6ee845d3 " ,
{
" fullUrl " : " http://example.org/MessageHeader/6g7b1dbb-77d2-4ddd-ae0d-e4862a306cb2 " ,
" id " : " 6g7b1dbb-77d2-4ddd-ae0d-e4862a306cb2 " ,
" system " : " https://fhir.nhs.uk/CodeSystem/message-event " ,
} ,
{
" name " : " Destination Org Ltd " ,
" endpoint " : " https://destination.nhs.uk/api "
}
] ,
} ,
" identifier " : " f862ec24-e05a-42d1-aea5-d0a9c092e6ae " ,
" reference " : " OperationOutcome/e747c4e4-9228-4ba4-b3e0-6e34b928edac "
}
}
}
} ,
{
" fullUrl " : " http://example.org/OperationOutcome/e747c4e4-9228-4ba4-b3e0-6e34b928edac " ,
" id " : " e747c4e4-9228-4ba4-b3e0-6e34b928edac " ,
]
}
}
]
}