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

add ordertype resource #33

Merged
merged 3 commits into from
Nov 18, 2019
Merged

add ordertype resource #33

merged 3 commits into from
Nov 18, 2019

Conversation

batbrain7
Copy link
Collaborator

@batbrain7 batbrain7 commented Nov 13, 2019

add the ordertype resource document

@@ -0,0 +1,78 @@
# Order type

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## Overview

* Orders represent requests from providers for some action to care for a patient. 
Common types of orders are prescriptions (drug orders), lab tests, radiology tests, 
procedures, and referrals.

* In nearly all cases, handling different types of orders requires specific behavior of 
the application. The OpenMRS platform is designed to handle certain types of orders. 
Adding new order types will usually only happen when new features to handle the 
new order type are also being added to the system (using a module or app).


### Create an order type

* To create an order type you need to specify below attributes in the request body. If not authenticated or authenticated user does not have sufficient privileges, a `401 Unauthorized` status is returned.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest including some text like:

Order types depend on code within the application to properly handle them, so it would be unusual to create a new order type unless some new code (e.g., a module) has been added to the system to handle the new order type.


### Delete an order type

* Delete or void an order type by its UUID. If not authenticated or authenticated user does not have sufficient privileges, a `401 Unauthorized` status is returned.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Order types are retired, not voided.

*description* | `String` | the description of the order type
*javaClassName* | `Java Class` | the java class
*parent* | `Order UUID` | the order uuid
*conceptClasses* | `Array[] : Concept UUID` | the array of concept class
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Classes of concepts that can be used to generate an order of this type.

@bmamlin bmamlin merged commit 70a6d0f into master Nov 18, 2019
@Akayeshmantha Akayeshmantha deleted the orderType branch November 18, 2019 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants