myhealthconnectsociety / project-healthcare

Healthcare Infrastructure as a Service: backend api for UI services to integrate location-aware consultation and diagnostics facilities for patient centric services
https://health.xcov19.dev
GNU Lesser General Public License v2.1
6 stars 10 forks source link

[C4GT Community]: List of attributes to return with results of facilities returned #12

Open codecakes opened 3 months ago

codecakes commented 3 months ago

Ticket Contents

Description

The /geo api returns a list of facilities. The following attributes should be included in the response that helps patients assess and choose the most suitable healthcare provider based on their individual needs and preferences:

Attribute Description JSON Type Required
Location Proximity to the patient’s home or workplace. object[str, str] true
Specialization Specific medical fields or specialties offered by the provider. list[str] true
Qualifications Credentials and expertise of doctors and healthcare staff. list[str] true
Reputation Patient reviews, ratings, and feedback. object[str, number] true
Availability Appointment slots, wait times, and operating hours. object[str, list] true
Cost Consultation fees, treatment charges, and insurance compatibility. object[str, object] false
Facilities Availability of advanced medical equipment and modern amenities. list[str] false
Accreditations Recognitions or certifications from medical boards and authorities. list[str] false
Languages Spoken Languages in which the provider can communicate with patients. list[str] false
Online Services Availability of telemedicine, online consultations, and digital health records. object[str, boolean] false
Emergency Services Provision of urgent care and 24/7 emergency support. boolean true
Network Affiliation Associations with hospitals, labs, and other healthcare facilities. object[str, list] false
Health Packages Availability of health check-up packages and preventive care services. list[str] false
Accessibility Features for disabled access, parking facilities, and public transport connectivity. list[str] false
Patient Support Customer service, follow-up care, and assistance programs. list[str] false

Goals

Goals

Expected Outcome

Calling /geo api should return the stated response.

Acceptance Criteria

Calling /geo API should return the stated response.

Implementation Details

Child issues will be opened to achieve following technical implementation:

Mockups/Wireframes

UML sequence for xcov19

Product Name

project-healthcare

Organisation Name

XCoV19

Domain

Healthcare

Tech Skills Needed

CI/CD, cURL, Flask, Python, RESTful APIs, Swagger, Test

Mentor(s)

@codecakes

Complexity

High

Category

API, Backend, Database, Refactoring, Testing

c4gt-community-support[bot] commented 3 months ago

Hi! Important Details - These following details are helpful for contributors to effectively identify and contribute to tickets.

Please update the ticket

Ris-code commented 3 months ago

@codecakes could you please assign me this issue, I would like to solve it.

codecakes commented 3 months ago

@codecakes could you please assign me this issue, I would like to solve it. @Ris-code

Sure. This task is non-trivial with a high complexity and carries multiple rounds of PRs. Before you attempt it, consider the following checklist to make your work easy:

VedantKhairnar commented 3 months ago

Hello @Ris-code Do you need any assistance in the contribution. Pls let us know. Thanks.

codecakes commented 3 months ago

@codecakes could you please assign me this issue, I would like to solve it. @Ris-code

Sure. This task is non-trivial with a high complexity and carries multiple rounds of PRs. Before you attempt it, consider the following checklist to make your work easy:

  • [ ] If this is your first time in the project, which it is indeed, How does the current complexity of the project look to you?
  • [ ] Have you understood the pattern we are following?
  • [ ] What parts the project are going to be affected, including breaking changes?
  • [ ] Since and end to end solution cannot be had in a single PR, how do you intend to start approaching the problem? Share your thoughts in the comments.
  • [ ] Which modules are you going to approach?
  • [ ] What is your test plan? What kind of test runs will you be setting up? Unit tests, smoke test, regression and automated tests?
  • [ ] Can you share a sketch, a uml or some first principle generalist design that you can later translate to implementation? Having a plan on board works wonders for everyone contributing to feature engineering.

@Ris-code feel free to raise any doubts so we can clear them.

ugly-custard commented 1 week ago

Hello @codecakes, I would like work on this issue.

I think I understand the pattern the project is following, and the project doesn't seem too complex for me to understand. I've gone through the codebase once, and tested the currently implemented api endpoint.