GET/transactional-api/list-unfulfilled-investigation-requests

List Unfulfilled Investigation Requests

Returns all UNFULFILLED investigation request items for a patient, grouped by their parent investigation request.

Authorization: Bearer token (JWT). See Authentication.

Request

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

Path and query parameters

Name	In	Type	Required	Description
patientId	query	string<uuid>	Yes	The UUID of the patient to retrieve unfulfilled investigation requests for.

Responses

200 Unfulfilled investigation requests.

[
  {
    "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "requestedDateTime": "2024-01-15 09:30:00",
    "orderMethod": "clinisys-ice",
    "requestedByOrganisation": {
      "name": "string",
      "identifierType": "medicus-tenant-id",
      "identifierValue": "string"
    },
    "requestedByPractitioner": {
      "displayName": "string",
      "identifierType": "medicus-staff-id",
      "identifierValue": "string"
    },
    "serviceProvider": {
      "name": "string",
      "identifierType": "medicus-tenant-id",
      "identifierValue": "string"
    },
    "reasonForRequest": "string",
    "additionalInformation": "string",
    "items": [
      {
        "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "requestedInvestigation": {
          "conceptId": "string",
          "description": "string"
        },
        "thirdPartyOrderReference": "string",
        "performingOrganisation": {
          "name": "string",
          "identifierType": "medicus-tenant-id",
          "identifierValue": "string"
        }
      }
    ]
  }
]

400 Validation error.

{
  "errors": [
    {
      "code": "invalid-patient-id",
      "description": "The patientId 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 Patient not found.

{
  "errors": [
    {
      "code": "patient-not-found",
      "description": "Patient not found for the id: 3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}