Τεκμηρίωση / MCP
Και τα 60 εργαλεία
Ομαδοποιημένα ανά τομέα. Οι παράμετροι με έντονη γραφή είναι υποχρεωτικές. Κάθε εργαλείο σημειώνεται με το τι μπορεί να κάνει — ανάγνωση, εγγραφή, διαγραφή ή έξοδο προς τα έξω — και με τον ρόλο που απαιτείται.
Μία ανάγνωση, ένα εργαλείο· οι εγγραφές ομαδοποιούνται
Κάθε ανάγνωση είναι δικό της εργαλείο, ώστε η επιλογή να είναι προφανής για ένα μοντέλο. Η δημιουργία, ενημέρωση και διαγραφή ενός πόρου συμπτύσσονται σε ένα εργαλείο write_* με υποχρεωτική παράμετρο action — έτσι η λίστα εργαλείων μένει διαχειρίσιμη και κάθε εγγραφή αρκετά ευρεία για να φέρει ουσιαστική προειδοποίηση διαγραφής.
Πώς διαβάζεται
38 από τα 60 εργαλεία είναι μόνο ανάγνωσης και μπορούν να κληθούν ελεύθερα. 15 μπορούν να διαγράψουν ή να ακυρώσουν δεδομένα. Τέσσερα βγαίνουν έξω από το HyperCRM και αξίζουν επιβεβαίωση σε κάθε client: η αποστολή πρόσκλησης με email, η δημοσίευση της ιστοσελίδας στο διαδίκτυο, και η δημιουργία δημόσιου συνδέσμου φόρμας.
Το practiceId δεν είναι ποτέ παράμετρος — προέρχεται από το token. Όπου ένα εργαλείο δέχεται action, η ενέργεια καθορίζει ποιες άλλες παράμετροι είναι υποχρεωτικές· η περιγραφή το λέει.
Ασθενείς
Ο φάκελος του ασθενή, οι σημειώσεις του και οι υποπόροι που κρέμονται από αυτόν.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| list_patients | searchstatustagIdlimitoffset | Μόνο ανάγνωσηΚάθε μέλος | Λίστα ασθενών του ιατρείου, με προαιρετική αναζήτηση και φίλτρα κατάστασης και ετικέτας. |
| get_patient | patientId | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση ενός ασθενή με βάση το id. |
| list_patient_notes | patientId | Μόνο ανάγνωσηΚάθε μέλος | Λίστα όλων των κλινικών σημειώσεων ενός ασθενή. |
| list_patient_files | patientId | Μόνο ανάγνωσηΚάθε μέλος | Λίστα αρχείων ασθενή. Χρησιμοποιήστε το get_file για σύνδεσμο λήψης. |
| list_patient_billing_entries | patientId | Μόνο ανάγνωσηΚάθε μέλος | Λίστα των χρεώσεων που έχουν καταγραφεί για έναν ασθενή, μαζί με το υπόλοιπο: τι οφείλει τώρα, το ίδιο ποσό με το καθολικό στη σελίδα του ασθενή. Χρησιμοποιήστε αυτό αντί να αθροίζετε εγγραφές. Μια εγγραφή receipt είναι είσπραξη, όχι παραστατικό. |
| list_patient_invoices | patientId | Μόνο ανάγνωσηΚάθε μέλος | Λίστα των αποδείξεων και τιμολογίων που έχουν εκδοθεί για έναν ασθενή. |
| get_patient_invoice_preview | patientId | Μόνο ανάγνωσηΚάθε μέλος | Υπολογισμός προσχεδίου απόδειξης ή τιμολογίου για τις μη χρεωμένες εγγραφές, χωρίς έκδοση. Για έκδοση χρησιμοποιήστε write_invoice με action=issue. |
| write_patient | actionpatientIdfirstNamelastNamedobgenderemailphoneMobileaddresspostcodecountrystatusnotifyByEmailnotifyBySms | ΓράφειΜπορεί να διαγράψειΚάθε μέλος | Δημιουργία, ενημέρωση ή διαγραφή ασθενή. action=create απαιτεί firstName και lastName· update και delete απαιτούν patientId. Η διαγραφή είναι μόνιμη. |
| write_patient_note | actionpatientIdnoteIdtitlebodyisNext | ΓράφειΜπορεί να διαγράψειΚάθε μέλος | Δημιουργία, ενημέρωση ή διαγραφή σημείωσης ασθενή. action=create απαιτεί body· update και delete απαιτούν noteId. |
| toggle_patient_tag | patientIdtagId | ΓράφειΚάθε μέλος | Προσθέτει την ετικέτα αν λείπει, την αφαιρεί αν υπάρχει ήδη. |
Ραντεβού
Κρατήσεις, δεσμεύσεις έδρας και υπολογισμένη διαθεσιμότητα.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| list_appointments | fromtochairId | Μόνο ανάγνωσηΚάθε μέλος | Λίστα ραντεβού σε χρονικό παράθυρο. Δώστε chairId για περιορισμό σε μία έδρα. |
| get_appointment | appointmentId | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση ενός ραντεβού με βάση το id. |
| get_appointment_availability | chairIddatedurationMinutes | Μόνο ανάγνωσηΚάθε μέλος | Υπολογισμός ελεύθερων διαστημάτων μιας έδρας για μία ημέρα, με βάση το ωράριο, τη ζώνη ώρας και τις υπάρχουσες κρατήσεις. |
| write_appointment | actionappointmentIdchairIdpatientIdtypetitlestartAtendAtcolorserviceRefnotes | ΓράφειΜπορεί να διαγράψειΚάθε μέλος | Δημιουργία, ενημέρωση ή ακύρωση ραντεβού. action=create απαιτεί chairId, startAt και endAt· update και cancel απαιτούν appointmentId. Το type είναι appointment, reminder ή unavailable. Οι επικαλύψεις στην ίδια έδρα απορρίπτονται. |
Χρεώσεις, αποδείξεις και τιμολόγια
Το καθολικό των χρεώσεων και τα παραστατικά (αποδείξεις και τιμολόγια) που εκδίδονται από αυτό.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| list_billing_entries | fromto | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Λίστα χρεώσεων για όλο το ιατρείο, προαιρετικά σε εύρος ημερομηνιών (ημέρες του ιατρείου, μαζί με την πρώτη και την τελευταία). Για έναν ασθενή, και για το τι οφείλει, χρησιμοποιήστε list_patient_billing_entries. |
| get_billing_entry | entryId | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση μιας χρέωσης με βάση το id. |
| get_invoice | invoiceId | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση εκδοθέντος παραστατικού (απόδειξης ή τιμολογίου) και των παγιωμένων γραμμών του. Για το προσχέδιο, get_patient_invoice_preview. |
| get_appointment_charge | appointmentId | Μόνο ανάγνωσηΚάθε μέλος | Τι χρειάζεται για να χρεωθεί ένα ραντεβού: αν μπορεί να χρεωθεί, και η υπηρεσία του καταλόγου που του αντιστοιχεί, με το id και την τιμή της. Χρησιμοποιήστε το πριν χρεώσετε ραντεβού με write_billing_entry. |
| write_billing_entry | actionentryIdpatientIddescriptionamountquantityserviceIdoccurredAtvoidReason | ΓράφειΜπορεί να διαγράψειΚάθε μέλος | Δημιουργία, ενημέρωση ή ακύρωση χρέωσης. action=create απαιτεί patientId· update και void απαιτούν entryId. Η ακύρωση είναι αντιστροφή, όχι διαγραφή — η εγγραφή μένει στο καθολικό σημειωμένη ως άκυρη. Μια εγγραφή receipt καταγράφει είσπραξη και παίρνει αριθμό είσπραξης (HCRM-0001)· δεν είναι παραστατικό. Αποδείξεις και τιμολόγια εκδίδονται με write_invoice. |
| write_invoice | actionpatientIdinvoiceIdvoidReason | ΓράφειΜπορεί να διαγράψειΚάθε μέλος | Έκδοση απόδειξης ή τιμολογίου για τις μη χρεωμένες εγγραφές ασθενή (action=issue, απαιτεί patientId) ή ακύρωση εκδοθέντος παραστατικού (action=void, απαιτεί invoiceId). Η έκδοση παγιώνει τις τρέχουσες γραμμές. |
Φόρμες
Φόρμες εισαγωγής και συναίνεσης. Όλα τα εργαλεία εδώ απαιτούν ρόλο ιδιοκτήτη, ακόμη και οι αναγνώσεις, γιατί οι υποβολές περιέχουν κλινικές απαντήσεις.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| list_forms | Καμία | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Λίστα των φορμών εισαγωγής και συναίνεσης του ιατρείου. |
| get_form | formId | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Ανάγνωση μιας φόρμας με τα πεδία της. |
| list_form_submissions | formId | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Λίστα όλων των υποβολών μιας φόρμας, νεότερες πρώτα. |
| get_form_submission | formIdsubmissionId | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Ανάγνωση μιας υποβολής και των απαντήσεών της. |
| write_form | actionformIdpatientIdtitledescriptionisActivefields | ΓράφειΜπορεί να διαγράψειΒγαίνει προς τα έξωΜόνο ιδιοκτήτης | action=create φτιάχνει φόρμα· update επεξεργάζεται μεταδεδομένα· delete τη διαγράφει· replace_fields αντικαθιστά όλη τη λίστα πεδίων· create_link εκδίδει ΔΗΜΟΣΙΟ σύνδεσμο μίας χρήσης που λήγει σε 3 ημέρες (προαιρετικά δεσμευμένο σε ασθενή, του οποίου τον φάκελο οι απαντήσεις τότε αντικαθιστούν)· seed_defaults εγκαθιστά τα πρότυπα του pack. |
Αρχεία
Το ανέβασμα γίνεται από τον browser στην αποθήκευση και δεν έχει εργαλείο· αυτά διαβάζουν και αφαιρούν ό,τι έχει αποθηκευτεί.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| get_file | fileId | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση μεταδεδομένων αρχείου με βραχύβιο υπογεγραμμένο σύνδεσμο λήψης. Για ids, list_patient_files. |
| delete_file | fileId | ΓράφειΜπορεί να διαγράψειΚάθε μέλος | Μόνιμη διαγραφή αρχείου. |
Αναφορές και αναζήτηση
Συγκεντρωτικά και αναζήτηση σε πολλές οντότητες. Οι τρεις αναφορές και το ιστορικό ελέγχου απαιτούν ιδιοκτήτη.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| get_dashboard_kpis | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Βασικοί δείκτες — σημερινά ραντεβού, ανεξόφλητα υπόλοιπα, πρόσφατη δραστηριότητα. |
| get_appointments_report | fromtogroupBy | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Πλήθος ραντεβού ανά διάστημα. Το groupBy είναι day, week ή month. |
| get_revenue_report | fromtogroupBy | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Σύνολα εσόδων ανά διάστημα. Το groupBy είναι day, week ή month. |
| get_patient_acquisition_report | fromtogroupBy | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Πλήθος νέων ασθενών ανά διάστημα. Το groupBy είναι day, week ή month. |
| list_audit_log | typefromtolimitoffset | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Ανάγνωση του ιστορικού ελέγχου, νεότερα πρώτα. Φίλτρα τύπου οντότητας και εύρους ημερομηνιών. |
| search | qlimit | Μόνο ανάγνωσηΚάθε μέλος | Αναζήτηση σε πολλές οντότητες του ιατρείου — ασθενείς, ραντεβού και άλλα. |
Ειδοποιήσεις
Τα εισερχόμενα του ίδιου του χρήστη. Όχι για όλο το ιατρείο.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| list_notifications | unreadOnlylimitoffset | Μόνο ανάγνωσηΚάθε μέλος | Λίστα των ειδοποιήσεών σας, νεότερες πρώτα, με το πλήθος μη διαβασμένων. Με unreadOnly=true παραλείπονται οι διαβασμένες. |
| mark_notifications_read | actionnotificationId | ΓράφειΚάθε μέλος | Σήμανση μιας ειδοποίησης ως διαβασμένης (action=one, απαιτεί notificationId) ή όλων (action=all). |
Ιατρείο και προσωπικό
Το προφίλ του ιατρείου, τα μέλη του και οι προσκλήσεις προσωπικού.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| get_practice | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση του προφίλ και των ρυθμίσεων του ιατρείου. |
| get_me | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση του χρήστη, του ιατρείου του, του ρόλου του και του vertical pack του ιατρείου. |
| list_practice_members | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Λίστα μελών προσωπικού και ρόλων. |
| list_invitations | Καμία | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Λίστα εκκρεμών προσκλήσεων προσωπικού. |
| update_practice | nameaddressphoneemailwebsitecountrycurrencypackIdworkTimeStartworkTimeEndcalendarSlotMinutesreminderLeadMinutestaxPercentageincludeTaxInInvoicestimezonemfaRequired | ΓράφειΜόνο ιδιοκτήτης | Ενημέρωση του ιατρείου. Πεδία προφίλ και ρυθμίσεων μπορούν να συνδυαστούν σε μία κλήση· κάθε άγνωστο πεδίο απορρίπτεται. |
| update_me | locale | ΓράφειΚάθε μέλος | Ενημέρωση των δικών σας προτιμήσεων. Ρυθμίζεται μόνο η γλώσσα διεπαφής. |
| report_bug | descriptionexpectedpagePath | ΓράφειΚάθε μέλος | Αναφορά σφάλματος στο ίδιο το HyperCRM. Η αναφορά αποθηκεύεται και στέλνεται με email στην ομάδα του HyperCRM, μαζί με το ποιος τη στέλνει. Έως 5 ανά χρήστη την ώρα. Μη γράφετε στοιχεία ασθενών. |
| write_practice_member | actionmembershipIdrole | ΓράφειΜόνο ιδιοκτήτης | action=update_role θέτει ρόλο owner ή assistant· action=remove αφαιρεί το μέλος. Και τα δύο απορρίπτονται αν θα άφηναν το ιατρείο χωρίς ιδιοκτήτη. |
| write_invitation | actioninvitationIdemailrole | ΓράφειΜπορεί να διαγράψειΒγαίνει προς τα έξωΜόνο ιδιοκτήτης | action=create ΣΤΕΛΝΕΙ ΠΡΑΓΜΑΤΙΚΟ EMAIL με σύνδεσμο μίας χρήσης που λήγει σε 3 ημέρες· action=revoke διαγράφει εκκρεμή πρόσκληση. |
Κατασκευαστής ιστοσελίδας
Η δημόσια ιστοσελίδα του ιατρείου. Οι εγγραφές αφορούν προσχέδιο μέχρι τη δημοσίευση· η δημοσίευση είναι το μόνο εργαλείο εδώ που αλλάζει ό,τι βλέπει το κοινό.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| get_site | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση της ιστοσελίδας με σελίδες, modules και FAQ. Επιστρέφει null αν δεν έχει δημιουργηθεί. |
| list_site_page_modules | pageId | Μόνο ανάγνωσηΚάθε μέλος | Ανάγνωση των modules και FAQ μιας σελίδας. |
| check_site_slug_available | slug | Μόνο ανάγνωσηΜόνο ιδιοκτήτης | Έλεγχος αν ένα slug είναι έγκυρο και ελεύθερο. Επιστρέφει διαθεσιμότητα και αιτία όταν δεν είναι. |
| write_site | actionslugtitledescriptionthemeIdisPublished | ΓράφειΜπορεί να διαγράψειΒγαίνει προς τα έξωΜόνο ιδιοκτήτης | action=create δημιουργεί την ιστοσελίδα· update αλλάζει ρυθμίσεις· publish ΔΗΜΟΣΙΕΥΕΙ ΤΟ ΤΡΕΧΟΝ ΠΡΟΣΧΕΔΙΟ στο διαδίκτυο, ορατό αμέσως σε οποιονδήποτε. |
| update_site_page | pageIdtitleslugmetaTitlemetaDescriptionisPublished | ΓράφειΜόνο ιδιοκτήτης | Επεξεργασία μεταδεδομένων μιας σελίδας — τίτλος, slug, SEO. |
| write_site_module | actionpageIdmoduleIdtypepositioncontent | ΓράφειΜπορεί να διαγράψειΜόνο ιδιοκτήτης | action=create προσθέτει module σε σελίδα (απαιτεί pageId)· update και delete απαιτούν moduleId. Οι αλλαγές αφορούν το προσχέδιο μέχρι τη δημοσίευση. |
| write_site_faq | actionpageIdfaqIdquestionanswerposition | ΓράφειΜπορεί να διαγράψειΜόνο ιδιοκτήτης | action=create προσθέτει FAQ σε σελίδα (απαιτεί pageId)· update και delete απαιτούν faqId. |
| list_blog_posts | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Εμφανίζει τα άρθρα του ιστολογίου — πρόχειρα και δημοσιευμένα — με τη διεύθυνση, την κατάστασή τους και το κείμενό τους. |
| list_blog_categories | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Εμφανίζει τις κατηγορίες στις οποίες μπορεί να καταχωρηθεί ένα άρθρο. Καλέστε το πριν γράψετε άρθρο αν θέλετε να ορίσετε κατηγορία: το id πρέπει να ανήκει σε αυτόν τον ιστότοπο. |
| write_blog_post | actionpostIdtitleslugexcerptbodycoverFileIdcategoryIdauthorTeamMemberIdstatusmetaTitlemetaDescription | ΓράφειΜπορεί να διαγράψειΜόνο ιδιοκτήτης | Δημιουργεί, επεξεργάζεται ή διαγράφει άρθρο. Το create χρειάζεται τίτλο, διεύθυνση και κείμενο· τα update και delete χρειάζονται postId. Το άρθρο δημιουργείται ως ΠΡΟΧΕΙΡΟ, και η αλλαγή μόνο της κατάστασής του δεν το βγάζει στον ζωντανό ιστότοπο — πρέπει να δημοσιευτεί ο ίδιος ο ιστότοπος. |
Κατάλογοι
Έδρες, υπηρεσίες και ετικέτες — οι λίστες από τις οποίες επιλέγει το υπόλοιπο προϊόν.
| Εργαλείο | Παράμετροι | Πρόσβαση | Τι κάνει |
|---|---|---|---|
| list_chairs | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Λίστα των εδρών θεραπείας (κρατήσιμοι πόροι). |
| list_services | isPublic | Μόνο ανάγνωσηΚάθε μέλος | Λίστα του καταλόγου υπηρεσιών. Με isPublic=true μόνο όσες προσφέρονται στη δημόσια σελίδα κράτησης. |
| list_tags | Καμία | Μόνο ανάγνωσηΚάθε μέλος | Λίστα όλων των ετικετών του ιατρείου. |
| write_chair | actionchairIdnamecolorisActive | ΓράφειΜπορεί να διαγράψειΜόνο ιδιοκτήτης | Δημιουργία, ενημέρωση ή διαγραφή έδρας. Τα update και delete απαιτούν chairId. |
| write_service | actionserviceIdnamedescriptiondurationMinutespriceisPublicisActive | ΓράφειΜπορεί να διαγράψειΜόνο ιδιοκτήτης | Δημιουργία, ενημέρωση ή διαγραφή υπηρεσίας, ή εγκατάσταση του προεπιλεγμένου καταλόγου του pack με action=seed_defaults. Τα update και delete απαιτούν serviceId. |
| write_tag | actiontagIdnamecolor | ΓράφειΜπορεί να διαγράψειΚάθε μέλος | Δημιουργία, ενημέρωση ή διαγραφή ετικέτας ασθενή. Τα update και delete απαιτούν tagId. Η διαγραφή την αφαιρεί από κάθε ασθενή που τη φέρει. |
Συχνές ερωτήσεις
Τα αρχεία ασθενών κρυπτογραφούνται κατά τη μεταφορά και την αποθήκευση, τα αρχεία φυλάσσονται ιδιωτικά και σερβίρονται μέσω συνδέσμων περιορισμένης διάρκειας, ενώ κάθε αλλαγή καταγράφεται. Το προσωπικό συνδέεται με passkeys αντί για κοινούς κωδικούς.
Ώστε η λίστα εργαλείων να μένει αρκετά μικρή για να τη διαχειριστεί ένα μοντέλο, και κάθε εργαλείο εγγραφής αρκετά ευρύ για να φέρει ουσιαστική προειδοποίηση. Ένας client βλέπει ότι το write_patient μπορεί να διαγράψει και ρωτά· δώδεκα στενά εργαλεία θα απαιτούσαν το καθένα τη δική του σήμανση και θα έπνιγαν τις αναγνώσεις.
Τα τρία που σημειώνονται ως έξοδος προς τα έξω — η πρόσκληση στέλνει πραγματικό email, η δημοσίευση κάνει την ιστοσελίδα αμέσως δημόσια, και ο σύνδεσμος φόρμας εκδίδει URL που ανοίγει όποιος τον έχει. Αξίζει επιβεβαίωση και για τα δεκαπέντε που μπορούν να διαγράψουν, ιδίως τη διαγραφή ασθενή που είναι μόνιμη.
Ναι. Οι υποβολές φορμών περιέχουν κλινικές απαντήσεις, οπότε όλος ο τομέας βρίσκεται πίσω από τον ρόλο ιδιοκτήτη και όχι μόνο οι εγγραφές του. Αυτό αντικατοπτρίζει ακριβώς το REST API — το MCP δεν είναι παρακαμπτήριος μιας άδειας που επιβάλλει η επιφάνεια HTTP.