GitHub - DiscoverAndChange/openemr at 6e41f4aab218fe15d8389cbaaa747f2b763f3ddc

Name	Name	Last commit message	Last commit date
Latest commit History 6,542 Commits
.docs	.docs
.github	.github
.storybook	.storybook
Documentation	Documentation
ccdaservice	ccdaservice
ccr	ccr
ci	ci
cloud	cloud
common	common
config	config
contrib	contrib
controllers	controllers
custom	custom
entities	entities
gacl	gacl
images	images
interface	interface
library	library
modules/sms_email_reminder	modules/sms_email_reminder
myportal	myportal
patients	patients
phpfhir	phpfhir
portal	portal
public	public
repositories	repositories
rest_controllers	rest_controllers
services	services
sites/default	sites/default
sql	sql
templates	templates
tests	tests
.editorconfig	.editorconfig
.env.example	.env.example
.gitignore	.gitignore
.travis.yml	.travis.yml
CODE_OF_CONDUCT.md	CODE_OF_CONDUCT.md
CONTRIBUTING.md	CONTRIBUTING.md
LICENSE	LICENSE
README.md	README.md
acknowledge_license_cert.html	acknowledge_license_cert.html
acl_setup.php	acl_setup.php
acl_upgrade.php	acl_upgrade.php
admin.php	admin.php
build.xml	build.xml
composer.json	composer.json
composer.lock	composer.lock
controller.php	controller.php
docker-compose.yml	docker-compose.yml
gulpfile.js	gulpfile.js
index.php	index.php
ippf_upgrade.php	ippf_upgrade.php
openemr-rest-api.png	openemr-rest-api.png
package-lock.json	package-lock.json
package.json	package.json
rest_router.php	rest_router.php
setup.php	setup.php
sql_patch.php	sql_patch.php
sql_upgrade.php	sql_upgrade.php
version.php	version.php

(Project is in-flight - do not use in production).

Goal

This project aims to provide an easy-to-use JSON-based REST API for OpenEMR's most common functions. All code will be done in classes and separate from the view to help with codebase modernization efforts.

Team

Endpoints

POST /api/auth

Obtain an API token with your login (returns an API token):

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/auth' \
-d '{
    "username": "ServiceUser",
    "password": "password"
}'

Each call must include the token:

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medical_problem' \
  -H 'x-api-token: b0583518bce37774f5ea627f7190d228'

POST /api/facility

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/facility' -d \
'{
    "name": "Aquaria",
    "phone": "808-606-3030",
    "fax": "808-606-3031",
    "street": "1337 Bit Shifter Ln",
    "city": "San Lorenzo",
    "state": "ZZ",
    "postal_code": "54321",
    "email": "[email protected]",
    "service_location": "1",
    "billing_location": "1",
    "color": "#FF69B4"
}'

PUT /api/facility/:fid

curl -X PUT 'http:https://localhost:8300/rest_router.php?resource=/api/facility/1' -d \
'{
    "name": "Aquaria",
    "phone": "808-606-3030",
    "fax": "808-606-3031",
    "street": "1337 Bit Shifter Ln",
    "city": "San Lorenzo",
    "state": "AZ",
    "postal_code": "54321",
    "email": "[email protected]",
    "service_location": "1",
    "billing_location": "1",
    "color": "#FF69B4"
}'

GET /api/facility

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/facility'

GET /api/facility/:fid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/facility/1'

GET /api/provider

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/provider'

GET /api/provider/:prid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/provider/1'

POST /api/patient

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/patient' -d \
'{
    "title": "Mr",
    "fname": "Foo",
    "mname": "",
    "lname": "Bar",
    "street": "456 Tree Lane",
    "postal_code": "08642",
    "city": "FooTown",
    "state": "FL",
    "country_code": "US",
    "phone_contact": "123-456-7890",
    "dob": "1992-02-02",
    "sex": "Male",
    "race": "",
    "ethnicity": ""
}'

GET /api/patient

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient'

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient&fname=...&lname=...&dob=...'

GET /api/patient/:pid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1'

GET /api/patient/:pid/encounter

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/encounter'

GET /api/patient/:pid/encounter/:eid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/encounter/1'

POST /api/patient/:pid/encounter/:eid/soap_note

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/encounter/1/soap_note' -d \
'{
    "subjective": "...",
    "objective": "...",
    "assessment": "...",
    "plan": "..."
}'

PUT /api/patient/:pid/encounter/:eid/soap_note/:sid

curl -X PUT 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/encounter/1/soap_note/:sid' -d \
'{
    "subjective": "...",
    "objective": "...",
    "assessment": "...",
    "plan": "..."
}'

GET /api/patient/:pid/encounter/:eid/soap_note

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/encounter/1/soap_note'

GET /api/patient/:pid/encounter/:eid/soap_note/:sid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/encounter/1/soap_note/1'

POST /api/patient/:pid/medical_problem

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medical_problem' -d \
'{
    "title": "Dermatochalasis",
    "begdate": "2010-04-13",
    "enddate": null,
    "diagnosis": "ICD10:H02.839"
}'

PUT /api/patient/:pid/medical_problem/:mid

curl -X PUT 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medical_problem/1' -d \
'{
    "title": "Dermatochalasis",
    "begdate": "2010-04-13",
    "enddate": "2018-03-12",
    "diagnosis": "ICD10:H02.839"
}'

GET /api/patient/:pid/medical_problem

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medical_problem'

GET /api/patient/:pid/medical_problem/:mid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medical_problem/1'

POST /api/patient/:pid/allergy

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/allergy' -d \
'{
    "title": "Iodine",
    "begdate": "2010-10-13",
    "enddate": null
}'

PUT /api/patient/:pid/allergy/:aid

curl -X PUT 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/allergy/1' -d \
'{
    "title": "Iodine",
    "begdate": "2012-10-13",
    "enddate": null
}'

GET /api/patient/:pid/allergy

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/allergy'

GET /api/patient/:pid/allergy/:aid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/allergy/1'

POST /api/patient/:pid/medication

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medication' -d \
'{
    "title": "Norvasc",
    "begdate": "2013-10-13",
    "enddate": null
}'

PUT /api/patient/:pid/medication/:mid

curl -X PUT 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medication/1' -d \
'{
    "title": "Norvasc",
    "begdate": "2013-04-13",
    "enddate": null
}'

GET /api/patient/:pid/medication

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medication'

GET /api/patient/:pid/medication/:mid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/medication/1'

POST /api/patient/:pid/surgery

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/surgery' -d \
'{
    "title": "Blepharoplasty",
    "begdate": "2013-10-13",
    "enddate": null,
    "diagnosis": "CPT4:15823-50"
}'

PUT /api/patient/:pid/surgery/:sid

curl -X PUT 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/surgery/1' -d \
'{
    "title": "Blepharoplasty",
    "begdate": "2013-10-14",
    "enddate": null,
    "diagnosis": "CPT4:15823-50"
}'

GET /api/patient/:pid/surgery

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/surgery'

GET /api/patient/:pid/surgery/:sid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/surgery/1'

POST /api/patient/:pid/dental_issue

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/dental_issue' -d \
'{
    "title": "Halitosis",
    "begdate": "2015-03-17",
    "enddate": null
}'

PUT /api/patient/:pid/dental_issue/:did

curl -X PUT 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/dental_issue/1' -d \
'{
    "title": "Halitosis",
    "begdate": "2015-03-17",
    "enddate": "2018-03-20"
}'

GET /api/patient/:pid/dental_issue

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/dental_issue'

GET /api/patient/:pid/dental_issue/:did

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/dental_issue/1'

GET /api/list/:list_name

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/list/medical_problem_issue_list'

GET /api/version

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/version'

GET /api/product

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/product'

GET /api/insurance_company

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/insurance_company'

GET /api/appointment

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/appointment'

GET /api/appointment/:eid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/appointment/1'

GET /api/patient/:pid/appointment

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/appointment'

GET /api/patient/:pid/appointment/:eid

curl -X GET 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/appointment/1'

POST /api/patient/:pid/appointment

curl -X POST 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/appointment' -d \
'{
    "pc_eid":"1",
    "pc_catid": "5",
    "pc_title": "Office Visit",
    "pc_duration": "900",
    "pc_hometext": "Test",
    "pc_apptstatus": "-",
    "pc_eventDate": "2018-10-19",
    "pc_startTime": "09:00",
    "pc_facility": "9",
    "pc_billing_facility": "10"
}'

DELETE /api/patient/:pid/appointment/:eid

curl -X DELETE 'http:https://localhost:8300/rest_router.php?resource=/api/patient/1/appointment/1' -d \

Dev Notes

For business logic, make or use the services here
For controller logic, make or use the classes here
For routing declarations, use the class here.

Project Management

TODO(team): Consider using Symfony's router
TODO(matthew): Implement Particle's optional validation logic for all current validators
TODO(matthew): Implement token-based authentication
TODO(matthew): "Delete" functions for medical problems, allergies, etc
TODO(matthew): API for onotes
TODO(?): Prevent ListService from using enddate of 0000-00-00 by default
TODO(?): PatientService's insert doesn't handle dob correctly
TODO(?): Patient PUT
TODO(?): insurance company PUT/POST
TODO(?): API for pharmacies
TODO(?): API for vitals
TODO(?): API for fee sheets
TODO(?): API for patient documents
TODO(?): API for prescriptions
TODO(?): API for messages

What is that dog drawing?

That is Peppy, an old OpenEMR mascot. Long live Peppy!

License

GNU GPL

License

DiscoverAndChange/openemr

Folders and files

Latest commit

History

Repository files navigation

Goal

Team

Endpoints

POST /api/auth

POST /api/facility

PUT /api/facility/:fid

GET /api/facility

GET /api/facility/:fid

GET /api/provider

GET /api/provider/:prid

POST /api/patient

GET /api/patient

GET /api/patient/:pid

GET /api/patient/:pid/encounter

GET /api/patient/:pid/encounter/:eid

POST /api/patient/:pid/encounter/:eid/soap_note

PUT /api/patient/:pid/encounter/:eid/soap_note/:sid

GET /api/patient/:pid/encounter/:eid/soap_note

GET /api/patient/:pid/encounter/:eid/soap_note/:sid

POST /api/patient/:pid/medical_problem

PUT /api/patient/:pid/medical_problem/:mid

GET /api/patient/:pid/medical_problem

GET /api/patient/:pid/medical_problem/:mid

POST /api/patient/:pid/allergy

PUT /api/patient/:pid/allergy/:aid

GET /api/patient/:pid/allergy

GET /api/patient/:pid/allergy/:aid

POST /api/patient/:pid/medication

PUT /api/patient/:pid/medication/:mid

GET /api/patient/:pid/medication

GET /api/patient/:pid/medication/:mid

POST /api/patient/:pid/surgery

PUT /api/patient/:pid/surgery/:sid

GET /api/patient/:pid/surgery

GET /api/patient/:pid/surgery/:sid

POST /api/patient/:pid/dental_issue

PUT /api/patient/:pid/dental_issue/:did

GET /api/patient/:pid/dental_issue

GET /api/patient/:pid/dental_issue/:did

GET /api/list/:list_name

GET /api/version

GET /api/product

GET /api/insurance_company

GET /api/appointment

GET /api/appointment/:eid

GET /api/patient/:pid/appointment

GET /api/patient/:pid/appointment/:eid

POST /api/patient/:pid/appointment

DELETE /api/patient/:pid/appointment/:eid

Dev Notes

Project Management

What is that dog drawing?

License

About

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages