Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 of 13 tasks
codecakes opened this issue Aug 5, 2024 · 6 comments
Open
1 of 13 tasks
Labels
Milestone

Comments

@codecakes
Copy link
Contributor

codecakes commented Aug 5, 2024

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

  • Add the attributes in response
  • Add missing DTOs
  • Add test cases to test attributes as return value in the GeoLocationService
  • Implement the attributes as return value to the GeoLocationService
  • Implement response from Repository layer
  • Implement domain aggregate logic and necessary logic in domain layer

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:

  • Add the attributes in response
  • Add missing DTOs
  • Add unit tests to test attributes as return value in the GeoLocationService
  • Add automation test to test against api
  • Implement the attributes as return value to the GeoLocationService
  • Implement response from Repository layer
  • Implement domain aggregate logic and necessary logic in domain layer

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

@codecakes codecakes added enhancement New feature or request C4GT Community labels Aug 5, 2024
Copy link

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

  • Sub-Category - Please mention the sub-category if any for the ticket

Please update the ticket

@Ris-code
Copy link

Ris-code commented Aug 8, 2024

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

@codecakes
Copy link
Contributor Author

@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.

codecakes added a commit that referenced this issue Aug 12, 2024
This PR enables correct signature check for Implementation classes subclassed from an Interface class. 
- Implements signatures for functional and decoupled GeolocationQueryService
- Adds updated stub support to test GeolocationQueryService Interface
unit tests
- Adds supporting service and interface for #12

It also enables GeolocationQueryService to act as a singleton class during DI and adds decoupled support for services against its interfaces.
@codecakes codecakes added this to the geolocation milestone Aug 21, 2024
@VedantKhairnar
Copy link

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

@codecakes
Copy link
Contributor Author

@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
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants