Skip to main content
GET/transactional-api/get-investigation-report

Get Investigation Report

Returns the full detail of a single PENDING investigation report.

Authorization: Bearer token (JWT). See Authentication.

Request​

curl -L -X GET 'https://{tenantId}.api.england.medicus.health/transactional-api/get-investigation-report' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>'

Path and query parameters

NameInTypeRequiredDescription
reportIdquerystring<uuid>YesThe UUID of the investigation report to retrieve.

Responses​

200 Investigation report detail.

Response fields

FieldTypeDescription
reportIdstring<uuid>
patientIdstring<uuid>
displayDescriptionstring
receivedDateTimestring (nullable)
issuedDateTimestring (nullable)
requestedByOrganisation.namestring (nullable)
requestedByOrganisation.identifierTypeenum (nullable)One of: medicus-tenant-id, nhs-england-ods-code, medicus-referral-provider-id, third-party-system-organisation-id, unknown-identifier-type.
requestedByOrganisation.identifierValuestring (nullable)
requestedByPractitioner.displayNamestring (nullable)
requestedByPractitioner.identifierTypeenum (nullable)One of: medicus-staff-id, medicus-referral-provider-practitioner-id, gb-nhs-gp-connect-practitioner-id, gb-nhs-gp-national-code, gb-gmc-number, gb-gphc-number, gb-hcpc-number, gb-nmc-pin, sds-user-id.
requestedByPractitioner.identifierValuestring (nullable)
performedByOrganisation.namestring (nullable)
performedByOrganisation.identifierTypeenum (nullable)One of: medicus-tenant-id, nhs-england-ods-code, medicus-referral-provider-id, third-party-system-organisation-id, unknown-identifier-type.
performedByOrganisation.identifierValuestring (nullable)
performedByPractitioner.displayNamestring (nullable)
performedByPractitioner.identifierTypeenum (nullable)One of: medicus-staff-id, medicus-referral-provider-practitioner-id, gb-nhs-gp-connect-practitioner-id, gb-nhs-gp-national-code, gb-gmc-number, gb-gphc-number, gb-hcpc-number, gb-nmc-pin, sds-user-id.
performedByPractitioner.identifierValuestring (nullable)
requesterCommentsstring (nullable)
performerCommentsstring (nullable)
reportIdentifierstring (nullable)
filingComments[].commentIdstring<uuid>
filingComments[].commentstring (nullable)
filingComments[].recordDatestring (nullable)
filingComments[].recordAuthorPractitioner.displayNamestring (nullable)
filingComments[].recordAuthorPractitioner.identifierTypeenum (nullable)One of: medicus-staff-id, medicus-referral-provider-practitioner-id, gb-nhs-gp-connect-practitioner-id, gb-nhs-gp-national-code, gb-gmc-number, gb-gphc-number, gb-hcpc-number, gb-nmc-pin, sds-user-id.
filingComments[].recordAuthorPractitioner.identifierValuestring (nullable)
filingComments[].recordAuthorOrganisation.namestring (nullable)
filingComments[].recordAuthorOrganisation.identifierTypeenum (nullable)One of: medicus-tenant-id, nhs-england-ods-code, medicus-referral-provider-id, third-party-system-organisation-id, unknown-identifier-type.
filingComments[].recordAuthorOrganisation.identifierValuestring (nullable)
investigationGroups[].groupIdstring<uuid>
investigationGroups[].type.conceptIdstring (nullable)
investigationGroups[].type.descriptionstring (nullable)
investigationGroups[].performerCommentsstring (nullable)
investigationGroups[].results[].resultIdstring<uuid>
investigationGroups[].results[].type.conceptIdstring (nullable)
investigationGroups[].results[].type.descriptionstring (nullable)
investigationGroups[].results[].resultCode.conceptIdstring (nullable)
investigationGroups[].results[].resultCode.descriptionstring (nullable)
investigationGroups[].results[].resultValuestring (nullable)
investigationGroups[].results[].resultUnit.conceptIdstring (nullable)
investigationGroups[].results[].resultUnit.descriptionstring (nullable)
investigationGroups[].results[].resultComparatorenum (nullable)One of: >, >=, <, <=, =.
investigationGroups[].results[].resultStatusenum (nullable)One of: not-available, preliminary, final, amended.
investigationGroups[].results[].interpretation.conceptIdstring (nullable)
investigationGroups[].results[].interpretation.descriptionstring (nullable)
investigationGroups[].results[].referenceRanges[].lowerReferenceLimitstring (nullable)
investigationGroups[].results[].referenceRanges[].upperReferenceLimitstring (nullable)
investigationGroups[].results[].referenceRanges[].descriptionstring (nullable)
investigationGroups[].results[].issuedDateTimestring
investigationGroups[].results[].performedDateTimestring (nullable)
investigationGroups[].results[].approximateResultboolean (nullable)
investigationGroups[].results[].performerCommentsstring (nullable)
investigationGroups[].results[].specimen.specimenIdstring<uuid>
investigationGroups[].results[].specimen.specimenTypestring (nullable)
investigationGroups[].results[].specimen.collectedDatestring (nullable)
investigationGroups[].results[].specimen.collectedTimestring (nullable)
investigationGroups[].results[].specimen.receivedForProcessingDateTimestring (nullable)
investigationGroups[].results[].specimen.fastingStatusenum (nullable)One of: fasting.
investigationGroups[].results[].specimen.amountCollectedValuestring (nullable)
investigationGroups[].results[].specimen.amountCollectedUnit.conceptIdstring (nullable)
investigationGroups[].results[].specimen.amountCollectedUnit.descriptionstring (nullable)
investigationGroups[].results[].specimen.requesterIdentifierstring (nullable)
investigationGroups[].results[].specimen.performerIdentifierstring (nullable)
investigationGroups[].results[].specimen.performerCommentsstring (nullable)
investigationGroups[].results[].filingComments[].commentIdstring<uuid>
investigationGroups[].results[].filingComments[].commentstring (nullable)
investigationGroups[].results[].filingComments[].recordDatestring (nullable)
investigationGroups[].specimen.specimenIdstring<uuid>
investigationGroups[].specimen.specimenTypestring (nullable)
investigationGroups[].specimen.collectedDatestring (nullable)
investigationGroups[].specimen.collectedTimestring (nullable)
investigationGroups[].specimen.receivedForProcessingDateTimestring (nullable)
investigationGroups[].specimen.fastingStatusenum (nullable)One of: fasting.
investigationGroups[].specimen.amountCollectedValuestring (nullable)
investigationGroups[].specimen.amountCollectedUnit.conceptIdstring (nullable)
investigationGroups[].specimen.amountCollectedUnit.descriptionstring (nullable)
investigationGroups[].specimen.requesterIdentifierstring (nullable)
investigationGroups[].specimen.performerIdentifierstring (nullable)
investigationGroups[].specimen.performerCommentsstring (nullable)
investigationGroups[].filingComments[].commentIdstring<uuid>
investigationGroups[].filingComments[].commentstring (nullable)
investigationGroups[].filingComments[].recordDatestring (nullable)
investigationGroups[].filingComments[].recordAuthorPractitioner.displayNamestring (nullable)
investigationGroups[].filingComments[].recordAuthorPractitioner.identifierTypeenum (nullable)One of: medicus-staff-id, medicus-referral-provider-practitioner-id, gb-nhs-gp-connect-practitioner-id, gb-nhs-gp-national-code, gb-gmc-number, gb-gphc-number, gb-hcpc-number, gb-nmc-pin, sds-user-id.
investigationGroups[].filingComments[].recordAuthorPractitioner.identifierValuestring (nullable)
investigationGroups[].filingComments[].recordAuthorOrganisation.namestring (nullable)
investigationGroups[].filingComments[].recordAuthorOrganisation.identifierTypeenum (nullable)One of: medicus-tenant-id, nhs-england-ods-code, medicus-referral-provider-id, third-party-system-organisation-id, unknown-identifier-type.
investigationGroups[].filingComments[].recordAuthorOrganisation.identifierValuestring (nullable)
ungroupedResults[].resultIdstring<uuid>
ungroupedResults[].type.conceptIdstring (nullable)
ungroupedResults[].type.descriptionstring (nullable)
ungroupedResults[].resultCode.conceptIdstring (nullable)
ungroupedResults[].resultCode.descriptionstring (nullable)
ungroupedResults[].resultValuestring (nullable)
ungroupedResults[].resultUnit.conceptIdstring (nullable)
ungroupedResults[].resultUnit.descriptionstring (nullable)
ungroupedResults[].resultComparatorenum (nullable)One of: >, >=, <, <=, =.
ungroupedResults[].resultStatusenum (nullable)One of: not-available, preliminary, final, amended.
ungroupedResults[].interpretation.conceptIdstring (nullable)
ungroupedResults[].interpretation.descriptionstring (nullable)
ungroupedResults[].referenceRanges[].lowerReferenceLimitstring (nullable)
ungroupedResults[].referenceRanges[].upperReferenceLimitstring (nullable)
ungroupedResults[].referenceRanges[].descriptionstring (nullable)
ungroupedResults[].issuedDateTimestring
ungroupedResults[].performedDateTimestring (nullable)
ungroupedResults[].approximateResultboolean (nullable)
ungroupedResults[].performerCommentsstring (nullable)
ungroupedResults[].specimen.specimenIdstring<uuid>
ungroupedResults[].specimen.specimenTypestring (nullable)
ungroupedResults[].specimen.collectedDatestring (nullable)
ungroupedResults[].specimen.collectedTimestring (nullable)
ungroupedResults[].specimen.receivedForProcessingDateTimestring (nullable)
ungroupedResults[].specimen.fastingStatusenum (nullable)One of: fasting.
ungroupedResults[].specimen.amountCollectedValuestring (nullable)
ungroupedResults[].specimen.amountCollectedUnit.conceptIdstring (nullable)
ungroupedResults[].specimen.amountCollectedUnit.descriptionstring (nullable)
ungroupedResults[].specimen.requesterIdentifierstring (nullable)
ungroupedResults[].specimen.performerIdentifierstring (nullable)
ungroupedResults[].specimen.performerCommentsstring (nullable)
ungroupedResults[].filingComments[].commentIdstring<uuid>
ungroupedResults[].filingComments[].commentstring (nullable)
ungroupedResults[].filingComments[].recordDatestring (nullable)
ungroupedResults[].filingComments[].recordAuthorPractitioner.displayNamestring (nullable)
ungroupedResults[].filingComments[].recordAuthorPractitioner.identifierTypeenum (nullable)One of: medicus-staff-id, medicus-referral-provider-practitioner-id, gb-nhs-gp-connect-practitioner-id, gb-nhs-gp-national-code, gb-gmc-number, gb-gphc-number, gb-hcpc-number, gb-nmc-pin, sds-user-id.
ungroupedResults[].filingComments[].recordAuthorPractitioner.identifierValuestring (nullable)
ungroupedResults[].filingComments[].recordAuthorOrganisation.namestring (nullable)
ungroupedResults[].filingComments[].recordAuthorOrganisation.identifierTypeenum (nullable)One of: medicus-tenant-id, nhs-england-ods-code, medicus-referral-provider-id, third-party-system-organisation-id, unknown-identifier-type.
ungroupedResults[].filingComments[].recordAuthorOrganisation.identifierValuestring (nullable)
{
  "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "patientId": "4d59c916-9726-11ec-af3f-0a58a9feac02",
  "displayDescription": "Full blood count",
  "receivedDateTime": "2024-01-15 09:30:00",
  "issuedDateTime": "2024-01-15 09:30:00",
  "requestedByOrganisation": {
    "name": "Riverside Medical Practice",
    "identifierType": "medicus-tenant-id",
    "identifierValue": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "requestedByPractitioner": {
    "displayName": "Dr. Smith",
    "identifierType": "medicus-staff-id",
    "identifierValue": "a1b2c3d4"
  },
  "performedByOrganisation": {
    "name": "Riverside Medical Practice",
    "identifierType": "medicus-tenant-id",
    "identifierValue": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "performedByPractitioner": {
    "displayName": "Dr. Smith",
    "identifierType": "medicus-staff-id",
    "identifierValue": "a1b2c3d4"
  },
  "requesterComments": "Please expedite due to clinical urgency.",
  "performerComments": "Reviewed and no action required.",
  "reportIdentifier": "LAB-2024-00123",
  "filingComments": [
    {
      "commentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "comment": "Filed: result within expected range.",
      "recordDate": "2024-01-15",
      "recordAuthorPractitioner": {
        "displayName": "Dr. Smith",
        "identifierType": "medicus-staff-id",
        "identifierValue": "a1b2c3d4"
      },
      "recordAuthorOrganisation": {
        "name": "Riverside Medical Practice",
        "identifierType": "medicus-tenant-id",
        "identifierValue": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    }
  ],
  "investigationGroups": [
    {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": {
        "conceptId": "185389009",
        "description": "Telephone encounter"
      },
      "performerComments": "Reviewed and no action required.",
      "results": [
        {
          "resultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": {
            "conceptId": "185389009",
            "description": "Telephone encounter"
          },
          "resultCode": {
            "conceptId": "185389009",
            "description": "Telephone encounter"
          },
          "resultValue": "5.2",
          "resultUnit": {
            "conceptId": "185389009",
            "description": "Telephone encounter"
          },
          "resultComparator": "=",
          "resultStatus": "final",
          "interpretation": {
            "conceptId": "185389009",
            "description": "Telephone encounter"
          },
          "referenceRanges": [
            {
              "lowerReferenceLimit": null,
              "upperReferenceLimit": null,
              "description": null
            }
          ],
          "issuedDateTime": "2024-01-15 09:30:00",
          "performedDateTime": "2024-01-15 09:30:00",
          "approximateResult": false,
          "performerComments": "Reviewed and no action required.",
          "specimen": {
            "specimenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "specimenType": "Venous blood",
            "collectedDate": "2024-01-14",
            "collectedTime": "14:00:00",
            "receivedForProcessingDateTime": "2024-01-14 15:00:00",
            "fastingStatus": "fasting",
            "amountCollectedValue": "5",
            "amountCollectedUnit": {
              "conceptId": null,
              "description": null
            },
            "requesterIdentifier": "REQ-2024-00456",
            "performerIdentifier": "LAB-2024-00789",
            "performerComments": "Reviewed and no action required."
          },
          "filingComments": [
            {
              "commentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "comment": "Filed: result within expected range.",
              "recordDate": "2024-01-15",
              "recordAuthorPractitioner": {
                "displayName": "Dr. Smith",
                "identifierType": "medicus-staff-id",
                "identifierValue": "a1b2c3d4"
              },
              "recordAuthorOrganisation": null
            }
          ]
        }
      ],
      "specimen": {
        "specimenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "specimenType": "Venous blood",
        "collectedDate": "2024-01-14",
        "collectedTime": "14:00:00",
        "receivedForProcessingDateTime": "2024-01-14 15:00:00",
        "fastingStatus": "fasting",
        "amountCollectedValue": "5",
        "amountCollectedUnit": {
          "conceptId": "185389009",
          "description": "Telephone encounter"
        },
        "requesterIdentifier": "REQ-2024-00456",
        "performerIdentifier": "LAB-2024-00789",
        "performerComments": "Reviewed and no action required."
      },
      "filingComments": [
        {
          "commentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "comment": "Filed: result within expected range.",
          "recordDate": "2024-01-15",
          "recordAuthorPractitioner": {
            "displayName": "Dr. Smith",
            "identifierType": "medicus-staff-id",
            "identifierValue": "a1b2c3d4"
          },
          "recordAuthorOrganisation": {
            "name": "Riverside Medical Practice",
            "identifierType": "medicus-tenant-id",
            "identifierValue": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      ]
    }
  ],
  "ungroupedResults": [
    {
      "resultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": {
        "conceptId": "185389009",
        "description": "Telephone encounter"
      },
      "resultCode": {
        "conceptId": "185389009",
        "description": "Telephone encounter"
      },
      "resultValue": "5.2",
      "resultUnit": {
        "conceptId": "185389009",
        "description": "Telephone encounter"
      },
      "resultComparator": "=",
      "resultStatus": "final",
      "interpretation": {
        "conceptId": "185389009",
        "description": "Telephone encounter"
      },
      "referenceRanges": [
        {
          "lowerReferenceLimit": "3.5",
          "upperReferenceLimit": "11.0",
          "description": "Normal range"
        }
      ],
      "issuedDateTime": "2024-01-15 09:30:00",
      "performedDateTime": "2024-01-15 09:30:00",
      "approximateResult": false,
      "performerComments": "Reviewed and no action required.",
      "specimen": {
        "specimenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "specimenType": "Venous blood",
        "collectedDate": "2024-01-14",
        "collectedTime": "14:00:00",
        "receivedForProcessingDateTime": "2024-01-14 15:00:00",
        "fastingStatus": "fasting",
        "amountCollectedValue": "5",
        "amountCollectedUnit": {
          "conceptId": "185389009",
          "description": "Telephone encounter"
        },
        "requesterIdentifier": "REQ-2024-00456",
        "performerIdentifier": "LAB-2024-00789",
        "performerComments": "Reviewed and no action required."
      },
      "filingComments": [
        {
          "commentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "comment": "Filed: result within expected range.",
          "recordDate": "2024-01-15",
          "recordAuthorPractitioner": {
            "displayName": "Dr. Smith",
            "identifierType": "medicus-staff-id",
            "identifierValue": "a1b2c3d4"
          },
          "recordAuthorOrganisation": {
            "name": "Riverside Medical Practice",
            "identifierType": "medicus-tenant-id",
            "identifierValue": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      ]
    }
  ]
}
400 Validation error.

Response fields

FieldTypeDescription
errors[].codestring
errors[].descriptionstring
{
  "errors": [
    {
      "code": "invalid-report-id",
      "description": "The reportId is not a UUID."
    }
  ]
}
403 Forbidden: the calling application does not have the required permission.

Response fields

FieldTypeDescription
errors[].codestring
errors[].descriptionstring
{
  "errors": [
    {
      "code": "forbidden",
      "description": "The calling application does not have permission to use this endpoint."
    }
  ]
}
404 No report exists for the given reportId.

Response fields

FieldTypeDescription
errors[].codestring
errors[].descriptionstring
{
  "errors": [
    {
      "code": "investigation-report-not-found",
      "description": "Investigation report not found for this reportId."
    }
  ]
}
409 The report exists but is not in PENDING status.

Response fields

FieldTypeDescription
errors[].codestring
errors[].descriptionstring
{
  "errors": [
    {
      "code": "investigation-report-not-pending",
      "description": "This investigation report is not in PENDING status."
    }
  ]
}
422 The report contains free-text results and cannot be retrieved via this API.

Response fields

FieldTypeDescription
errors[].codestring
errors[].descriptionstring
{
  "errors": [
    {
      "code": "investigation-report-has-text-results",
      "description": "This investigation report contains free-text results and cannot be retrieved via this API."
    }
  ]
}