Digital Health Checks (DHC)

DHC Acknowledgements

Background

This page outlines the sequence and use cases for sending acknowledgements (ACKs) upon receipt of a Digital Health Check. This includes positive and negative acknowledgement responses.

This use case uses the Messaging paradigm within FHIR for ACKs.

Sequence Diagram

Acknowledgement Examples

Element population

  • DHC Acnkowledgements SHALL contain the MessageHeader.eventCoding.code=nhshco-hc-complete-1-ack-1.
  • sender SHALL contain the ODS code of the sending organisation.
  • source SHALL contain the details of the sending system/application.
  • response.identifier SHALL reference the id of the DHC bundle this acknowledgement is in response to
  • The acknowledgment SHALL contain an OperationOutcome referenced from MessageHeader.response.details.reference
    • The OperationOutcome shall contain an appropriate code to represent the success or failure of the DHC processing operation.

Successful Acknowledgement for DHC

<Bundle xmlns="http://hl7.org/fhir">
<id value="bf05c76a-2bf1-4756-857d-527a4cfd6d4f" />
<type value="message" />
<entry>
<fullUrl value="urn:uuid:7c451367-d637-4fe7-9eab-140e743b88b3" />
<resource>
<MessageHeader>
<id value="7c451367-d637-4fe7-9eab-140e743b88b3" />
<eventCoding>
<system value="https://fhir.nhs.uk/CodeSystem/message-event" />
<code value="nhshco-hc-complete-1-ack-1" />
<display value="NHS Health Check online service event" />
</eventCoding>
<sender>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="B86051001" />
</identifier>
</sender>
<source>
<name value="GP Practice System" />
<software value="SystmOne" />
<version value="S1.V6.175" />
<contact>
<system value="email" />
<value value="support@tpp-uk.com" />
</contact>
<endpoint value="https://api.tpp-uk.com/fhir/R4" />
</source>
<response>
<identifier value="msg-12345-67890" />
<code value="ok" />
<details>
<reference value="urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c" />
</details>
</response>
</MessageHeader>
</resource>
</entry>
<entry>
<fullUrl value="urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c" />
<resource>
<OperationOutcome>
<id value="8283e341-67ae-48e7-b3ae-2c6a0a824b2c" />
<issue>
<severity value="information" />
<code value="informational" />
<details>
<coding>
<system value="https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode" />
<code value="TECHNICAL_SUCCESS" />
<display value="Request successfully received" />
</coding>
</details>
</issue>
</OperationOutcome>
</resource>
</entry>
</Bundle>
{
"resourceType": "Bundle",
"id": "bf05c76a-2bf1-4756-857d-527a4cfd6d4f",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:7c451367-d637-4fe7-9eab-140e743b88b3",
"resource": {
"resourceType": "MessageHeader",
"id": "7c451367-d637-4fe7-9eab-140e743b88b3",
"eventCoding": {
"system": "https://fhir.nhs.uk/CodeSystem/message-event",
"code": "nhshco-hc-complete-1-ack-1",
"display": "NHS Health Check online service event"
},
"sender": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "B86051001"
}
},
"source": {
"name": "GP Practice System",
"software": "SystmOne",
"version": "S1.V6.175",
"contact": {
"system": "email",
"value": "support@tpp-uk.com"
},
"endpoint": "https://api.tpp-uk.com/fhir/R4"
},
"response": {
"identifier": "msg-12345-67890",
"code": "ok",
"details": {
"reference": "urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c"
}
}
}
},
{
"fullUrl": "urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c",
"resource": {
"resourceType": "OperationOutcome",
"id": "8283e341-67ae-48e7-b3ae-2c6a0a824b2c",
"issue": [
{
"severity": "information",
"code": "informational",
"details": {
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode",
"code": "TECHNICAL_SUCCESS",
"display": "Request successfully received"
}
]
}
}
]
}
}
]
}

Failure Acknowledgement for DHC

<Bundle xmlns="http://hl7.org/fhir">
<id value="fd7dd817-2e45-47ea-8881-6c511fe3bcdf" />
<type value="message" />
<entry>
<fullUrl value="urn:uuid:5e2fbda7-cf38-4439-b7bd-de0c6dbb9d73" />
<resource>
<MessageHeader>
<id value="5e2fbda7-cf38-4439-b7bd-de0c6dbb9d73" />
<eventCoding>
<system value="https://fhir.nhs.uk/CodeSystem/message-event" />
<code value="nhshco-hc-complete-1-ack-1" />
<display value="NHS Health Check online service event" />
</eventCoding>
<sender>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="B86051001" />
</identifier>
</sender>
<source>
<name value="GP Practice System" />
<software value="SystmOne" />
<version value="S1.V6.175" />
<contact>
<system value="email" />
<value value="support@tpp-uk.com" />
</contact>
<endpoint value="https://api.tpp-uk.com/fhir/R4" />
</source>
<response>
<identifier value="msg-09876-54321" />
<code value="fatal-error" />
<details>
<reference value="urn:uuid:791cd4ef-ad5b-435e-bac0-88ffaad994d7" />
</details>
</response>
</MessageHeader>
</resource>
</entry>
<entry>
<fullUrl value="urn:uuid:791cd4ef-ad5b-435e-bac0-88ffaad994d7" />
<resource>
<OperationOutcome>
<id value="791cd4ef-ad5b-435e-bac0-88ffaad994d7" />
<issue>
<severity value="fatal" />
<code value="required" />
<details>
<coding>
<system value="https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode" />
<code value="MSG_RESOURCE_ID_MISSING" />
<display value="Resource Id Missing" />
</coding>
</details>
<diagnostics value="Element Bundle.entry[1].id is missing" />
<expression value="Bundle.entry[1].id" />
</issue>
</OperationOutcome>
</resource>
</entry>
</Bundle>
{
"resourceType": "Bundle",
"id": "fd7dd817-2e45-47ea-8881-6c511fe3bcdf",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:5e2fbda7-cf38-4439-b7bd-de0c6dbb9d73",
"resource": {
"resourceType": "MessageHeader",
"id": "5e2fbda7-cf38-4439-b7bd-de0c6dbb9d73",
"eventCoding": {
"system": "https://fhir.nhs.uk/CodeSystem/message-event",
"code": "nhshco-hc-complete-1-ack-1",
"display": "NHS Health Check online service event"
},
"sender": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "B86051001"
}
},
"source": {
"name": "GP Practice System",
"software": "SystmOne",
"version": "S1.V6.175",
"contact": {
"system": "email",
"value": "support@tpp-uk.com"
},
"endpoint": "https://api.tpp-uk.com/fhir/R4"
},
"response": {
"identifier": "msg-09876-54321",
"code": "fatal-error",
"details": {
"reference": "urn:uuid:791cd4ef-ad5b-435e-bac0-88ffaad994d7"
}
}
}
},
{
"fullUrl": "urn:uuid:791cd4ef-ad5b-435e-bac0-88ffaad994d7",
"resource": {
"resourceType": "OperationOutcome",
"id": "791cd4ef-ad5b-435e-bac0-88ffaad994d7",
"issue": [
{
"severity": "fatal",
"code": "required",
"details": {
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode",
"code": "MSG_RESOURCE_ID_MISSING",
"display": "Resource Id Missing"
}
]
},
"diagnostics": "Element Bundle.entry[1].id is missing",
"expression": [
"Bundle.entry[1].id"
]
}
]
}
}
]
}