OpenMRS

OpenMRS API Docs v1.11.6

OpenMRS RESTful API specification

Overview

This document is a summary of the OpenMRS API as implemented by the REST Module. More details about how to develop an API client can be found on the OpenMRS wiki.

Authorization

Basic

The OpenMRS API uses HTTP basic access authentication with your OpenMRS username and password. For example:

curl -u admin:Admin123 -i 'http://localhost:8080/openmrs/ws/rest/v1/concept'

Resource Summary

allergy

Operation	Description
POST /allergy	Create with properties in request
POST /allergy/{uuid}	Edit with given uuid, only modifying properties in request
GET /allergy/{uuid}	Fetch by uuid
DELETE /allergy/{uuid}	Delete or purge resource by uuid

app

Operation	Description
GET /app	Fetch all non-retired
GET /app/{uuid}	Fetch by uuid

concept

Operation	Description
POST /concept/{parent-uuid}/mapping/{uuid}	Edit mapping subresource with given uuid, only modifying properties in request
GET /concept/{parent-uuid}/mapping/{uuid}	Fetch mapping subresources by uuid
DELETE /concept/{parent-uuid}/mapping/{uuid}	Delete or purge resource by uuid
POST /concept/{parent-uuid}/name/{uuid}	Edit name subresource with given uuid, only modifying properties in request
GET /concept/{parent-uuid}/name/{uuid}	Fetch name subresources by uuid
DELETE /concept/{parent-uuid}/name/{uuid}	Delete or purge resource by uuid
POST /concept/{uuid}	Edit with given uuid, only modifying properties in request
GET /concept/{uuid}	Fetch by uuid
DELETE /concept/{uuid}	Delete or purge resource by uuid
POST /concept/{parent-uuid}/name	Create name subresource with properties in request
GET /concept/{parent-uuid}/name	Fetch all non-retired name subresources
POST /concept	Create with properties in request
GET /concept	Fetch all non-retired concept resources or perform search
POST /concept/{parent-uuid}/description/{uuid}	Edit description subresource with given uuid, only modifying properties in request
GET /concept/{parent-uuid}/description/{uuid}	Fetch description subresources by uuid
DELETE /concept/{parent-uuid}/description/{uuid}	Delete or purge resource by uuid
POST /concept/{parent-uuid}/description	Create description subresource with properties in request
GET /concept/{parent-uuid}/description	Fetch all non-retired description subresources
POST /concept/{parent-uuid}/mapping	Create mapping subresource with properties in request
GET /concept/{parent-uuid}/mapping	Fetch all non-retired mapping subresources

conceptclass

Operation	Description
POST /conceptclass/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptclass/{uuid}	Fetch by uuid
DELETE /conceptclass/{uuid}	Delete or purge resource by uuid
POST /conceptclass	Create with properties in request
GET /conceptclass	Fetch all non-retired

conceptdatatype

Operation	Description
POST /conceptdatatype	Create with properties in request
GET /conceptdatatype	Fetch all non-retired
GET /conceptdatatype/{uuid}	Fetch by uuid
DELETE /conceptdatatype/{uuid}	Delete or purge resource by uuid

conceptmaptype

Operation	Description
POST /conceptmaptype/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptmaptype/{uuid}	Fetch by uuid
DELETE /conceptmaptype/{uuid}	Delete or purge resource by uuid
POST /conceptmaptype	Create with properties in request
GET /conceptmaptype	Fetch all non-retired

conceptreferenceterm

Operation	Description
POST /conceptreferenceterm/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptreferenceterm/{uuid}	Fetch by uuid
DELETE /conceptreferenceterm/{uuid}	Delete or purge resource by uuid
POST /conceptreferenceterm	Create with properties in request
GET /conceptreferenceterm	Fetch all non-retired conceptreferenceterm resources or perform search

conceptreferencetermmap

Operation	Description
POST /conceptreferencetermmap/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptreferencetermmap/{uuid}	Fetch by uuid
DELETE /conceptreferencetermmap/{uuid}	Delete or purge resource by uuid
POST /conceptreferencetermmap	Create with properties in request
GET /conceptreferencetermmap	Search for conceptreferencetermmap

conceptsource

Operation	Description
POST /conceptsource/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptsource/{uuid}	Fetch by uuid
DELETE /conceptsource/{uuid}	Delete or purge resource by uuid
POST /conceptsource	Create with properties in request
GET /conceptsource	Fetch all non-retired

conceptstopword

Operation	Description
POST /conceptstopword/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptstopword/{uuid}	Fetch by uuid
DELETE /conceptstopword/{uuid}	Delete or purge resource by uuid
POST /conceptstopword	Create with properties in request
GET /conceptstopword	Fetch all non-retired

customdatatype

Operation	Description
GET /customdatatype/{parent-uuid}/handlers	Fetch all non-retired handlers subresources
GET /customdatatype/{uuid}	Fetch by uuid
DELETE /customdatatype/{uuid}	Delete or purge resource by uuid
GET /customdatatype	Fetch all non-retired

dhisconnector_dhiscategorycombos

Operation	Description
GET /dhisconnector/dhiscategorycombos/{uuid}	Fetch by uuid
DELETE /dhisconnector/dhiscategorycombos/{uuid}	Delete or purge resource by uuid

appointmentscheduling_appointmentallowingoverbook

Operation	Description
POST /appointmentscheduling/appointmentallowingoverbook/{uuid}	Edit with given uuid, only modifying properties in request
GET /appointmentscheduling/appointmentallowingoverbook/{uuid}	Fetch by uuid
DELETE /appointmentscheduling/appointmentallowingoverbook/{uuid}	Delete or purge resource by uuid
POST /appointmentscheduling/appointmentallowingoverbook	Create with properties in request
GET /appointmentscheduling/appointmentallowingoverbook	Fetch all non-retired

dhisconnector_dhisdataelements

Operation	Description
GET /dhisconnector/dhisdataelements/{uuid}	Fetch by uuid
DELETE /dhisconnector/dhisdataelements/{uuid}	Delete or purge resource by uuid

dhisconnector_dhisdatasets

Operation	Description
GET /dhisconnector/dhisdatasets	Fetch all non-retired
GET /dhisconnector/dhisdatasets/{uuid}	Fetch by uuid
DELETE /dhisconnector/dhisdatasets/{uuid}	Delete or purge resource by uuid

dhisconnector_dhisdatavaluesets

Operation	Description
POST /dhisconnector/dhisdatavaluesets	Create with properties in request
POST /dhisconnector/dhisdatavaluesets/{uuid}	Edit with given uuid, only modifying properties in request
GET /dhisconnector/dhisdatavaluesets/{uuid}	Fetch by uuid
DELETE /dhisconnector/dhisdatavaluesets/{uuid}	Delete or purge resource by uuid

dhisconnector_mappings

Operation	Description
POST /dhisconnector/mappings/{uuid}	Edit with given uuid, only modifying properties in request
GET /dhisconnector/mappings/{uuid}	Fetch by uuid
DELETE /dhisconnector/mappings/{uuid}	Delete or purge resource by uuid
POST /dhisconnector/mappings	Create with properties in request
GET /dhisconnector/mappings	Fetch all non-retired

dhisconnector_orgunits

Operation	Description
GET /dhisconnector/orgunits/{uuid}	Fetch by uuid
DELETE /dhisconnector/orgunits/{uuid}	Delete or purge resource by uuid
GET /dhisconnector/orgunits	Fetch all non-retired

dhisconnector_periodindicatorreports

Operation	Description
GET /dhisconnector/periodindicatorreports	Fetch all non-retired
GET /dhisconnector/periodindicatorreports/{uuid}	Fetch by uuid
DELETE /dhisconnector/periodindicatorreports/{uuid}	Delete or purge resource by uuid

drug

Operation	Description
POST /drug/{uuid}	Edit with given uuid, only modifying properties in request
GET /drug/{uuid}	Fetch by uuid
DELETE /drug/{uuid}	Delete or purge resource by uuid
POST /drug/{parent-uuid}/ingredient/{uuid}	Edit ingredient subresource with given uuid, only modifying properties in request
GET /drug/{parent-uuid}/ingredient/{uuid}	Fetch ingredient subresources by uuid
DELETE /drug/{parent-uuid}/ingredient/{uuid}	Delete or purge resource by uuid
POST /drug	Create with properties in request
GET /drug	Fetch all non-retired drug resources or perform search
POST /drug/{parent-uuid}/ingredient	Create ingredient subresource with properties in request
GET /drug/{parent-uuid}/ingredient	Fetch all non-retired ingredient subresources

encounter

Operation	Description
POST /encounter/{parent-uuid}/encounterprovider	Create encounterprovider subresource with properties in request
GET /encounter/{parent-uuid}/encounterprovider	Fetch all non-retired encounterprovider subresources
POST /encounter/{uuid}	Edit with given uuid, only modifying properties in request
GET /encounter/{uuid}	Fetch by uuid
DELETE /encounter/{uuid}	Delete or purge resource by uuid
POST /encounter	Create with properties in request
GET /encounter	Search for encounter
POST /encounter/{parent-uuid}/encounterprovider/{uuid}	Edit encounterprovider subresource with given uuid, only modifying properties in request
GET /encounter/{parent-uuid}/encounterprovider/{uuid}	Fetch encounterprovider subresources by uuid
DELETE /encounter/{parent-uuid}/encounterprovider/{uuid}	Delete or purge resource by uuid

encounterrole

Operation	Description
POST /encounterrole	Create with properties in request
GET /encounterrole	Fetch all non-retired
POST /encounterrole/{uuid}	Edit with given uuid, only modifying properties in request
GET /encounterrole/{uuid}	Fetch by uuid
DELETE /encounterrole/{uuid}	Delete or purge resource by uuid

encountertype

Operation	Description
POST /encountertype	Create with properties in request
GET /encountertype	Fetch all non-retired
POST /encountertype/{uuid}	Edit with given uuid, only modifying properties in request
GET /encountertype/{uuid}	Fetch by uuid
DELETE /encountertype/{uuid}	Delete or purge resource by uuid

appointmentscheduling_appointmentblock

Operation	Description
POST /appointmentscheduling/appointmentblock	Create with properties in request
GET /appointmentscheduling/appointmentblock	Fetch all non-retired
POST /appointmentscheduling/appointmentblock/{uuid}	Edit with given uuid, only modifying properties in request
GET /appointmentscheduling/appointmentblock/{uuid}	Fetch by uuid
DELETE /appointmentscheduling/appointmentblock/{uuid}	Delete or purge resource by uuid

extension

Operation	Description
GET /extension/{uuid}	Fetch by uuid

field

Operation	Description
POST /field/{parent-uuid}/answer	Create answer subresource with properties in request
GET /field/{parent-uuid}/answer	Fetch all non-retired answer subresources
POST /field	Create with properties in request
GET /field	Fetch all non-retired
POST /field/{uuid}	Edit with given uuid, only modifying properties in request
GET /field/{uuid}	Fetch by uuid
DELETE /field/{uuid}	Delete or purge resource by uuid
POST /field/{parent-uuid}/answer/{uuid}	Edit answer subresource with given uuid, only modifying properties in request
GET /field/{parent-uuid}/answer/{uuid}	Fetch answer subresources by uuid
DELETE /field/{parent-uuid}/answer/{uuid}	Delete or purge resource by uuid

fieldtype

Operation	Description
POST /fieldtype	Create with properties in request
GET /fieldtype	Fetch all non-retired
POST /fieldtype/{uuid}	Edit with given uuid, only modifying properties in request
GET /fieldtype/{uuid}	Fetch by uuid
DELETE /fieldtype/{uuid}	Delete or purge resource by uuid

form

Operation	Description
POST /form/{parent-uuid}/resource	Create resource subresource with properties in request
POST /form/{parent-uuid}/formfield/{uuid}	Edit formfield subresource with given uuid, only modifying properties in request
GET /form/{parent-uuid}/formfield/{uuid}	Fetch formfield subresources by uuid
DELETE /form/{parent-uuid}/formfield/{uuid}	Delete or purge resource by uuid
POST /form/{uuid}	Edit with given uuid, only modifying properties in request
GET /form/{uuid}	Fetch by uuid
DELETE /form/{uuid}	Delete or purge resource by uuid
POST /form/{parent-uuid}/resource/{uuid}	Edit resource subresource with given uuid, only modifying properties in request
DELETE /form/{parent-uuid}/resource/{uuid}	Delete or purge resource by uuid
POST /form/{parent-uuid}/formfield	Create formfield subresource with properties in request
GET /form/{parent-uuid}/formfield	Fetch all non-retired formfield subresources
POST /form	Create with properties in request
GET /form	Fetch all non-retired

hl7

Operation	Description
POST /hl7	Create with properties in request

hl7source

Operation	Description
POST /hl7source/{uuid}	Edit with given uuid, only modifying properties in request
DELETE /hl7source/{uuid}	Delete or purge resource by uuid
POST /hl7source	Create with properties in request

location

Operation	Description
POST /location	Create with properties in request
GET /location	Fetch all non-retired location resources or perform search
POST /location/{parent-uuid}/attribute/{uuid}	Edit attribute subresource with given uuid, only modifying properties in request
GET /location/{parent-uuid}/attribute/{uuid}	Fetch attribute subresources by uuid
DELETE /location/{parent-uuid}/attribute/{uuid}	Delete or purge resource by uuid
POST /location/{parent-uuid}/attribute	Create attribute subresource with properties in request
GET /location/{parent-uuid}/attribute	Fetch all non-retired attribute subresources
POST /location/{uuid}	Edit with given uuid, only modifying properties in request
GET /location/{uuid}	Fetch by uuid
DELETE /location/{uuid}	Delete or purge resource by uuid

locationattributetype

Operation	Description
POST /locationattributetype	Create with properties in request
GET /locationattributetype	Fetch all non-retired
POST /locationattributetype/{uuid}	Edit with given uuid, only modifying properties in request
GET /locationattributetype/{uuid}	Fetch by uuid
DELETE /locationattributetype/{uuid}	Delete or purge resource by uuid

locationtag

Operation	Description
POST /locationtag/{uuid}	Edit with given uuid, only modifying properties in request
DELETE /locationtag/{uuid}	Delete or purge resource by uuid
POST /locationtag	Create with properties in request

obs

Operation	Description
POST /obs	Create with properties in request
GET /obs	Search for obs
POST /obs/{uuid}	Edit with given uuid, only modifying properties in request
GET /obs/{uuid}	Fetch by uuid
DELETE /obs/{uuid}	Delete or purge resource by uuid

appointmentscheduling_appointmentrequest

Operation	Description
POST /appointmentscheduling/appointmentrequest/{uuid}	Edit with given uuid, only modifying properties in request
GET /appointmentscheduling/appointmentrequest/{uuid}	Fetch by uuid
DELETE /appointmentscheduling/appointmentrequest/{uuid}	Delete or purge resource by uuid
POST /appointmentscheduling/appointmentrequest	Create with properties in request
GET /appointmentscheduling/appointmentrequest	Fetch all non-retired

order

Operation	Description
POST /order	Create with properties in request
GET /order/{uuid}	Fetch by uuid
DELETE /order/{uuid}	Delete or purge resource by uuid

orderfrequency

Operation	Description
GET /orderfrequency	Fetch all non-retired
POST /orderfrequency/{uuid}	Edit with given uuid, only modifying properties in request
GET /orderfrequency/{uuid}	Fetch by uuid
DELETE /orderfrequency/{uuid}	Delete or purge resource by uuid

ordertype

Operation	Description
POST /ordertype/{uuid}	Edit with given uuid, only modifying properties in request
GET /ordertype/{uuid}	Fetch by uuid
DELETE /ordertype/{uuid}	Delete or purge resource by uuid
POST /ordertype	Create with properties in request
GET /ordertype	Fetch all non-retired

patient

Operation	Description
POST /patient/{uuid}	Edit with given uuid, only modifying properties in request
GET /patient/{uuid}	Fetch by uuid
DELETE /patient/{uuid}	Delete or purge resource by uuid
POST /patient/{parent-uuid}/identifier	Create identifier subresource with properties in request
GET /patient/{parent-uuid}/identifier	Fetch all non-retired identifier subresources
POST /patient/{parent-uuid}/identifier/{uuid}	Edit identifier subresource with given uuid, only modifying properties in request
GET /patient/{parent-uuid}/identifier/{uuid}	Fetch identifier subresources by uuid
DELETE /patient/{parent-uuid}/identifier/{uuid}	Delete or purge resource by uuid
POST /patient	Create with properties in request
GET /patient	Search for patient

patientidentifiertype

Operation	Description
POST /patientidentifiertype/{uuid}	Edit with given uuid, only modifying properties in request
GET /patientidentifiertype/{uuid}	Fetch by uuid
DELETE /patientidentifiertype/{uuid}	Delete or purge resource by uuid
POST /patientidentifiertype	Create with properties in request
GET /patientidentifiertype	Fetch all non-retired

patientprofile

Operation	Description
POST /patientprofile/{uuid}	Edit with given uuid, only modifying properties in request
POST /patientprofile	Create with properties in request

person

Operation	Description
POST /person/{parent-uuid}/attribute	Create attribute subresource with properties in request
GET /person/{parent-uuid}/attribute	Fetch all non-retired attribute subresources
POST /person/{parent-uuid}/name/{uuid}	Edit name subresource with given uuid, only modifying properties in request
GET /person/{parent-uuid}/name/{uuid}	Fetch name subresources by uuid
DELETE /person/{parent-uuid}/name/{uuid}	Delete or purge resource by uuid
POST /person	Create with properties in request
POST /person/{parent-uuid}/address/{uuid}	Edit address subresource with given uuid, only modifying properties in request
GET /person/{parent-uuid}/address/{uuid}	Fetch address subresources by uuid
DELETE /person/{parent-uuid}/address/{uuid}	Delete or purge resource by uuid
POST /person/{parent-uuid}/name	Create name subresource with properties in request
GET /person/{parent-uuid}/name	Fetch all non-retired name subresources
POST /person/{parent-uuid}/address	Create address subresource with properties in request
GET /person/{parent-uuid}/address	Fetch all non-retired address subresources
POST /person/{parent-uuid}/attribute/{uuid}	Edit attribute subresource with given uuid, only modifying properties in request
GET /person/{parent-uuid}/attribute/{uuid}	Fetch attribute subresources by uuid
DELETE /person/{parent-uuid}/attribute/{uuid}	Delete or purge resource by uuid
POST /person/{uuid}	Edit with given uuid, only modifying properties in request
GET /person/{uuid}	Fetch by uuid
DELETE /person/{uuid}	Delete or purge resource by uuid

personattributetype

Operation	Description
POST /personattributetype	Create with properties in request
GET /personattributetype	Fetch all non-retired
POST /personattributetype/{uuid}	Edit with given uuid, only modifying properties in request
GET /personattributetype/{uuid}	Fetch by uuid
DELETE /personattributetype/{uuid}	Delete or purge resource by uuid

personimage

Operation	Description
POST /personimage/{uuid}	Edit with given uuid, only modifying properties in request
GET /personimage/{uuid}	Fetch by uuid
DELETE /personimage/{uuid}	Delete or purge resource by uuid
POST /personimage	Create with properties in request

privilege

Operation	Description
POST /privilege	Create with properties in request
POST /privilege/{uuid}	Edit with given uuid, only modifying properties in request
DELETE /privilege/{uuid}	Delete or purge resource by uuid

appointmentscheduling_appointmenttype

Operation	Description
POST /appointmentscheduling/appointmenttype/{uuid}	Edit with given uuid, only modifying properties in request
GET /appointmentscheduling/appointmenttype/{uuid}	Fetch by uuid
DELETE /appointmentscheduling/appointmenttype/{uuid}	Delete or purge resource by uuid
POST /appointmentscheduling/appointmenttype	Create with properties in request
GET /appointmentscheduling/appointmenttype	Fetch all non-retired

problem

Operation	Description
POST /problem/{uuid}	Edit with given uuid, only modifying properties in request
GET /problem/{uuid}	Fetch by uuid
DELETE /problem/{uuid}	Delete or purge resource by uuid
POST /problem	Create with properties in request

program

Operation	Description
POST /program	Create with properties in request
GET /program	Fetch all non-retired
POST /program/{uuid}	Edit with given uuid, only modifying properties in request
GET /program/{uuid}	Fetch by uuid
DELETE /program/{uuid}	Delete or purge resource by uuid

programenrollment

Operation	Description
POST /programenrollment/{parent-uuid}/state	Create state subresource with properties in request
POST /programenrollment/{parent-uuid}/state/{uuid}	Edit state subresource with given uuid, only modifying properties in request
GET /programenrollment/{parent-uuid}/state/{uuid}	Fetch state subresources by uuid
DELETE /programenrollment/{parent-uuid}/state/{uuid}	Delete or purge resource by uuid
POST /programenrollment	Create with properties in request
POST /programenrollment/{uuid}	Edit with given uuid, only modifying properties in request
GET /programenrollment/{uuid}	Fetch by uuid
DELETE /programenrollment/{uuid}	Delete or purge resource by uuid

provider

Operation	Description
POST /provider/{parent-uuid}/attribute	Create attribute subresource with properties in request
GET /provider/{parent-uuid}/attribute	Fetch all non-retired attribute subresources
POST /provider/{uuid}	Edit with given uuid, only modifying properties in request
GET /provider/{uuid}	Fetch by uuid
DELETE /provider/{uuid}	Delete or purge resource by uuid
POST /provider/{parent-uuid}/attribute/{uuid}	Edit attribute subresource with given uuid, only modifying properties in request
GET /provider/{parent-uuid}/attribute/{uuid}	Fetch attribute subresources by uuid
DELETE /provider/{parent-uuid}/attribute/{uuid}	Delete or purge resource by uuid
POST /provider	Create with properties in request
GET /provider	Fetch all non-retired provider resources or perform search

providerattributetype

Operation	Description
POST /providerattributetype	Create with properties in request
GET /providerattributetype	Fetch all non-retired
POST /providerattributetype/{uuid}	Edit with given uuid, only modifying properties in request
GET /providerattributetype/{uuid}	Fetch by uuid
DELETE /providerattributetype/{uuid}	Delete or purge resource by uuid

relationship

Operation	Description
POST /relationship/{uuid}	Edit with given uuid, only modifying properties in request
GET /relationship/{uuid}	Fetch by uuid
DELETE /relationship/{uuid}	Delete or purge resource by uuid
POST /relationship	Create with properties in request
GET /relationship	Fetch all non-retired relationship resources or perform search

relationshiptype

Operation	Description
POST /relationshiptype	Create with properties in request
GET /relationshiptype	Fetch all non-retired
POST /relationshiptype/{uuid}	Edit with given uuid, only modifying properties in request
GET /relationshiptype/{uuid}	Fetch by uuid
DELETE /relationshiptype/{uuid}	Delete or purge resource by uuid

reportingrest_cohort

Operation	Description
GET /reportingrest/cohort/{uuid}	Fetch by uuid
DELETE /reportingrest/cohort/{uuid}	Delete or purge resource by uuid

reportingrest_cohortDefinition

Operation	Description
POST /reportingrest/cohortDefinition/{uuid}	Edit with given uuid, only modifying properties in request
GET /reportingrest/cohortDefinition/{uuid}	Fetch by uuid
DELETE /reportingrest/cohortDefinition/{uuid}	Delete or purge resource by uuid
POST /reportingrest/cohortDefinition	Create with properties in request
GET /reportingrest/cohortDefinition	Fetch all non-retired

reportingrest_dataSet

Operation	Description
GET /reportingrest/dataSet/{uuid}	Fetch by uuid
DELETE /reportingrest/dataSet/{uuid}	Delete or purge resource by uuid

appointmentscheduling_timeslot

Operation	Description
POST /appointmentscheduling/timeslot	Create with properties in request
GET /appointmentscheduling/timeslot	Fetch all non-retired
POST /appointmentscheduling/timeslot/{uuid}	Edit with given uuid, only modifying properties in request
GET /appointmentscheduling/timeslot/{uuid}	Fetch by uuid
DELETE /appointmentscheduling/timeslot/{uuid}	Delete or purge resource by uuid

reportingrest_dataSetDefinition

Operation	Description
POST /reportingrest/dataSetDefinition/{uuid}	Edit with given uuid, only modifying properties in request
GET /reportingrest/dataSetDefinition/{uuid}	Fetch by uuid
DELETE /reportingrest/dataSetDefinition/{uuid}	Delete or purge resource by uuid
POST /reportingrest/dataSetDefinition	Create with properties in request
GET /reportingrest/dataSetDefinition	Fetch all non-retired

reportingrest_reportdata

Operation	Description
GET /reportingrest/reportdata/{uuid}	Fetch by uuid
DELETE /reportingrest/reportdata/{uuid}	Delete or purge resource by uuid

reportingrest_reportDefinition

Operation	Description
POST /reportingrest/reportDefinition	Create with properties in request
GET /reportingrest/reportDefinition	Fetch all non-retired
POST /reportingrest/reportDefinition/{uuid}	Edit with given uuid, only modifying properties in request
GET /reportingrest/reportDefinition/{uuid}	Fetch by uuid
DELETE /reportingrest/reportDefinition/{uuid}	Delete or purge resource by uuid

reportingrest_reportRequest

Operation	Description
GET /reportingrest/reportRequest/{uuid}	Fetch by uuid
DELETE /reportingrest/reportRequest/{uuid}	Delete or purge resource by uuid

role

Operation	Description
POST /role/{uuid}	Edit with given uuid, only modifying properties in request
GET /role/{uuid}	Fetch by uuid
DELETE /role/{uuid}	Delete or purge resource by uuid
POST /role	Create with properties in request
GET /role	Fetch all non-retired

systemsetting

Operation	Description
POST /systemsetting/{uuid}	Edit with given uuid, only modifying properties in request
GET /systemsetting/{uuid}	Fetch by uuid
DELETE /systemsetting/{uuid}	Delete or purge resource by uuid
POST /systemsetting	Create with properties in request
GET /systemsetting	Fetch all non-retired

user

Operation	Description
POST /user	Create with properties in request
GET /user	Fetch all non-retired user resources or perform search
POST /user/{uuid}	Edit with given uuid, only modifying properties in request
GET /user/{uuid}	Fetch by uuid
DELETE /user/{uuid}	Delete or purge resource by uuid

visit

Operation	Description
POST /visit/{uuid}	Edit with given uuid, only modifying properties in request
GET /visit/{uuid}	Fetch by uuid
DELETE /visit/{uuid}	Delete or purge resource by uuid
POST /visit	Create with properties in request
GET /visit	Fetch all non-retired
POST /visit/{parent-uuid}/attribute	Create attribute subresource with properties in request
GET /visit/{parent-uuid}/attribute	Fetch all non-retired attribute subresources
POST /visit/{parent-uuid}/attribute/{uuid}	Edit attribute subresource with given uuid, only modifying properties in request
GET /visit/{parent-uuid}/attribute/{uuid}	Fetch attribute subresources by uuid
DELETE /visit/{parent-uuid}/attribute/{uuid}	Delete or purge resource by uuid

visitattributetype

Operation	Description
POST /visitattributetype/{uuid}	Edit with given uuid, only modifying properties in request
GET /visitattributetype/{uuid}	Fetch by uuid
DELETE /visitattributetype/{uuid}	Delete or purge resource by uuid
POST /visitattributetype	Create with properties in request
GET /visitattributetype	Fetch all non-retired

visittype

Operation	Description
POST /visittype/{uuid}	Edit with given uuid, only modifying properties in request
GET /visittype/{uuid}	Fetch by uuid
DELETE /visittype/{uuid}	Delete or purge resource by uuid
POST /visittype	Create with properties in request
GET /visittype	Fetch all non-retired

apptemplate

Operation	Description
GET /apptemplate	Fetch all non-retired
GET /apptemplate/{uuid}	Fetch by uuid

workflow

Operation	Description
GET /workflow/{parent-uuid}/state/{uuid}	Fetch state subresources by uuid
DELETE /workflow/{parent-uuid}/state/{uuid}	Delete or purge resource by uuid
GET /workflow/{parent-uuid}/state	Fetch all non-retired state subresources
POST /workflow	Create with properties in request
POST /workflow/{uuid}	Edit with given uuid, only modifying properties in request
GET /workflow/{uuid}	Fetch by uuid
DELETE /workflow/{uuid}	Delete or purge resource by uuid

caresetting

Operation	Description
GET /caresetting	Fetch all non-retired
GET /caresetting/{uuid}	Fetch by uuid
DELETE /caresetting/{uuid}	Delete or purge resource by uuid

cohort

Operation	Description
POST /cohort/{parent-uuid}/member/{uuid}	Edit member subresource with given uuid, only modifying properties in request
GET /cohort/{parent-uuid}/member/{uuid}	Fetch member subresources by uuid
DELETE /cohort/{parent-uuid}/member/{uuid}	Delete or purge resource by uuid
POST /cohort/{uuid}	Edit with given uuid, only modifying properties in request
GET /cohort/{uuid}	Fetch by uuid
DELETE /cohort/{uuid}	Delete or purge resource by uuid
POST /cohort	Create with properties in request
GET /cohort	Fetch all non-retired
POST /cohort/{parent-uuid}/member	Create member subresource with properties in request
GET /cohort/{parent-uuid}/member	Fetch all non-retired member subresources

Paths

Create with properties in request

POST /allergy

Resource: allergy

Uses default content-types: application/json

Resource to create

AllergyCreate

application/json application/xml

201 Created: allergy response

AllergyGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /allergy/{uuid}

Resource: allergy

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /allergy/{uuid}

Resource: allergy


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: allergy response

AllergyGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /allergy/{uuid}

Resource: allergy

Uses default content-types: application/json

Resource properties to update

AllergyUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: allergy response

AllergyGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /app

Resource: app


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: app response

AppGet
401 Unauthorized: User not logged in

Fetch by uuid

GET /app/{uuid}

Resource: app


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: app response

AppGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch all non-retired

GET /appointmentscheduling/appointmentallowingoverbook

Resource: appointmentscheduling_appointmentallowingoverbook


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: appointmentscheduling/appointmentallowingoverbook response

AppointmentschedulingAppointmentallowingoverbookGet
401 Unauthorized: User not logged in

Create with properties in request

POST /appointmentscheduling/appointmentallowingoverbook

Resource: appointmentscheduling_appointmentallowingoverbook

Uses default content-types: application/json

Resource to create

AppointmentschedulingAppointmentallowingoverbookCreate

application/json application/xml

201 Created: appointmentscheduling/appointmentallowingoverbook response

AppointmentschedulingAppointmentallowingoverbookGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /appointmentscheduling/appointmentallowingoverbook/{uuid}

Resource: appointmentscheduling_appointmentallowingoverbook

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /appointmentscheduling/appointmentallowingoverbook/{uuid}

Resource: appointmentscheduling_appointmentallowingoverbook


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: appointmentscheduling/appointmentallowingoverbook response

AppointmentschedulingAppointmentallowingoverbookGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /appointmentscheduling/appointmentallowingoverbook/{uuid}

Resource: appointmentscheduling_appointmentallowingoverbook

Uses default content-types: application/json

Resource properties to update

AppointmentschedulingAppointmentallowingoverbookUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: appointmentscheduling/appointmentallowingoverbook response

AppointmentschedulingAppointmentallowingoverbookGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /appointmentscheduling/appointmentblock

Resource: appointmentscheduling_appointmentblock


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: appointmentscheduling/appointmentblock response

AppointmentschedulingAppointmentblockGet
401 Unauthorized: User not logged in

Create with properties in request

POST /appointmentscheduling/appointmentblock

Resource: appointmentscheduling_appointmentblock

Uses default content-types: application/json

Resource to create

AppointmentschedulingAppointmentblockCreate

application/json application/xml

201 Created: appointmentscheduling/appointmentblock response

AppointmentschedulingAppointmentblockGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /appointmentscheduling/appointmentblock/{uuid}

Resource: appointmentscheduling_appointmentblock

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /appointmentscheduling/appointmentblock/{uuid}

Resource: appointmentscheduling_appointmentblock


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: appointmentscheduling/appointmentblock response

AppointmentschedulingAppointmentblockGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /appointmentscheduling/appointmentblock/{uuid}

Resource: appointmentscheduling_appointmentblock

Uses default content-types: application/json

Resource properties to update

AppointmentschedulingAppointmentblockUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: appointmentscheduling/appointmentblock response

AppointmentschedulingAppointmentblockGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /appointmentscheduling/appointmentrequest

Resource: appointmentscheduling_appointmentrequest


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: appointmentscheduling/appointmentrequest response

AppointmentschedulingAppointmentrequestGet
401 Unauthorized: User not logged in

Create with properties in request

POST /appointmentscheduling/appointmentrequest

Resource: appointmentscheduling_appointmentrequest

Uses default content-types: application/json

Resource to create

AppointmentschedulingAppointmentrequestCreate

application/json application/xml

201 Created: appointmentscheduling/appointmentrequest response

AppointmentschedulingAppointmentrequestGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /appointmentscheduling/appointmentrequest/{uuid}

Resource: appointmentscheduling_appointmentrequest

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /appointmentscheduling/appointmentrequest/{uuid}

Resource: appointmentscheduling_appointmentrequest


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: appointmentscheduling/appointmentrequest response

AppointmentschedulingAppointmentrequestGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /appointmentscheduling/appointmentrequest/{uuid}

Resource: appointmentscheduling_appointmentrequest

Uses default content-types: application/json

Resource properties to update

AppointmentschedulingAppointmentrequestUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: appointmentscheduling/appointmentrequest response

AppointmentschedulingAppointmentrequestGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /appointmentscheduling/appointmenttype

Resource: appointmentscheduling_appointmenttype


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: appointmentscheduling/appointmenttype response

AppointmentschedulingAppointmenttypeGet
401 Unauthorized: User not logged in

Create with properties in request

POST /appointmentscheduling/appointmenttype

Resource: appointmentscheduling_appointmenttype

Uses default content-types: application/json

Resource to create

AppointmentschedulingAppointmenttypeCreate

application/json application/xml

201 Created: appointmentscheduling/appointmenttype response

AppointmentschedulingAppointmenttypeGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /appointmentscheduling/appointmenttype/{uuid}

Resource: appointmentscheduling_appointmenttype

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /appointmentscheduling/appointmenttype/{uuid}

Resource: appointmentscheduling_appointmenttype


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: appointmentscheduling/appointmenttype response

AppointmentschedulingAppointmenttypeGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /appointmentscheduling/appointmenttype/{uuid}

Resource: appointmentscheduling_appointmenttype

Uses default content-types: application/json

Resource properties to update

AppointmentschedulingAppointmenttypeUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: appointmentscheduling/appointmenttype response

AppointmentschedulingAppointmenttypeGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /appointmentscheduling/timeslot

Resource: appointmentscheduling_timeslot


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: appointmentscheduling/timeslot response

AppointmentschedulingTimeslotGet
401 Unauthorized: User not logged in

Create with properties in request

POST /appointmentscheduling/timeslot

Resource: appointmentscheduling_timeslot

Uses default content-types: application/json

Resource to create

AppointmentschedulingTimeslotCreate

application/json application/xml

201 Created: appointmentscheduling/timeslot response

AppointmentschedulingTimeslotGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /appointmentscheduling/timeslot/{uuid}

Resource: appointmentscheduling_timeslot

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /appointmentscheduling/timeslot/{uuid}

Resource: appointmentscheduling_timeslot


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: appointmentscheduling/timeslot response

AppointmentschedulingTimeslotGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /appointmentscheduling/timeslot/{uuid}

Resource: appointmentscheduling_timeslot

Uses default content-types: application/json

Resource properties to update

AppointmentschedulingTimeslotUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: appointmentscheduling/timeslot response

AppointmentschedulingTimeslotGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /apptemplate

Resource: apptemplate


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: apptemplate response

ApptemplateGet
401 Unauthorized: User not logged in

Fetch by uuid

GET /apptemplate/{uuid}

Resource: apptemplate


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: apptemplate response

ApptemplateGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch all non-retired

GET /caresetting

Resource: caresetting


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: caresetting response

CaresettingGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /caresetting/{uuid}

Resource: caresetting

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /caresetting/{uuid}

Resource: caresetting


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: caresetting response

CaresettingGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch all non-retired

GET /cohort

Resource: cohort


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: cohort response

CohortGet
401 Unauthorized: User not logged in

Create with properties in request

POST /cohort

Resource: cohort

Uses default content-types: application/json

Resource to create

CohortCreate

application/json application/xml

201 Created: cohort response

CohortGet
401 Unauthorized: User not logged in

Fetch all non-retired member subresources

GET /cohort/{parent-uuid}/member

Resource: cohort


parent-uuid	parent resource uuid	path	string
v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: member response

CohortMemberGet
401 Unauthorized: User not logged in

Create member subresource with properties in request

POST /cohort/{parent-uuid}/member

Resource: cohort

Uses default content-types: application/json

Resource to create

CohortMemberCreate


parent-uuid	parent resource uuid	path	string

application/json application/xml

201 Created: member response

CohortMemberGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /cohort/{parent-uuid}/member/{uuid}

Resource: cohort

The resource will be voided/retired unless purge = 'true'


parent-uuid	parent resource uuid	path	string
uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch member subresources by uuid

GET /cohort/{parent-uuid}/member/{uuid}

Resource: cohort


parent-uuid	parent resource uuid	path	string
uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: member response

CohortMemberGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit member subresource with given uuid, only modifying properties in request

POST /cohort/{parent-uuid}/member/{uuid}

Resource: cohort

Uses default content-types: application/json

Resource properties to update

CohortMemberUpdate


parent-uuid	parent resource uuid	path	string
uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: member response

CohortMemberGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /cohort/{uuid}

Resource: cohort

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /cohort/{uuid}

Resource: cohort


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: cohort response

CohortGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /cohort/{uuid}

Resource: cohort

Uses default content-types: application/json

Resource properties to update

CohortUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: cohort response

CohortGet
401 Unauthorized: User not logged in

Fetch all non-retired concept resources or perform search

GET /concept

Resource: concept

All search parameters are optional


v	The representation to return (ref, default, full or custom)	query	string
source		query	string
term		query	string
q	The search query	query	string
name		query	string
code	Must be used with source	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: concept response

ConceptGet
401 Unauthorized: User not logged in

Create with properties in request

POST /concept

Resource: concept

Uses default content-types: application/json

Resource to create

ConceptCreate

application/json application/xml

201 Created: concept response

ConceptGet
401 Unauthorized: User not logged in

Fetch all non-retired description subresources

GET /concept/{parent-uuid}/description

Resource: concept


parent-uuid	parent resource uuid	path	string
v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: description response

ConceptDescriptionGet
401 Unauthorized: User not logged in

Create description subresource with properties in request

POST /concept/{parent-uuid}/description

Resource: concept

Uses default content-types: application/json

Resource to create

ConceptDescriptionCreate


parent-uuid	parent resource uuid	path	string

application/json application/xml

201 Created: description response

ConceptDescriptionGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /concept/{parent-uuid}/description/{uuid}

Resource: concept

The resource will be voided/retired unless purge = 'true'


parent-uuid	parent resource uuid	path	string
uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch description subresources by uuid

GET /concept/{parent-uuid}/description/{uuid}

Resource: concept


parent-uuid	parent resource uuid	path	string
uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: description response

ConceptDescriptionGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit description subresource with given uuid, only modifying properties in request

POST /concept/{parent-uuid}/description/{uuid}

Resource: concept

Uses default content-types: application/json

Resource properties to update

ConceptDescriptionUpdate


parent-uuid	parent resource uuid	path	string
uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: description response

ConceptDescriptionGet
401 Unauthorized: User not logged in

Fetch all non-retired mapping subresources

GET /concept/{parent-uuid}/mapping

Resource: concept


parent-uuid	parent resource uuid	path	string
v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: mapping response

ConceptMappingGet
401 Unauthorized: User not logged in

Create mapping subresource with properties in request

POST /concept/{parent-uuid}/mapping

Resource: concept

Uses default content-types: application/json

Resource to create

ConceptMappingCreate


parent-uuid	parent resource uuid	path	string

application/json application/xml

201 Created: mapping response

ConceptMappingGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /concept/{parent-uuid}/mapping/{uuid}

Resource: concept

The resource will be voided/retired unless purge = 'true'


parent-uuid	parent resource uuid	path	string
uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch mapping subresources by uuid

GET /concept/{parent-uuid}/mapping/{uuid}

Resource: concept


parent-uuid	parent resource uuid	path	string
uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: mapping response

ConceptMappingGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit mapping subresource with given uuid, only modifying properties in request

POST /concept/{parent-uuid}/mapping/{uuid}

Resource: concept

Uses default content-types: application/json

Resource properties to update

ConceptMappingUpdate


parent-uuid	parent resource uuid	path	string
uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: mapping response

ConceptMappingGet
401 Unauthorized: User not logged in

Fetch all non-retired name subresources

GET /concept/{parent-uuid}/name

Resource: concept


parent-uuid	parent resource uuid	path	string
v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: name response

ConceptNameGet
401 Unauthorized: User not logged in

Create name subresource with properties in request

POST /concept/{parent-uuid}/name

Resource: concept

Uses default content-types: application/json

Resource to create

ConceptNameCreate


parent-uuid	parent resource uuid	path	string

application/json application/xml

201 Created: name response

ConceptNameGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /concept/{parent-uuid}/name/{uuid}

Resource: concept

The resource will be voided/retired unless purge = 'true'


parent-uuid	parent resource uuid	path	string
uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch name subresources by uuid

GET /concept/{parent-uuid}/name/{uuid}

Resource: concept


parent-uuid	parent resource uuid	path	string
uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: name response

ConceptNameGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit name subresource with given uuid, only modifying properties in request

POST /concept/{parent-uuid}/name/{uuid}

Resource: concept

Uses default content-types: application/json

Resource properties to update

ConceptNameUpdate


parent-uuid	parent resource uuid	path	string
uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: name response

ConceptNameGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /concept/{uuid}

Resource: concept

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /concept/{uuid}

Resource: concept


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: concept response

ConceptGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /concept/{uuid}

Resource: concept

Uses default content-types: application/json

Resource properties to update

ConceptUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: concept response

ConceptGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /conceptclass

Resource: conceptclass


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: conceptclass response

ConceptclassGet
401 Unauthorized: User not logged in

Create with properties in request

POST /conceptclass

Resource: conceptclass

Uses default content-types: application/json

Resource to create

ConceptclassCreate

application/json application/xml

201 Created: conceptclass response

ConceptclassGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /conceptclass/{uuid}

Resource: conceptclass

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /conceptclass/{uuid}

Resource: conceptclass


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: conceptclass response

ConceptclassGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /conceptclass/{uuid}

Resource: conceptclass

Uses default content-types: application/json

Resource properties to update

ConceptclassUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: conceptclass response

ConceptclassGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /conceptdatatype

Resource: conceptdatatype


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: conceptdatatype response

ConceptdatatypeGet
401 Unauthorized: User not logged in

Create with properties in request

POST /conceptdatatype

Resource: conceptdatatype

Uses default content-types: application/json

Resource to create

ConceptdatatypeCreate

application/json application/xml

201 Created: conceptdatatype response

ConceptdatatypeGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /conceptdatatype/{uuid}

Resource: conceptdatatype

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /conceptdatatype/{uuid}

Resource: conceptdatatype


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: conceptdatatype response

ConceptdatatypeGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch all non-retired

GET /conceptmaptype

Resource: conceptmaptype


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: conceptmaptype response

ConceptmaptypeGet
401 Unauthorized: User not logged in

Create with properties in request

POST /conceptmaptype

Resource: conceptmaptype

Uses default content-types: application/json

Resource to create

ConceptmaptypeCreate

application/json application/xml

201 Created: conceptmaptype response

ConceptmaptypeGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /conceptmaptype/{uuid}

Resource: conceptmaptype

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /conceptmaptype/{uuid}

Resource: conceptmaptype


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: conceptmaptype response

ConceptmaptypeGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /conceptmaptype/{uuid}

Resource: conceptmaptype

Uses default content-types: application/json

Resource properties to update

ConceptmaptypeUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: conceptmaptype response

ConceptmaptypeGet
401 Unauthorized: User not logged in

Fetch all non-retired conceptreferenceterm resources or perform search

GET /conceptreferenceterm

Resource: conceptreferenceterm

All search parameters are optional


v	The representation to return (ref, default, full or custom)	query	string
source		query	string
q	The search query	query	string
name	Must be used with source	query	string
code	Must be used with source	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: conceptreferenceterm response

ConceptreferencetermGet
401 Unauthorized: User not logged in

Create with properties in request

POST /conceptreferenceterm

Resource: conceptreferenceterm

Uses default content-types: application/json

Resource to create

ConceptreferencetermCreate

application/json application/xml

201 Created: conceptreferenceterm response

ConceptreferencetermGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /conceptreferenceterm/{uuid}

Resource: conceptreferenceterm

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /conceptreferenceterm/{uuid}

Resource: conceptreferenceterm


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: conceptreferenceterm response

ConceptreferencetermGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /conceptreferenceterm/{uuid}

Resource: conceptreferenceterm

Uses default content-types: application/json

Resource properties to update

ConceptreferencetermUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: conceptreferenceterm response

ConceptreferencetermGet
401 Unauthorized: User not logged in

Search for conceptreferencetermmap

GET /conceptreferencetermmap

Resource: conceptreferencetermmap

At least one search parameter must be specified


to		query	string
v	The representation to return (ref, default, full or custom)	query	string
maps		query	string
q	The search query	query	string
termA		query	string
termB		query	string
maptype	Must be used with termB	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: conceptreferencetermmap response

Create with properties in request

POST /conceptreferencetermmap

Resource: conceptreferencetermmap

Uses default content-types: application/json

Resource to create

ConceptreferencetermmapCreate

application/json application/xml

201 Created: conceptreferencetermmap response

ConceptreferencetermmapGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /conceptreferencetermmap/{uuid}

Resource: conceptreferencetermmap

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /conceptreferencetermmap/{uuid}

Resource: conceptreferencetermmap


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: conceptreferencetermmap response

ConceptreferencetermmapGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /conceptreferencetermmap/{uuid}

Resource: conceptreferencetermmap

Uses default content-types: application/json

Resource properties to update

ConceptreferencetermmapUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: conceptreferencetermmap response

ConceptreferencetermmapGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /conceptsource

Resource: conceptsource


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: conceptsource response

ConceptsourceGet
401 Unauthorized: User not logged in

Create with properties in request

POST /conceptsource

Resource: conceptsource

Uses default content-types: application/json

Resource to create

ConceptsourceCreate

application/json application/xml

201 Created: conceptsource response

ConceptsourceGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /conceptsource/{uuid}

Resource: conceptsource

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /conceptsource/{uuid}

Resource: conceptsource


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: conceptsource response

ConceptsourceGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /conceptsource/{uuid}

Resource: conceptsource

Uses default content-types: application/json

Resource properties to update

ConceptsourceUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: conceptsource response

ConceptsourceGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /conceptstopword

Resource: conceptstopword


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: conceptstopword response

ConceptstopwordGet
401 Unauthorized: User not logged in

Create with properties in request

POST /conceptstopword

Resource: conceptstopword

Uses default content-types: application/json

Resource to create

ConceptstopwordCreate

application/json application/xml

201 Created: conceptstopword response

ConceptstopwordGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /conceptstopword/{uuid}

Resource: conceptstopword

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /conceptstopword/{uuid}

Resource: conceptstopword


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: conceptstopword response

ConceptstopwordGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /conceptstopword/{uuid}

Resource: conceptstopword

Uses default content-types: application/json

Resource properties to update

ConceptstopwordUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: conceptstopword response

ConceptstopwordGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /customdatatype

Resource: customdatatype


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: customdatatype response

CustomdatatypeGet
401 Unauthorized: User not logged in

Fetch all non-retired handlers subresources

GET /customdatatype/{parent-uuid}/handlers

Resource: customdatatype


parent-uuid	parent resource uuid	path	string
v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: handlers response

CustomdatatypeHandlersGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /customdatatype/{uuid}

Resource: customdatatype

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /customdatatype/{uuid}

Resource: customdatatype


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: customdatatype response

CustomdatatypeGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Delete or purge resource by uuid

DELETE /dhisconnector/dhiscategorycombos/{uuid}

Resource: dhisconnector_dhiscategorycombos

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /dhisconnector/dhiscategorycombos/{uuid}

Resource: dhisconnector_dhiscategorycombos


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: dhisconnector/dhiscategorycombos response

DhisconnectorDhiscategorycombosGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Delete or purge resource by uuid

DELETE /dhisconnector/dhisdataelements/{uuid}

Resource: dhisconnector_dhisdataelements

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /dhisconnector/dhisdataelements/{uuid}

Resource: dhisconnector_dhisdataelements


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: dhisconnector/dhisdataelements response

DhisconnectorDhisdataelementsGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch all non-retired

GET /dhisconnector/dhisdatasets

Resource: dhisconnector_dhisdatasets


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: dhisconnector/dhisdatasets response

DhisconnectorDhisdatasetsGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /dhisconnector/dhisdatasets/{uuid}

Resource: dhisconnector_dhisdatasets

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /dhisconnector/dhisdatasets/{uuid}

Resource: dhisconnector_dhisdatasets


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: dhisconnector/dhisdatasets response

DhisconnectorDhisdatasetsGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Create with properties in request

POST /dhisconnector/dhisdatavaluesets

Resource: dhisconnector_dhisdatavaluesets

Uses default content-types: application/json

Resource to create

DhisconnectorDhisdatavaluesetsCreate

application/json application/xml

201 Created: dhisconnector/dhisdatavaluesets response

DhisconnectorDhisdatavaluesetsGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /dhisconnector/dhisdatavaluesets/{uuid}

Resource: dhisconnector_dhisdatavaluesets

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /dhisconnector/dhisdatavaluesets/{uuid}

Resource: dhisconnector_dhisdatavaluesets


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: dhisconnector/dhisdatavaluesets response

DhisconnectorDhisdatavaluesetsGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /dhisconnector/dhisdatavaluesets/{uuid}

Resource: dhisconnector_dhisdatavaluesets

Uses default content-types: application/json

Resource properties to update

DhisconnectorDhisdatavaluesetsUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: dhisconnector/dhisdatavaluesets response

DhisconnectorDhisdatavaluesetsGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /dhisconnector/mappings

Resource: dhisconnector_mappings


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: dhisconnector/mappings response

DhisconnectorMappingsGet
401 Unauthorized: User not logged in

Create with properties in request

POST /dhisconnector/mappings

Resource: dhisconnector_mappings

Uses default content-types: application/json

Resource to create

DhisconnectorMappingsCreate

application/json application/xml

201 Created: dhisconnector/mappings response

DhisconnectorMappingsGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /dhisconnector/mappings/{uuid}

Resource: dhisconnector_mappings

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /dhisconnector/mappings/{uuid}

Resource: dhisconnector_mappings


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: dhisconnector/mappings response

DhisconnectorMappingsGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /dhisconnector/mappings/{uuid}

Resource: dhisconnector_mappings

Uses default content-types: application/json

Resource properties to update

DhisconnectorMappingsUpdate


uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: dhisconnector/mappings response

DhisconnectorMappingsGet
401 Unauthorized: User not logged in

Fetch all non-retired

GET /dhisconnector/orgunits

Resource: dhisconnector_orgunits


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: dhisconnector/orgunits response

DhisconnectorOrgunitsGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /dhisconnector/orgunits/{uuid}

Resource: dhisconnector_orgunits

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /dhisconnector/orgunits/{uuid}

Resource: dhisconnector_orgunits


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: dhisconnector/orgunits response

DhisconnectorOrgunitsGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch all non-retired

GET /dhisconnector/periodindicatorreports

Resource: dhisconnector_periodindicatorreports


v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: dhisconnector/periodindicatorreports response

DhisconnectorPeriodindicatorreportsGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /dhisconnector/periodindicatorreports/{uuid}

Resource: dhisconnector_periodindicatorreports

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /dhisconnector/periodindicatorreports/{uuid}

Resource: dhisconnector_periodindicatorreports


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: dhisconnector/periodindicatorreports response

DhisconnectorPeriodindicatorreportsGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch all non-retired drug resources or perform search

GET /drug

Resource: drug

All search parameters are optional


v	The representation to return (ref, default, full or custom)	query	string
source		query	string
preferredMapTypes	Must be used with source	query	string
q	The search query	query	string
locale	Must be used with q	query	string
code	Must be used with source	query	string
exactLocale	Must be used with q	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: drug response

DrugGet
401 Unauthorized: User not logged in

Create with properties in request

POST /drug

Resource: drug

Uses default content-types: application/json

Resource to create

DrugCreate

application/json application/xml

201 Created: drug response

DrugGet
401 Unauthorized: User not logged in

Fetch all non-retired ingredient subresources

GET /drug/{parent-uuid}/ingredient

Resource: drug


parent-uuid	parent resource uuid	path	string
v	The representation to return (ref, default, full or custom)	query	string
q	The search query	query	string
limit	The number of results to return	query	integer
startIndex	The offset at which to start	query	integer

application/json application/xml

200 OK: ingredient response

DrugIngredientGet
401 Unauthorized: User not logged in

Create ingredient subresource with properties in request

POST /drug/{parent-uuid}/ingredient

Resource: drug

Uses default content-types: application/json

Resource to create

DrugIngredientCreate


parent-uuid	parent resource uuid	path	string

application/json application/xml

201 Created: ingredient response

DrugIngredientGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /drug/{parent-uuid}/ingredient/{uuid}

Resource: drug

The resource will be voided/retired unless purge = 'true'


parent-uuid	parent resource uuid	path	string
uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch ingredient subresources by uuid

GET /drug/{parent-uuid}/ingredient/{uuid}

Resource: drug


parent-uuid	parent resource uuid	path	string
uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: ingredient response

DrugIngredientGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit ingredient subresource with given uuid, only modifying properties in request

POST /drug/{parent-uuid}/ingredient/{uuid}

Resource: drug

Uses default content-types: application/json

Resource properties to update

DrugIngredientUpdate


parent-uuid	parent resource uuid	path	string
uuid	uuid of resource to update	path	string

application/json application/xml

201 Created: ingredient response

DrugIngredientGet
401 Unauthorized: User not logged in

Delete or purge resource by uuid

DELETE /drug/{uuid}

Resource: drug

The resource will be voided/retired unless purge = 'true'


uuid	uuid to delete	path	string
purge		query	boolean

application/json application/xml

204 No Content: Delete successful
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Fetch by uuid

GET /drug/{uuid}

Resource: drug


uuid	uuid to filter by	path	string
v	The representation to return (ref, default, full or custom)	query	string

application/json application/xml

200 OK: drug response

DrugGet
401 Unauthorized: User not logged in
404 Not Found: Resource with given uuid doesn't exist

Edit with given uuid, only modifying properties in request

POST /drug/{uuid}

Resource: drug

Uses default content-types: application/json

Resource properties to update

DrugUpdate