UC21.md

API Document for UC21

Summary Table

• base_url : http://localhost:8080/iTrust2/api/v1

Function	Endpoint	Method	Request Payload	Sucess Response	Error Response
Document Office Visit	{{base_url}}/officevisits	POST	specified below	200 OK- Success Message	400 Bad Request - Missing or incorrect information 401 Unauthorized - User not authenticated
Edit Office Visit	{{base_url}}/officevisits/{id}	PUT	specified below	200 OK- Success Message	401 Unauthorized - User not authenticated 404 Not Found - id Not Found

API Document Details

Authentication

Before making any requests, users (HCP / OPH / OD) need to authenticate through the iTrust2 system

1. Document Office Visit (S1)

• ophthalmologist or optometrist HCP will enter the following eye health information

• End point : api/v1/officevisits

• Method : POST

• Request Payload :

  • Parameters:

    • patient (String) : patient user name
    • hcp (String) : hcp user name
    • date (String) : Date at which the OfficeVisit occurred
    • type (String) : Type of the OfficeVisit.
    • hospital (String) : Hospital where the OfficeVisit occurred
    • notes (String) : Doctor's Notes on the OfficeVisit
    • height (Float) : Height or length of the person. Up to a 3-digit number and potentially one digit of decimal precision. > 0
    • weight (Float) : Weight of the person. Up to a 3-digit number and potentially one digit of decimal precision. > 0
    • headCircumference (Float) : Head circumference
    • systolic (Integer) : Systolic blood pressure. 3-digit positive number
    • diastolic (Integer) : Diastolic blood pressure. 3-digit positive number.
    • hdl (Integer) : HDL cholesterol. Between 0 and 90 inclusive.
    • ldl (Integer) : LDL cholesterol. Between 0 and 600 inclusive.
    • tri (Integer) : Triglycerides cholesterol. Between 100 and 600 inclusive.
    • houseSmokingStatus (HouseholdSmokingStatus) : Smoking status of the patient's household.
    • patientSmokingStatus (PatientSmokingStatus) : Smoking status of the patient.
    • diagnoses (List) : Diagnosis List
    • eyecheckup (EyecheckupForm) : Eyecheckup Information

  • example payload

  {
    "patient": "patient1",
    "hcp": "od1",
    "date": "2023-11-22T12:43:00+09:00",
    "type": "GENERAL_CHECKUP",
    "hospital": "Severance",
    "notes": "Some notes about the visit",
    "height": 180.0,
    "weight": 75.0,
    "headCircumference": 30.0,
    "systolic": 120,
    "diastolic": 80,
    "hdl": 50,
    "ldl": 100,
    "tri": 150,
    "houseSmokingStatus": "NONSMOKING",
    "patientSmokingStatus": "NEVER",
    "diagnoses": [],
    "prescriptions": [],
    "eyecheckup": {
      "patient": "patient1",
      "hcp": "od1",
      "visualAcuityOS": 100,
      "visualAcuityOD": 100,
      "sphereOS": -1.5,
      "sphereOD": -1.25,
      "cylinderOS": 0.5,
      "cylinderOD": 0.75,
      "axisOS": 90,
      "axisOD": 85,
      "note": "Additional notes about eyecheckup"
    }
  }

  • Success Response :

    • Status : 200 OK

  • Error Response :

    • Status : 400 Bad Request
    • Status : 401 Unauthorized

2. View and Edit Office Visit (S2)

• End point : api/v1/officevisits/{id}
• Method : PUT
• Request Payload :

  • Parameters:

    • patient (String) : patient user name
    • hcp (String) : hcp user name
    • date (String) : Date at which the OfficeVisit occurred
    • type (String) : Type of the OfficeVisit.
    • hospital (String) : Hospital where the OfficeVisit occurred
    • notes (String) : Doctor's Notes on the OfficeVisit
    • height (Float) : Height or length of the person. Up to a 3-digit number and potentially one digit of decimal precision. > 0
    • weight (Float) : Weight of the person. Up to a 3-digit number and potentially one digit of decimal precision. > 0
    • headCircumference (Float) : Head circumference
    • systolic (Integer) : Systolic blood pressure. 3-digit positive number
    • diastolic (Integer) : Diastolic blood pressure. 3-digit positive number.
    • hdl (Integer) : HDL cholesterol. Between 0 and 90 inclusive.
    • ldl (Integer) : LDL cholesterol. Between 0 and 600 inclusive.
    • tri (Integer) : Triglycerides cholesterol. Between 100 and 600 inclusive.
    • houseSmokingStatus (HouseholdSmokingStatus) : Smoking status of the patient's household.
    • patientSmokingStatus (PatientSmokingStatus) : Smoking status of the patient.
    • diagnoses (List) : Diagnosis List
    • eyecheckup (EyecheckupForm) : Eyecheckup Information

  • Success Response :

    • Status : 200 OK

  • Error Response :

    • Status : 401 Unauthorized
    • Status : 404 Not Found