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

Name	In	Type	Required	Description
reportId	query	string<uuid>	Yes	The UUID of the investigation report to retrieve.

Responses

200 Investigation report detail.

{
  "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "patientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "displayDescription": "string",
  "receivedDateTime": "2024-01-15 09:30:00",
  "issuedDateTime": "2024-01-15 09:30:00",
  "requestedByOrganisation": {
    "name": "string",
    "identifierType": "medicus-tenant-id",
    "identifierValue": "string"
  },
  "requestedByPractitioner": {
    "displayName": "string",
    "identifierType": "medicus-staff-id",
    "identifierValue": "string"
  },
  "performedByOrganisation": {
    "name": "string",
    "identifierType": "medicus-tenant-id",
    "identifierValue": "string"
  },
  "performedByPractitioner": {
    "displayName": "string",
    "identifierType": "medicus-staff-id",
    "identifierValue": "string"
  },
  "requesterComments": "string",
  "performerComments": "string",
  "reportIdentifier": "string",
  "filingComments": [
    {
      "commentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "comment": "string",
      "recordDate": "2024-01-15",
      "recordAuthorPractitioner": {
        "displayName": "string",
        "identifierType": "medicus-staff-id",
        "identifierValue": "string"
      },
      "recordAuthorOrganisation": {
        "name": "string",
        "identifierType": "medicus-tenant-id",
        "identifierValue": "string"
      }
    }
  ],
  "investigationGroups": [
    {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": {
        "conceptId": "string",
        "description": "string"
      },
      "performerComments": "string",
      "results": [
        {
          "resultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "type": {
            "conceptId": "string",
            "description": "string"
          },
          "resultCode": {
            "conceptId": "string",
            "description": "string"
          },
          "resultValue": "string",
          "resultUnit": {
            "conceptId": "string",
            "description": "string"
          },
          "resultComparator": ">",
          "resultStatus": "not-available",
          "interpretation": {
            "conceptId": "string",
            "description": "string"
          },
          "referenceRanges": [
            {
              "lowerReferenceLimit": null,
              "upperReferenceLimit": null,
              "description": null
            }
          ],
          "issuedDateTime": "2024-01-15 09:30:00",
          "performedDateTime": "2024-01-15 09:30:00",
          "approximateResult": false,
          "performerComments": "string",
          "specimen": {
            "specimenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "specimenType": "string",
            "collectedDate": "2024-01-14",
            "collectedTime": "14:00:00",
            "receivedForProcessingDateTime": "2024-01-14 15:00:00",
            "fastingStatus": "fasting",
            "amountCollectedValue": "string",
            "amountCollectedUnit": {
              "conceptId": null,
              "description": null
            },
            "requesterIdentifier": "string",
            "performerIdentifier": "string",
            "performerComments": "string"
          },
          "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": "string",
        "collectedDate": "2024-01-14",
        "collectedTime": "14:00:00",
        "receivedForProcessingDateTime": "2024-01-14 15:00:00",
        "fastingStatus": "fasting",
        "amountCollectedValue": "string",
        "amountCollectedUnit": {
          "conceptId": "string",
          "description": "string"
        },
        "requesterIdentifier": "string",
        "performerIdentifier": "string",
        "performerComments": "string"
      },
      "filingComments": [
        {
          "commentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "comment": "string",
          "recordDate": "2024-01-15",
          "recordAuthorPractitioner": {
            "displayName": "string",
            "identifierType": "medicus-staff-id",
            "identifierValue": "string"
          },
          "recordAuthorOrganisation": {
            "name": "string",
            "identifierType": "medicus-tenant-id",
            "identifierValue": "string"
          }
        }
      ]
    }
  ],
  "ungroupedResults": [
    {
      "resultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": {
        "conceptId": "string",
        "description": "string"
      },
      "resultCode": {
        "conceptId": "string",
        "description": "string"
      },
      "resultValue": "string",
      "resultUnit": {
        "conceptId": "string",
        "description": "string"
      },
      "resultComparator": ">",
      "resultStatus": "not-available",
      "interpretation": {
        "conceptId": "string",
        "description": "string"
      },
      "referenceRanges": [
        {
          "lowerReferenceLimit": "string",
          "upperReferenceLimit": "string",
          "description": "string"
        }
      ],
      "issuedDateTime": "2024-01-15 09:30:00",
      "performedDateTime": "2024-01-15 09:30:00",
      "approximateResult": false,
      "performerComments": "string",
      "specimen": {
        "specimenId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "specimenType": "string",
        "collectedDate": "2024-01-14",
        "collectedTime": "14:00:00",
        "receivedForProcessingDateTime": "2024-01-14 15:00:00",
        "fastingStatus": "fasting",
        "amountCollectedValue": "string",
        "amountCollectedUnit": {
          "conceptId": "string",
          "description": "string"
        },
        "requesterIdentifier": "string",
        "performerIdentifier": "string",
        "performerComments": "string"
      },
      "filingComments": [
        {
          "commentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "comment": "string",
          "recordDate": "2024-01-15",
          "recordAuthorPractitioner": {
            "displayName": "string",
            "identifierType": "medicus-staff-id",
            "identifierValue": "string"
          },
          "recordAuthorOrganisation": {
            "name": "string",
            "identifierType": "medicus-tenant-id",
            "identifierValue": "string"
          }
        }
      ]
    }
  ]
}

400 Validation error.

{
  "errors": [
    {
      "code": "invalid-report-id",
      "description": "The reportId is not a UUID."
    }
  ]
}

403 Forbidden: the calling application does not have the required permission.

{
  "errors": [
    {
      "code": "forbidden",
      "description": "The calling application does not have permission to use this endpoint."
    }
  ]
}

404 No report exists for the given reportId.

{
  "errors": [
    {
      "code": "investigation-report-not-found",
      "description": "Investigation report not found for this reportId."
    }
  ]
}

409 The report exists but is not in PENDING status.

{
  "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.

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