Skip to content

This is the design of a REST API in Postman that performs operation on case managers, cases, and related case notes, which is a part of the project CS 673 - Care Management and Co-ordination.

License

Notifications You must be signed in to change notification settings

Boro23-wq/Case-Manager-API-Design

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Case Managers API Collection

The API retrieves information about case managers and their cases.

Contact Support:

Variables

Key Value Type
baseUrl (dev) http://localhost:3000 string
baseUrl (prod/mock) https://01d9b5a5-eeac-4d0a-82f2-b7666179ebbb.mock.pstmn.io string

Endpoints


casemanagers

1. {id}

Endpoint:

Method: 
Type: 
URL: 

2. Create a case manager.

Create a new case manager using the input provided and add it to the system.

Endpoint:

Method: POST
Type: RAW
URL: {{baseUrl}}/casemanagers

Headers:

Key Value Description
Content-Type application/json
Accept application/json

Body:

{
  "username": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@cm.io",
  "phone": 8623817665
}

More example Requests/Responses:

I. Example Request: Successfully created case manager.

Body:

{
  "username": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@cm.io",
  "phone": 8623817665
}

I. Example Response: Successfully created case manager.

{
  "username": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@cm.io",
  "phone": 8623817665,
  "caseManagerId": "378cdddc-31af-481c-9000-2ab4eabeebaf",
  "createdAt": "2021-01-30T08:30:00Z",
  "modifiedAt": "2021-01-31T08:30:00Z"
}

Status Code: 201


II. Example Request: Invalid request. Please fill the required input/inputs.

Body:

{
//   "username": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@cm.io",
  "phone": 8623817665
}

II. Example Response: Invalid request. Please fill the required input/inputs.

{
  "statusCode": 400,
  "description": "Invalid request. Please fill the required input/inputs."
}

Status Code: 400


III. Example Request: Bad request. Can't find the requested resource.

Body:

{
  "username": "johndoe",
//   "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@cm.io",
  "phone": 8623817665
}

III. Example Response: Bad request. Can't find the requested resource.

{
  "statusCode": 404,
  "description": "Bad request. Can't find the requested resource."
}

Status Code: 404


IV. Example Request: Internal server error. Can't fulfill the request.

Body:

// {
//   "username": "johndoe",
//   "firstName": "John",
//   "lastName": "Doe",
//   "email": "johndoe@cm.io",
//   "phone": 8623817665
// }

IV. Example Response: Internal server error. Can't fulfill the request.

{
  "statusCode": 500,
  "description": "Internal server error. Can't fulfill the request."
}

Status Code: 500


3. Find all case managers.

Get all the case managers and their cases recorded in the system.

Endpoint:

Method: GET
Type: 
URL: {{baseUrl}}/casemanagers

Headers:

Key Value Description
Accept application/json

More example Requests/Responses:

I. Example Request: Successfully retrieved all the case managers.

Body: None

I. Example Response: Successfully retrieved all the case managers.

[
  {
    "username": "johndoe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoe@cm.io",
    "phone": 8623817665,
    "caseManagerId": "378cdddc-31af-481c-9000-2ab4eabeebaf",
    "createdAt": "2021-01-30T08:30:00Z",
    "modifiedAt": "2021-01-31T08:30:00Z",
    "cases": [
      {
        "status": "Active",
        "category": "Eye",
        "severity": "0-Critical Impact",
        "subject": "Operation follow-up",
        "patientDetail": {
          "firstName": "Matt",
          "lastName": "Turner",
          "userName": "mattturner10",
          "phone": 9452877662,
          "email": "mattturner@gmail.com",
          "id": "46005a82-a612-4dc1-9279-7215df6895cd"
        },
        "solution": {
          "solutionSubject": "Operate eye disease.",
          "investigation": "Diseases on the left eye and abnormal eye development and function.",
          "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
        },
        "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
        "createdAt": "2021-03-30T08:30:00Z",
        "modifiedAt": "2021-04-28T08:30:00Z",
        "assignedTo": {
          "firstName": "Katherine",
          "lastName": "Marshall",
          "phone": 8452877665,
          "email": "kathmarshall@hm.io",
          "id": "26005a82-a612-4dc1-9279-7215df6895cd",
          "assignedOn": "2021-03-30T08:30:00Z",
          "profession": "Ophthalmologists"
        },
        "milestones": [
          {
            "description": "Home therapy for left eye before surgery.",
            "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
            "createdAt": "2022-10-21T01:12:23.926Z"
          },
          {
            "description": "Home therapy for left eye before surgery.",
            "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
            "createdAt": "2022-10-21T01:12:23.926Z"
          }
        ],
        "activities": [
          {
            "description": "Uploaded X-Ray report.",
            "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          },
          {
            "description": "Uploaded X-Ray report.",
            "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          }
        ],
        "notes": [
          {
            "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
            "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          },
          {
            "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
            "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          }
        ]
      },
      {
        "status": "Active",
        "category": "Eye",
        "severity": "0-Critical Impact",
        "subject": "Operation follow-up",
        "patientDetail": {
          "firstName": "Matt",
          "lastName": "Turner",
          "userName": "mattturner10",
          "phone": 9452877662,
          "email": "mattturner@gmail.com",
          "id": "46005a82-a612-4dc1-9279-7215df6895cd"
        },
        "solution": {
          "solutionSubject": "Operate eye disease.",
          "investigation": "Diseases on the left eye and abnormal eye development and function.",
          "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
        },
        "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
        "createdAt": "2021-03-30T08:30:00Z",
        "modifiedAt": "2021-04-28T08:30:00Z",
        "assignedTo": {
          "firstName": "Katherine",
          "lastName": "Marshall",
          "phone": 8452877665,
          "email": "kathmarshall@hm.io",
          "id": "26005a82-a612-4dc1-9279-7215df6895cd",
          "assignedOn": "2021-03-30T08:30:00Z",
          "profession": "Ophthalmologists"
        },
        "milestones": [
          {
            "description": "Home therapy for left eye before surgery.",
            "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
            "createdAt": "2022-10-21T01:12:23.926Z"
          },
          {
            "description": "Home therapy for left eye before surgery.",
            "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
            "createdAt": "2022-10-21T01:12:23.926Z"
          }
        ],
        "activities": [
          {
            "description": "Uploaded X-Ray report.",
            "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          },
          {
            "description": "Uploaded X-Ray report.",
            "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          }
        ],
        "notes": [
          {
            "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
            "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          },
          {
            "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
            "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          }
        ]
      }
    ]
  },
  {
    "username": "johndoe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johndoe@cm.io",
    "phone": 8623817665,
    "caseManagerId": "378cdddc-31af-481c-9000-2ab4eabeebaf",
    "createdAt": "2021-01-30T08:30:00Z",
    "modifiedAt": "2021-01-31T08:30:00Z",
    "cases": [
      {
        "status": "Active",
        "category": "Eye",
        "severity": "0-Critical Impact",
        "subject": "Operation follow-up",
        "patientDetail": {
          "firstName": "Matt",
          "lastName": "Turner",
          "userName": "mattturner10",
          "phone": 9452877662,
          "email": "mattturner@gmail.com",
          "id": "46005a82-a612-4dc1-9279-7215df6895cd"
        },
        "solution": {
          "solutionSubject": "Operate eye disease.",
          "investigation": "Diseases on the left eye and abnormal eye development and function.",
          "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
        },
        "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
        "createdAt": "2021-03-30T08:30:00Z",
        "modifiedAt": "2021-04-28T08:30:00Z",
        "assignedTo": {
          "firstName": "Katherine",
          "lastName": "Marshall",
          "phone": 8452877665,
          "email": "kathmarshall@hm.io",
          "id": "26005a82-a612-4dc1-9279-7215df6895cd",
          "assignedOn": "2021-03-30T08:30:00Z",
          "profession": "Ophthalmologists"
        },
        "milestones": [
          {
            "description": "Home therapy for left eye before surgery.",
            "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
            "createdAt": "2022-10-21T01:12:23.926Z"
          },
          {
            "description": "Home therapy for left eye before surgery.",
            "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
            "createdAt": "2022-10-21T01:12:23.926Z"
          }
        ],
        "activities": [
          {
            "description": "Uploaded X-Ray report.",
            "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          },
          {
            "description": "Uploaded X-Ray report.",
            "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          }
        ],
        "notes": [
          {
            "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
            "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          },
          {
            "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
            "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          }
        ]
      },
      {
        "status": "Active",
        "category": "Eye",
        "severity": "0-Critical Impact",
        "subject": "Operation follow-up",
        "patientDetail": {
          "firstName": "Matt",
          "lastName": "Turner",
          "userName": "mattturner10",
          "phone": 9452877662,
          "email": "mattturner@gmail.com",
          "id": "46005a82-a612-4dc1-9279-7215df6895cd"
        },
        "solution": {
          "solutionSubject": "Operate eye disease.",
          "investigation": "Diseases on the left eye and abnormal eye development and function.",
          "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
        },
        "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
        "createdAt": "2021-03-30T08:30:00Z",
        "modifiedAt": "2021-04-28T08:30:00Z",
        "assignedTo": {
          "firstName": "Katherine",
          "lastName": "Marshall",
          "phone": 8452877665,
          "email": "kathmarshall@hm.io",
          "id": "26005a82-a612-4dc1-9279-7215df6895cd",
          "assignedOn": "2021-03-30T08:30:00Z",
          "profession": "Ophthalmologists"
        },
        "milestones": [
          {
            "description": "Home therapy for left eye before surgery.",
            "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
            "createdAt": "2022-10-21T01:12:23.926Z"
          },
          {
            "description": "Home therapy for left eye before surgery.",
            "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
            "createdAt": "2022-10-21T01:12:23.926Z"
          }
        ],
        "activities": [
          {
            "description": "Uploaded X-Ray report.",
            "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          },
          {
            "description": "Uploaded X-Ray report.",
            "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          }
        ],
        "notes": [
          {
            "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
            "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          },
          {
            "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
            "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
            "createdAt": "2022-10-21T01:14:27.516Z"
          }
        ]
      }
    ]
  }
]

Status Code: 200


II. Example Request: Invalid request. Please fill the required input/inputs.

Query:

Key Value Description
page 1
perPage 10

Body: None

II. Example Response: Invalid request. Please fill the required input/inputs.

{
  "statusCode": 400,
  "description": "Invalid request. Please fill the required input/inputs."
}

Status Code: 400


III. Example Request: Bad request. Can't find the requested resource.

Query:

Key Value Description
page 1
perPage 10

Body: None

III. Example Response: Bad request. Can't find the requested resource.

{
  "statusCode": 404,
  "description": "Bad request. Can't find the requested resource."
}

Status Code: 404


IV. Example Request: Internal server error. Can't fulfill the request.

Query:

Key Value Description
page 1
perPage 10

Body: None

IV. Example Response: Internal server error. Can't fulfill the request.

{
  "statusCode": 500,
  "description": "Internal server error. Can't fulfill the request."
}

Status Code: 500


cases

1. {caseId}

Endpoint:

Method: 
Type: 
URL: 

2. Create a case.

Create a new case using the input provided and add it to the system.

Endpoint:

Method: POST
Type: RAW
URL: {{baseUrl}}/cases

Headers:

Key Value Description
Content-Type application/json
Accept application/json

Body:

{
  "status": "Active",
  "category": "Eye",
  "severity": "0-Critical Impact",
  "subject": "Operation follow-up",
  "patientDetail": {
    "firstName": "Matt",
    "lastName": "Turner",
    "userName": "mattturner10",
    "phone": 9452877662,
    "email": "mattturner@gmail.com",
    "id": "46005a82-a612-4dc1-9279-7215df6895cd"
  },
  "solution": {
    "solutionSubject": "Operate eye disease.",
    "investigation": "Diseases on the left eye and abnormal eye development and function.",
    "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
  },
  "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
  "createdAt": "2021-03-30T08:30:00Z",
  "modifiedAt": "2021-04-28T08:30:00Z",
  "assignedTo": {
    "firstName": "Katherine",
    "lastName": "Marshall",
    "phone": 8452877665,
    "email": "kathmarshall@hm.io",
    "id": "26005a82-a612-4dc1-9279-7215df6895cd",
    "assignedOn": "2021-03-30T08:30:00Z",
    "profession": "Ophthalmologists"
  },
  "milestones": [
    {
      "description": "Home therapy for left eye before surgery.",
      "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
      "createdAt": "2022-10-21T01:12:23.926Z"
    },
    {
      "description": "Home therapy for left eye before surgery.",
      "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
      "createdAt": "2022-10-21T01:12:23.926Z"
    }
  ],
  "activities": [
    {
      "description": "Uploaded X-Ray report.",
      "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
      "createdAt": "2022-10-21T01:14:27.516Z"
    },
    {
      "description": "Uploaded X-Ray report.",
      "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
      "createdAt": "2022-10-21T01:14:27.516Z"
    }
  ],
  "notes": [
    {
      "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
      "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
      "createdAt": "2022-10-21T01:14:27.516Z"
    },
    {
      "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
      "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
      "createdAt": "2022-10-21T01:14:27.516Z"
    }
  ]
}

More example Requests/Responses:

I. Example Request: Successfully created case.

Body:

{
  "status": "Active",
  "category": "Eye",
  "severity": "0-Critical Impact",
  "subject": "Operation follow-up",
  "patientDetail": {
    "firstName": "Matt",
    "lastName": "Turner",
    "userName": "mattturner10",
    "phone": 9452877662,
    "email": "mattturner@gmail.com",
    "id": "46005a82-a612-4dc1-9279-7215df6895cd"
  },
  "solution": {
    "solutionSubject": "Operate eye disease.",
    "investigation": "Diseases on the left eye and abnormal eye development and function.",
    "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
  },
  "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
  "createdAt": "2021-03-30T08:30:00Z",
  "modifiedAt": "2021-04-28T08:30:00Z",
  "assignedTo": {
    "firstName": "Katherine",
    "lastName": "Marshall",
    "phone": 8452877665,
    "email": "kathmarshall@hm.io",
    "id": "26005a82-a612-4dc1-9279-7215df6895cd",
    "assignedOn": "2021-03-30T08:30:00Z",
    "profession": "Ophthalmologists"
  },
  "milestones": [
    {
      "description": "Home therapy for left eye before surgery.",
      "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
      "createdAt": "2022-10-21T01:12:23.926Z"
    },
    {
      "description": "Home therapy for left eye before surgery.",
      "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
      "createdAt": "2022-10-21T01:12:23.926Z"
    }
  ],
  "activities": [
    {
      "description": "Uploaded X-Ray report.",
      "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
      "createdAt": "2022-10-21T01:14:27.516Z"
    },
    {
      "description": "Uploaded X-Ray report.",
      "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
      "createdAt": "2022-10-21T01:14:27.516Z"
    }
  ],
  "notes": [
    {
      "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
      "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
      "createdAt": "2022-10-21T01:14:27.516Z"
    },
    {
      "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
      "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
      "createdAt": "2022-10-21T01:14:27.516Z"
    }
  ]
}

I. Example Response: Successfully created case.

{
  "status": "Active",
  "category": "Eye",
  "severity": "0-Critical Impact",
  "subject": "Operation follow-up",
  "patientDetail": {
    "firstName": "Matt",
    "lastName": "Turner",
    "userName": "mattturner10",
    "phone": 9452877662,
    "email": "mattturner@gmail.com",
    "id": "46005a82-a612-4dc1-9279-7215df6895cd"
  },
  "solution": {
    "solutionSubject": "Operate eye disease.",
    "investigation": "Diseases on the left eye and abnormal eye development and function.",
    "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
  },
  "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
  "createdAt": "2021-03-30T08:30:00Z",
  "modifiedAt": "2021-04-28T08:30:00Z"
}

Status Code: 201


II. Example Request: Invalid request. Please fill the required input/inputs.

Body: None

II. Example Response: Invalid request. Please fill the required input/inputs.

{
  "statusCode": 400,
  "description": "Invalid request. Please fill the required input/inputs."
}

Status Code: 400


III. Example Request: Bad request. Can't find the requested resource.

Body: None

III. Example Response: Bad request. Can't find the requested resource.

{
  "statusCode": 404,
  "description": "Bad request. Can't find the requested resource."
}

Status Code: 404


IV. Example Request: Internal server error. Can't fulfill the request.

Body: None

IV. Example Response: Internal server error. Can't fulfill the request.

{
  "statusCode": 500,
  "description": "Internal server error. Can't fulfill the request."
}

Status Code: 500


3. Find all cases.

Get all the cases recorded in the system.

Endpoint:

Method: GET
Type: 
URL: {{baseUrl}}/cases

Headers:

Key Value Description
Accept application/json

More example Requests/Responses:

I. Example Request: Successfully retrieved all the cases.

Body: None

I. Example Response: Successfully retrieved all the cases.

[
  {
    "status": "Active",
    "category": "Eye",
    "severity": "0-Critical Impact",
    "subject": "Operation follow-up",
    "patientDetail": {
      "firstName": "Matt",
      "lastName": "Turner",
      "userName": "mattturner10",
      "phone": 9452877662,
      "email": "mattturner@gmail.com",
      "id": "46005a82-a612-4dc1-9279-7215df6895cd"
    },
    "solution": {
      "solutionSubject": "Operate eye disease.",
      "investigation": "Diseases on the left eye and abnormal eye development and function.",
      "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
    },
    "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
    "createdAt": "2021-03-30T08:30:00Z",
    "modifiedAt": "2021-04-28T08:30:00Z",
    "assignedTo": {
      "firstName": "Katherine",
      "lastName": "Marshall",
      "phone": 8452877665,
      "email": "kathmarshall@hm.io",
      "id": "26005a82-a612-4dc1-9279-7215df6895cd",
      "assignedOn": "2021-03-30T08:30:00Z",
      "profession": "Ophthalmologists"
    },
    "milestones": [
      {
        "description": "Home therapy for left eye before surgery.",
        "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
        "createdAt": "2022-10-21T01:12:23.926Z"
      },
      {
        "description": "Home therapy for left eye before surgery.",
        "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
        "createdAt": "2022-10-21T01:12:23.926Z"
      }
    ],
    "activities": [
      {
        "description": "Uploaded X-Ray report.",
        "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
        "createdAt": "2022-10-21T01:14:27.516Z"
      },
      {
        "description": "Uploaded X-Ray report.",
        "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
        "createdAt": "2022-10-21T01:14:27.516Z"
      }
    ],
    "notes": [
      {
        "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
        "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
        "createdAt": "2022-10-21T01:14:27.516Z"
      },
      {
        "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
        "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
        "createdAt": "2022-10-21T01:14:27.516Z"
      }
    ]
  },
  {
    "status": "Active",
    "category": "Eye",
    "severity": "0-Critical Impact",
    "subject": "Operation follow-up",
    "patientDetail": {
      "firstName": "Matt",
      "lastName": "Turner",
      "userName": "mattturner10",
      "phone": 9452877662,
      "email": "mattturner@gmail.com",
      "id": "46005a82-a612-4dc1-9279-7215df6895cd"
    },
    "solution": {
      "solutionSubject": "Operate eye disease.",
      "investigation": "Diseases on the left eye and abnormal eye development and function.",
      "resolution": "Successfully operate on disease on the left eye and normal eye development and function."
    },
    "caseId": "36005a82-a612-4dc1-9279-7215df6895cd",
    "createdAt": "2021-03-30T08:30:00Z",
    "modifiedAt": "2021-04-28T08:30:00Z",
    "assignedTo": {
      "firstName": "Katherine",
      "lastName": "Marshall",
      "phone": 8452877665,
      "email": "kathmarshall@hm.io",
      "id": "26005a82-a612-4dc1-9279-7215df6895cd",
      "assignedOn": "2021-03-30T08:30:00Z",
      "profession": "Ophthalmologists"
    },
    "milestones": [
      {
        "description": "Home therapy for left eye before surgery.",
        "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
        "createdAt": "2022-10-21T01:12:23.926Z"
      },
      {
        "description": "Home therapy for left eye before surgery.",
        "id": "30027811-1ddb-4135-bb94-3a68aae1491c",
        "createdAt": "2022-10-21T01:12:23.926Z"
      }
    ],
    "activities": [
      {
        "description": "Uploaded X-Ray report.",
        "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
        "createdAt": "2022-10-21T01:14:27.516Z"
      },
      {
        "description": "Uploaded X-Ray report.",
        "id": "a7a32579-d7c3-45ef-8b5f-8eac996db599",
        "createdAt": "2022-10-21T01:14:27.516Z"
      }
    ],
    "notes": [
      {
        "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
        "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
        "createdAt": "2022-10-21T01:14:27.516Z"
      },
      {
        "comment": "Client is at risk of being non-adherent to medications and other appointments. Client needs reminders to assist with keeping appointments.",
        "id": "n7a42579-d7c3-45ef-8b5f-8eac996db599",
        "createdAt": "2022-10-21T01:14:27.516Z"
      }
    ]
  }
]

Status Code: 200


II. Example Request: Invalid request. Please fill the required input/inputs.

Query:

Key Value Description
page 1
perPage 10

Body: None

II. Example Response: Invalid request. Please fill the required input/inputs.

{
  "statusCode": 400,
  "description": "Invalid request. Please fill the required input/inputs."
}

Status Code: 400


III. Example Request: Bad request. Can't find the requested resource.

Query:

Key Value Description
page 1
perPage 10

Body: None

III. Example Response: Bad request. Can't find the requested resource.

{
  "statusCode": 404,
  "description": "Bad request. Can't find the requested resource."
}

Status Code: 404


IV. Example Request: Internal server error. Can't fulfill the request.

Query:

Key Value Description
page 1
perPage 10

Body: None

IV. Example Response: Internal server error. Can't fulfill the request.

{
  "statusCode": 500,
  "description": "Internal server error. Can't fulfill the request."
}

Status Code: 500



Back to top

Generated at 2022-10-30 21:18:27 by docgen

About

This is the design of a REST API in Postman that performs operation on case managers, cases, and related case notes, which is a part of the project CS 673 - Care Management and Co-ordination.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published