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
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
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
allergy response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
allergy response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
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
- 401 Unauthorized
-
User not logged in
POST /appointmentscheduling/appointmentallowingoverbook
Resource: appointmentscheduling_appointmentallowingoverbookUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
appointmentscheduling/appointmentallowingoverbook response
- 401 Unauthorized
-
User not logged in
DELETE /appointmentscheduling/appointmentallowingoverbook/{uuid}
Resource: appointmentscheduling_appointmentallowingoverbookThe 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
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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /appointmentscheduling/appointmentallowingoverbook/{uuid}
Resource: appointmentscheduling_appointmentallowingoverbookUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
appointmentscheduling/appointmentallowingoverbook response
- 401 Unauthorized
-
User not logged in
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
- 401 Unauthorized
-
User not logged in
POST /appointmentscheduling/appointmentblock
Resource: appointmentscheduling_appointmentblockUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
appointmentscheduling/appointmentblock response
- 401 Unauthorized
-
User not logged in
DELETE /appointmentscheduling/appointmentblock/{uuid}
Resource: appointmentscheduling_appointmentblockThe 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
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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /appointmentscheduling/appointmentblock/{uuid}
Resource: appointmentscheduling_appointmentblockUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
appointmentscheduling/appointmentblock response
- 401 Unauthorized
-
User not logged in
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
- 401 Unauthorized
-
User not logged in
POST /appointmentscheduling/appointmentrequest
Resource: appointmentscheduling_appointmentrequestUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
appointmentscheduling/appointmentrequest response
- 401 Unauthorized
-
User not logged in
DELETE /appointmentscheduling/appointmentrequest/{uuid}
Resource: appointmentscheduling_appointmentrequestThe 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
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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /appointmentscheduling/appointmentrequest/{uuid}
Resource: appointmentscheduling_appointmentrequestUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
appointmentscheduling/appointmentrequest response
- 401 Unauthorized
-
User not logged in
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
- 401 Unauthorized
-
User not logged in
POST /appointmentscheduling/appointmenttype
Resource: appointmentscheduling_appointmenttypeUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
appointmentscheduling/appointmenttype response
- 401 Unauthorized
-
User not logged in
DELETE /appointmentscheduling/appointmenttype/{uuid}
Resource: appointmentscheduling_appointmenttypeThe 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
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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /appointmentscheduling/appointmenttype/{uuid}
Resource: appointmentscheduling_appointmenttypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
appointmentscheduling/appointmenttype response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
POST /appointmentscheduling/timeslot
Resource: appointmentscheduling_timeslotUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
appointmentscheduling/timeslot response
- 401 Unauthorized
-
User not logged in
DELETE /appointmentscheduling/timeslot/{uuid}
Resource: appointmentscheduling_timeslotThe 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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /appointmentscheduling/timeslot/{uuid}
Resource: appointmentscheduling_timeslotUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
appointmentscheduling/timeslot response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
cohort response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
POST /cohort/{parent-uuid}/member
Resource: cohortUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
member response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /cohort/{parent-uuid}/member/{uuid}
Resource: cohortUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
member response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
cohort response
- 401 Unauthorized
-
User not logged in
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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
concept response
- 401 Unauthorized
-
User not logged in
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
- 401 Unauthorized
-
User not logged in
POST /concept/{parent-uuid}/description
Resource: conceptUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
description response
- 401 Unauthorized
-
User not logged in
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
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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /concept/{parent-uuid}/description/{uuid}
Resource: conceptUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
description response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
POST /concept/{parent-uuid}/mapping
Resource: conceptUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
mapping response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /concept/{parent-uuid}/mapping/{uuid}
Resource: conceptUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
mapping response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
POST /concept/{parent-uuid}/name
Resource: conceptUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
name response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /concept/{parent-uuid}/name/{uuid}
Resource: conceptUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
name response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
concept response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
conceptclass response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /conceptclass/{uuid}
Resource: conceptclassUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
conceptclass response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
conceptdatatype response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
conceptmaptype response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /conceptmaptype/{uuid}
Resource: conceptmaptypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
conceptmaptype response
- 401 Unauthorized
-
User not logged in
GET /conceptreferenceterm
Resource: conceptreferencetermAll 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
conceptreferenceterm response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /conceptreferenceterm/{uuid}
Resource: conceptreferencetermUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
conceptreferenceterm response
- 401 Unauthorized
-
User not logged in
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
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
conceptreferencetermmap response
- 401 Unauthorized
-
User not logged in
DELETE /conceptreferencetermmap/{uuid}
Resource: conceptreferencetermmapThe 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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /conceptreferencetermmap/{uuid}
Resource: conceptreferencetermmapUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
conceptreferencetermmap response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
conceptsource response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /conceptsource/{uuid}
Resource: conceptsourceUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
conceptsource response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
conceptstopword response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /conceptstopword/{uuid}
Resource: conceptstopwordUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
conceptstopword response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
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
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
DELETE /dhisconnector/dhiscategorycombos/{uuid}
Resource: dhisconnector_dhiscategorycombosThe 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
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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
DELETE /dhisconnector/dhisdataelements/{uuid}
Resource: dhisconnector_dhisdataelementsThe 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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
- 401 Unauthorized
-
User not logged in
DELETE /dhisconnector/dhisdatasets/{uuid}
Resource: dhisconnector_dhisdatasetsThe 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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /dhisconnector/dhisdatavaluesets
Resource: dhisconnector_dhisdatavaluesetsUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
dhisconnector/dhisdatavaluesets response
- 401 Unauthorized
-
User not logged in
DELETE /dhisconnector/dhisdatavaluesets/{uuid}
Resource: dhisconnector_dhisdatavaluesetsThe 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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /dhisconnector/dhisdatavaluesets/{uuid}
Resource: dhisconnector_dhisdatavaluesetsUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
dhisconnector/dhisdatavaluesets response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
dhisconnector/mappings response
- 401 Unauthorized
-
User not logged in
DELETE /dhisconnector/mappings/{uuid}
Resource: dhisconnector_mappingsThe 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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /dhisconnector/mappings/{uuid}
Resource: dhisconnector_mappingsUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
dhisconnector/mappings response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
DELETE /dhisconnector/orgunits/{uuid}
Resource: dhisconnector_orgunitsThe 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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
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
- 401 Unauthorized
-
User not logged in
DELETE /dhisconnector/periodindicatorreports/{uuid}
Resource: dhisconnector_periodindicatorreportsThe 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
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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
drug response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
POST /drug/{parent-uuid}/ingredient
Resource: drugUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
ingredient response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /drug/{parent-uuid}/ingredient/{uuid}
Resource: drugUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
ingredient response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
drug response
- 401 Unauthorized
-
User not logged in
At least one search parameter must be specified
| v | The representation to return (ref, default, full or custom) |
query | string | |
| patient | query | string | ||
| order | Must be used with patient or encounterType |
query | string | |
| q | The search query |
query | string | |
| fromdate | Must be used with patient or encounterType |
query | string | |
| todate | Must be used with patient or encounterType |
query | string | |
| encounterType | 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
-
encounter response
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
encounter response
- 401 Unauthorized
-
User not logged in
GET /encounter/{parent-uuid}/encounterprovider
Resource: encounter| 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
-
encounterprovider response
- 401 Unauthorized
-
User not logged in
POST /encounter/{parent-uuid}/encounterprovider
Resource: encounterUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
encounterprovider response
- 401 Unauthorized
-
User not logged in
DELETE /encounter/{parent-uuid}/encounterprovider/{uuid}
Resource: encounterThe 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
GET /encounter/{parent-uuid}/encounterprovider/{uuid}
Resource: encounter| 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
-
encounterprovider response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /encounter/{parent-uuid}/encounterprovider/{uuid}
Resource: encounterUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
encounterprovider response
- 401 Unauthorized
-
User not logged in
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
| 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
-
encounter response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /encounter/{uuid}
Resource: encounterUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
encounter response
- 401 Unauthorized
-
User not logged in
| 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
-
encounterrole response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
encounterrole response
- 401 Unauthorized
-
User not logged in
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
| 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
-
encounterrole response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /encounterrole/{uuid}
Resource: encounterroleUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
encounterrole response
- 401 Unauthorized
-
User not logged in
| 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
-
encountertype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
encountertype response
- 401 Unauthorized
-
User not logged in
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
| 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
-
encountertype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /encountertype/{uuid}
Resource: encountertypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
encountertype response
- 401 Unauthorized
-
User not logged in
| 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
-
extension response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
-
field response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
field response
- 401 Unauthorized
-
User not logged in
| 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
-
answer response
- 401 Unauthorized
-
User not logged in
POST /field/{parent-uuid}/answer
Resource: fieldUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
answer response
- 401 Unauthorized
-
User not logged in
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
| 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
-
answer response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /field/{parent-uuid}/answer/{uuid}
Resource: fieldUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
answer response
- 401 Unauthorized
-
User not logged in
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
| 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
-
field response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
field response
- 401 Unauthorized
-
User not logged in
| 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
-
fieldtype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
fieldtype response
- 401 Unauthorized
-
User not logged in
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
| 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
-
fieldtype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /fieldtype/{uuid}
Resource: fieldtypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
fieldtype response
- 401 Unauthorized
-
User not logged in
| 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
-
form response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
form response
- 401 Unauthorized
-
User not logged in
| 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
-
formfield response
- 401 Unauthorized
-
User not logged in
POST /form/{parent-uuid}/formfield
Resource: formUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
formfield response
- 401 Unauthorized
-
User not logged in
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
| 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
-
formfield response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /form/{parent-uuid}/formfield/{uuid}
Resource: formUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
formfield response
- 401 Unauthorized
-
User not logged in
POST /form/{parent-uuid}/resource
Resource: formUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
resource response
- 401 Unauthorized
-
User not logged in
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
POST /form/{parent-uuid}/resource/{uuid}
Resource: formUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
resource response
- 401 Unauthorized
-
User not logged in
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
| 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
-
form response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
form response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
hl7 response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
hl7source response
- 401 Unauthorized
-
User not logged in
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
POST /hl7source/{uuid}
Resource: hl7sourceUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
hl7source response
- 401 Unauthorized
-
User not logged in
All search parameters are optional
| v | The representation to return (ref, default, full or custom) |
query | string | |
| q | The search query |
query | string | |
| tag | 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
-
location response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
location response
- 401 Unauthorized
-
User not logged in
GET /location/{parent-uuid}/attribute
Resource: location| 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
-
attribute response
- 401 Unauthorized
-
User not logged in
POST /location/{parent-uuid}/attribute
Resource: locationUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
attribute response
- 401 Unauthorized
-
User not logged in
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
GET /location/{parent-uuid}/attribute/{uuid}
Resource: location| 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
-
attribute response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /location/{parent-uuid}/attribute/{uuid}
Resource: locationUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
attribute response
- 401 Unauthorized
-
User not logged in
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
| 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
-
location response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
location response
- 401 Unauthorized
-
User not logged in
| 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
-
locationattributetype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
locationattributetype response
- 401 Unauthorized
-
User not logged in
DELETE /locationattributetype/{uuid}
Resource: locationattributetypeThe 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
| 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
-
locationattributetype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /locationattributetype/{uuid}
Resource: locationattributetypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
locationattributetype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
locationtag response
- 401 Unauthorized
-
User not logged in
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
POST /locationtag/{uuid}
Resource: locationtagUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
locationtag response
- 401 Unauthorized
-
User not logged in
At least one search parameter must be specified
| v | The representation to return (ref, default, full or custom) |
query | string | |
| concept | query | string | ||
| patient | 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
-
obs response
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
obs response
- 401 Unauthorized
-
User not logged in
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
| 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
-
obs response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
obs response
- 401 Unauthorized
-
User not logged in
Certain properties may be required depending on type
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
order response
- 401 Unauthorized
-
User not logged in
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
| 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
-
order response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
-
orderfrequency response
- 401 Unauthorized
-
User not logged in
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
| 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
-
orderfrequency response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /orderfrequency/{uuid}
Resource: orderfrequencyUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
orderfrequency response
- 401 Unauthorized
-
User not logged in
| 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
-
ordertype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
ordertype response
- 401 Unauthorized
-
User not logged in
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
| 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
-
ordertype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /ordertype/{uuid}
Resource: ordertypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
ordertype response
- 401 Unauthorized
-
User not logged in
At least one search parameter must be specified
| v | The representation to return (ref, default, full or custom) |
query | string | |
| q | The search query |
query | string | |
| lastviewed | query | string | ||
| identifier | 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
-
patient response
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
patient response
- 401 Unauthorized
-
User not logged in
GET /patient/{parent-uuid}/identifier
Resource: patient| 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
-
identifier response
- 401 Unauthorized
-
User not logged in
POST /patient/{parent-uuid}/identifier
Resource: patientUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
identifier response
- 401 Unauthorized
-
User not logged in
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
GET /patient/{parent-uuid}/identifier/{uuid}
Resource: patient| 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
-
identifier response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /patient/{parent-uuid}/identifier/{uuid}
Resource: patientUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
identifier response
- 401 Unauthorized
-
User not logged in
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
| 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
-
patient response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
patient response
- 401 Unauthorized
-
User not logged in
| 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
-
patientidentifiertype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
patientidentifiertype response
- 401 Unauthorized
-
User not logged in
DELETE /patientidentifiertype/{uuid}
Resource: patientidentifiertypeThe 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
| 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
-
patientidentifiertype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /patientidentifiertype/{uuid}
Resource: patientidentifiertypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
patientidentifiertype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
patientprofile response
- 401 Unauthorized
-
User not logged in
POST /patientprofile/{uuid}
Resource: patientprofileUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
patientprofile response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
person response
- 401 Unauthorized
-
User not logged in
| 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
-
address response
- 401 Unauthorized
-
User not logged in
POST /person/{parent-uuid}/address
Resource: personUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
address response
- 401 Unauthorized
-
User not logged in
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
| 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
-
address response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /person/{parent-uuid}/address/{uuid}
Resource: personUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
address response
- 401 Unauthorized
-
User not logged in
| 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
-
attribute response
- 401 Unauthorized
-
User not logged in
POST /person/{parent-uuid}/attribute
Resource: personUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
attribute response
- 401 Unauthorized
-
User not logged in
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
| 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
-
attribute response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /person/{parent-uuid}/attribute/{uuid}
Resource: personUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
attribute response
- 401 Unauthorized
-
User not logged in
| 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
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
name response
- 401 Unauthorized
-
User not logged in
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
| 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
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /person/{parent-uuid}/name/{uuid}
Resource: personUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
name response
- 401 Unauthorized
-
User not logged in
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
| 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
-
person response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
person response
- 401 Unauthorized
-
User not logged in
| 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
-
personattributetype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
personattributetype response
- 401 Unauthorized
-
User not logged in
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
| 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
-
personattributetype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /personattributetype/{uuid}
Resource: personattributetypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
personattributetype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
personimage response
- 401 Unauthorized
-
User not logged in
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
| 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
-
personimage response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /personimage/{uuid}
Resource: personimageUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
personimage response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
privilege response
- 401 Unauthorized
-
User not logged in
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
POST /privilege/{uuid}
Resource: privilegeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
privilege response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
problem response
- 401 Unauthorized
-
User not logged in
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
| 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
-
problem response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
problem response
- 401 Unauthorized
-
User not logged in
| 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
-
program response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
program response
- 401 Unauthorized
-
User not logged in
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
| 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
-
program response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
program response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
programenrollment response
- 401 Unauthorized
-
User not logged in
POST /programenrollment/{parent-uuid}/state
Resource: programenrollmentUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
state response
- 401 Unauthorized
-
User not logged in
DELETE /programenrollment/{parent-uuid}/state/{uuid}
Resource: programenrollmentThe 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
GET /programenrollment/{parent-uuid}/state/{uuid}
Resource: programenrollment| 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
-
state response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /programenrollment/{parent-uuid}/state/{uuid}
Resource: programenrollmentUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
state response
- 401 Unauthorized
-
User not logged in
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
| 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
-
programenrollment response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /programenrollment/{uuid}
Resource: programenrollmentUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
programenrollment response
- 401 Unauthorized
-
User not logged in
All search parameters are optional
| v | The representation to return (ref, default, full or custom) |
query | string | |
| q | The search query |
query | string | |
| user | 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
-
provider response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
provider response
- 401 Unauthorized
-
User not logged in
GET /provider/{parent-uuid}/attribute
Resource: provider| 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
-
attribute response
- 401 Unauthorized
-
User not logged in
POST /provider/{parent-uuid}/attribute
Resource: providerUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
attribute response
- 401 Unauthorized
-
User not logged in
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
GET /provider/{parent-uuid}/attribute/{uuid}
Resource: provider| 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
-
attribute response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /provider/{parent-uuid}/attribute/{uuid}
Resource: providerUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
attribute response
- 401 Unauthorized
-
User not logged in
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
| 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
-
provider response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
provider response
- 401 Unauthorized
-
User not logged in
| 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
-
providerattributetype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
providerattributetype response
- 401 Unauthorized
-
User not logged in
DELETE /providerattributetype/{uuid}
Resource: providerattributetypeThe 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
| 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
-
providerattributetype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /providerattributetype/{uuid}
Resource: providerattributetypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
providerattributetype response
- 401 Unauthorized
-
User not logged in
GET /relationship
Resource: relationshipAll search parameters are optional
| v | The representation to return (ref, default, full or custom) |
query | string | |
| relatedPerson | query | string | ||
| person | query | string | ||
| q | The search query |
query | string | |
| relation | query | string | ||
| personA | query | string | ||
| personB | 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
-
relationship response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
relationship response
- 401 Unauthorized
-
User not logged in
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
| 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
-
relationship response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /relationship/{uuid}
Resource: relationshipUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
relationship response
- 401 Unauthorized
-
User not logged in
| 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
-
relationshiptype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
relationshiptype response
- 401 Unauthorized
-
User not logged in
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
| 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
-
relationshiptype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /relationshiptype/{uuid}
Resource: relationshiptypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
relationshiptype response
- 401 Unauthorized
-
User not logged in
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
| 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
-
reportingrest/cohort response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
-
reportingrest/cohortDefinition response
- 401 Unauthorized
-
User not logged in
POST /reportingrest/cohortDefinition
Resource: reportingrest_cohortDefinitionUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
reportingrest/cohortDefinition response
- 401 Unauthorized
-
User not logged in
DELETE /reportingrest/cohortDefinition/{uuid}
Resource: reportingrest_cohortDefinitionThe 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
| 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
-
reportingrest/cohortDefinition response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /reportingrest/cohortDefinition/{uuid}
Resource: reportingrest_cohortDefinitionUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
reportingrest/cohortDefinition response
- 401 Unauthorized
-
User not logged in
DELETE /reportingrest/dataSet/{uuid}
Resource: reportingrest_dataSetThe 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
| 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
-
reportingrest/dataSet response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
GET /reportingrest/dataSetDefinition
Resource: reportingrest_dataSetDefinition| 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
-
reportingrest/dataSetDefinition response
- 401 Unauthorized
-
User not logged in
POST /reportingrest/dataSetDefinition
Resource: reportingrest_dataSetDefinitionUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
reportingrest/dataSetDefinition response
- 401 Unauthorized
-
User not logged in
DELETE /reportingrest/dataSetDefinition/{uuid}
Resource: reportingrest_dataSetDefinitionThe 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
| 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
-
reportingrest/dataSetDefinition response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /reportingrest/dataSetDefinition/{uuid}
Resource: reportingrest_dataSetDefinitionUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
reportingrest/dataSetDefinition response
- 401 Unauthorized
-
User not logged in
DELETE /reportingrest/reportdata/{uuid}
Resource: reportingrest_reportdataThe 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
| 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
-
reportingrest/reportdata response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
-
reportingrest/reportDefinition response
- 401 Unauthorized
-
User not logged in
POST /reportingrest/reportDefinition
Resource: reportingrest_reportDefinitionUses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
reportingrest/reportDefinition response
- 401 Unauthorized
-
User not logged in
DELETE /reportingrest/reportDefinition/{uuid}
Resource: reportingrest_reportDefinitionThe 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
| 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
-
reportingrest/reportDefinition response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /reportingrest/reportDefinition/{uuid}
Resource: reportingrest_reportDefinitionUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
reportingrest/reportDefinition response
- 401 Unauthorized
-
User not logged in
DELETE /reportingrest/reportRequest/{uuid}
Resource: reportingrest_reportRequestThe 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
| 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
-
reportingrest/reportRequest response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
| 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
-
role response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
role response
- 401 Unauthorized
-
User not logged in
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
| 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
-
role response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
role response
- 401 Unauthorized
-
User not logged in
| 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
-
systemsetting response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
systemsetting response
- 401 Unauthorized
-
User not logged in
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
| 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
-
systemsetting response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /systemsetting/{uuid}
Resource: systemsettingUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
systemsetting response
- 401 Unauthorized
-
User not logged in
All search parameters are optional
| v | The representation to return (ref, default, full or custom) |
query | string | |
| username | 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
-
user response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
user response
- 401 Unauthorized
-
User not logged in
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
| 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
-
user response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
user response
- 401 Unauthorized
-
User not logged in
| 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
-
visit response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
visit response
- 401 Unauthorized
-
User not logged in
| 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
-
attribute response
- 401 Unauthorized
-
User not logged in
POST /visit/{parent-uuid}/attribute
Resource: visitUses default content-types: application/json
Resource to create
| parent-uuid | parent resource uuid |
path | string |
application/json application/xml
- 201 Created
-
attribute response
- 401 Unauthorized
-
User not logged in
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
| 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
-
attribute response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /visit/{parent-uuid}/attribute/{uuid}
Resource: visitUses default content-types: application/json
Resource properties to update
| parent-uuid | parent resource uuid |
path | string | |
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
attribute response
- 401 Unauthorized
-
User not logged in
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
| 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
-
visit response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
visit response
- 401 Unauthorized
-
User not logged in
| 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
-
visitattributetype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
visitattributetype response
- 401 Unauthorized
-
User not logged in
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
| 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
-
visitattributetype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /visitattributetype/{uuid}
Resource: visitattributetypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
visitattributetype response
- 401 Unauthorized
-
User not logged in
| 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
-
visittype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
visittype response
- 401 Unauthorized
-
User not logged in
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
| 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
-
visittype response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
POST /visittype/{uuid}
Resource: visittypeUses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
visittype response
- 401 Unauthorized
-
User not logged in
Uses default content-types: application/json
Resource to create
application/json application/xml
- 201 Created
-
workflow response
- 401 Unauthorized
-
User not logged in
| 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
-
state response
- 401 Unauthorized
-
User not logged in
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
| 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
-
state response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
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
| 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
-
workflow response
- 401 Unauthorized
-
User not logged in
- 404 Not Found
-
Resource with given uuid doesn't exist
Uses default content-types: application/json
Resource properties to update
| uuid | uuid of resource to update |
path | string |
application/json application/xml
- 201 Created
-
workflow response
- 401 Unauthorized
-
User not logged in
Schema definitions
- reaction: string
-
- startDate: string
-
- allergen: string
-
- person: string
-
- stopObs: string
-
- startObs: string
-
- allergyType: string
-
- severity: string
-
- comments: string
-
- reaction: string
-
- startDate: string
-
- allergen: string
-
- person: string
-
- startObs: string
-
- stopObs: string
-
- allergyType: string
-
- severity: string
-
- display: string
-
- endDate: string
-
- voided: string
-
- uuid: string
-
- activeListType: string
-
- comments: string
-
- auditInfo: string
-
- reaction: string
-
- startDate: string
-
- allergen: string
-
- person: string
-
- stopObs: string
-
- startObs: string
-
- allergyType: string
-
- severity: string
-
- comments: string
-
- patient: string
-
- reason: string
-
- status: string
-
- visit: string
-
- appointmentType: string
-
- cancelReason: string
-
- timeSlot: string
-
- patient: string
-
- reason: string
-
- status: string
-
- voided: string
-
- visit: string
-
- display: string
-
- uuid: string
-
- appointmentType: string
-
- auditInfo: string
-
- cancelReason: string
-
- timeSlot: string
-
- reason: string
-
- status: string
-
- visit: string
-
- cancelReason: string
-
- startDate: string
-
- location: string
-
- provider: string
-
- endDate: string
-
- types: string
-
- startDate: string
-
- location: string
-
- voided: string
-
- provider: string
-
- endDate: string
-
- display: string
-
- uuid: string
-
- types: string
-
- auditInfo: string
-
- startDate: string
-
- location: string
-
- provider: string
-
- endDate: string
-
- types: string
-
- maxTimeFrameUnits: string
-
- patient: string
-
- maxTimeFrameValue: string
-
- minTimeFrameValue: string
-
- status: string
-
- provider: string
-
- notes: string
-
- requestedOn: string
-
- appointmentType: string
-
- minTimeFrameUnits: string
-
- requestedBy: string
-
- status: string
-
- minTimeFrameValue: string
-
- display: string
-
- provider: string
-
- requestedOn: string
-
- minTimeFrameUnits: string
-
- patient: string
-
- maxTimeFrameUnits: string
-
- maxTimeFrameValue: string
-
- voided: string
-
- uuid: string
-
- notes: string
-
- appointmentType: string
-
- auditInfo: string
-
- requestedBy: string
-
- maxTimeFrameUnits: string
-
- patient: string
-
- maxTimeFrameValue: string
-
- minTimeFrameValue: string
-
- status: string
-
- provider: string
-
- notes: string
-
- requestedOn: string
-
- appointmentType: string
-
- minTimeFrameUnits: string
-
- requestedBy: string
-
- duration: string
-
- description: string
-
- name: string
-
- confidential: string
-
- duration: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- confidential: string
-
- duration: string
-
- description: string
-
- name: string
-
- confidential: string
-
- startDate: string
-
- endDate: string
-
- appointmentBlock: string
-
- startDate: string
-
- voided: string
-
- countOfAppointments: string
-
- unallocatedMinutes: string
-
- endDate: string
-
- display: string
-
- appointmentBlock: string
-
- uuid: string
-
- auditInfo: string
-
- startDate: string
-
- endDate: string
-
- appointmentBlock: string
-
- description: string
-
- name: string
-
- careSettingType: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- memberIds: string
-
- voided: string
-
- description: string
-
- name: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- allowDecimal: string
-
- conceptClass: string
-
- set: string
-
- lowCritical: string
-
- answers: string
-
- hiNormal: string
-
- displayPrecision: string
-
- units: string
-
- lowNormal: string
-
- descriptions: string
-
- version: string
-
- hiCritical: string
-
- lowAbsolute: string
-
- hiAbsolute: string
-
- names: string
-
- mappings: string
-
- datatype: string
-
- setMembers: string
-
- description: string
-
- name: string
-
- retired: string
-
- hl7Abbreviation: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- conceptClass: string
-
- set: string
-
- retired: string
-
- answers: string
-
- display: string
-
- descriptions: string
-
- version: string
-
- names: string
-
- name: string
-
- mappings: string
-
- uuid: string
-
- datatype: string
-
- setMembers: string
-
- conceptMapType: string
-
- conceptReferenceTerm: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- isHidden: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- conceptNameType: string
-
- locale: string
-
- name: string
-
- localePreferred: string
-
- conceptNameType: string
-
- locale: string
-
- name: string
-
- localePreferred: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- conceptNameType: string
-
- locale: string
-
- name: string
-
- localePreferred: string
-
- conceptSource: string
-
- description: string
-
- name: string
-
- code: string
-
- version: string
-
- conceptSource: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- code: string
-
- uuid: string
-
- auditInfo: string
-
- version: string
-
- conceptMapType: string
-
- termA: string
-
- termB: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- conceptSource: string
-
- description: string
-
- name: string
-
- code: string
-
- version: string
-
- hl7Code: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- allowDecimal: string
-
- conceptClass: string
-
- set: string
-
- lowCritical: string
-
- answers: string
-
- hiNormal: string
-
- displayPrecision: string
-
- units: string
-
- lowNormal: string
-
- version: string
-
- hiCritical: string
-
- lowAbsolute: string
-
- hiAbsolute: string
-
- name: string
-
- mappings: string
-
- datatype: string
-
- setMembers: string
-
- id: string
-
- name: string
-
- categories: string
-
- categoryOptionCombos: string
-
- id: string
-
- categoryCombo: string
-
- dataElements: string
-
- periodType: string
-
- name: string
-
- code: string
-
- dataValues: string
-
- orgUnit: string
-
- period: string
-
- dataSet: string
-
- dataValues: string
-
- orgUnit: string
-
- period: string
-
- dataSet: string
-
- dataValues: string
-
- orgUnit: string
-
- period: string
-
- dataSet: string
-
- dataSetUID: string
-
- created: string
-
- periodType: string
-
- name: string
-
- periodIndicatorReportGUID: string
-
- elements: string
-
- dataSetUID: string
-
- created: string
-
- periodType: string
-
- name: string
-
- periodIndicatorReportGUID: string
-
- elements: string
-
- dataSetUID: string
-
- created: string
-
- periodType: string
-
- name: string
-
- periodIndicatorReportGUID: string
-
- elements: string
-
- id: string
-
- created: string
-
- name: string
-
- lastUpdated: string
-
- code: string
-
- ingredients: string
-
- concept: string
-
- maximumDailyDose: string
-
- strength: string
-
- route: string
-
- description: string
-
- name: string
-
- combination: string
-
- doseStrength: string
-
- dosageForm: string
-
- units: string
-
- minimumDailyDose: string
-
- concept: string
-
- strength: string
-
- retired: string
-
- doseStrength: string
-
- display: string
-
- units: string
-
- ingredients: string
-
- maximumDailyDose: string
-
- route: string
-
- description: string
-
- name: string
-
- combination: string
-
- uuid: string
-
- dosageForm: string
-
- auditInfo: string
-
- minimumDailyDose: string
-
- strength: string
-
- ingredient: string
-
- display: string
-
- uuid: string
-
- units: string
-
- concept: string
-
- maximumDailyDose: string
-
- strength: string
-
- route: string
-
- description: string
-
- name: string
-
- combination: string
-
- doseStrength: string
-
- dosageForm: string
-
- units: string
-
- minimumDailyDose: string
-
- obs: string
-
- patient: string
-
- form: string
-
- location: string
-
- visit: string
-
- orders: string
-
- provider: string
-
- encounterProviders: string
-
- encounterType: string
-
- encounterDatetime: string
-
- encounterRole: string
-
- voided: string
-
- provider: string
-
- uuid: string
-
- auditInfo: string
-
- obs: string
-
- patient: string
-
- form: string
-
- location: string
-
- voided: string
-
- visit: string
-
- orders: string
-
- display: string
-
- uuid: string
-
- encounterProviders: string
-
- auditInfo: string
-
- encounterType: string
-
- encounterDatetime: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- obs: string
-
- patient: string
-
- form: string
-
- location: string
-
- visit: string
-
- orders: string
-
- provider: string
-
- encounterProviders: string
-
- encounterType: string
-
- encounterDatetime: string
-
- attributeName: string
-
- concept: string
-
- selectMultiple: string
-
- tableName: string
-
- fieldType: string
-
- description: string
-
- name: string
-
- defaultValue: string
-
- attributeName: string
-
- concept: string
-
- selectMultiple: string
-
- tableName: string
-
- fieldType: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- defaultValue: string
-
- auditInfo: string
-
- isSet: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- attributeName: string
-
- concept: string
-
- selectMultiple: string
-
- tableName: string
-
- fieldType: string
-
- description: string
-
- name: string
-
- defaultValue: string
-
- template: string
-
- formFields: string
-
- xslt: string
-
- description: string
-
- name: string
-
- published: string
-
- build: string
-
- encounterType: string
-
- version: string
-
- field: string
-
- fieldNumber: string
-
- form: string
-
- maxOccurs: string
-
- sortWeight: string
-
- pageNumber: string
-
- parent: string
-
- fieldPart: string
-
- required: string
-
- minOccurs: string
-
- field: string
-
- fieldNumber: string
-
- form: string
-
- maxOccurs: string
-
- retired: string
-
- sortWeight: string
-
- pageNumber: string
-
- parent: string
-
- display: string
-
- uuid: string
-
- required: string
-
- fieldPart: string
-
- auditInfo: string
-
- minOccurs: string
-
- field: string
-
- fieldNumber: string
-
- form: string
-
- maxOccurs: string
-
- sortWeight: string
-
- pageNumber: string
-
- parent: string
-
- fieldPart: string
-
- required: string
-
- minOccurs: string
-
- formFields: string
-
- resources: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- published: string
-
- build: string
-
- auditInfo: string
-
- version: string
-
- encounterType: string
-
- valueReference: string
-
- dataType: string
-
- form: string
-
- handlerConfig: string
-
- name: string
-
- value: string
-
- handler: string
-
- valueReference: string
-
- dataType: string
-
- form: string
-
- handlerConfig: string
-
- name: string
-
- value: string
-
- handler: string
-
- template: string
-
- xslt: string
-
- description: string
-
- name: string
-
- published: string
-
- build: string
-
- encounterType: string
-
- version: string
-
- voided: string
-
- value: string
-
- display: string
-
- attributeType: string
-
- uuid: string
-
- auditInfo: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- tags: string
-
- countyDistrict: string
-
- address1: string
-
- address2: string
-
- parentLocation: string
-
- address3: string
-
- country: string
-
- address6: string
-
- address5: string
-
- address4: string
-
- postalCode: string
-
- childLocations: string
-
- description: string
-
- name: string
-
- cityVillage: string
-
- stateProvince: string
-
- longitude: string
-
- attributes: string
-
- latitude: string
-
- tags: string
-
- countyDistrict: string
-
- retired: string
-
- address1: string
-
- display: string
-
- address2: string
-
- parentLocation: string
-
- address3: string
-
- country: string
-
- address6: string
-
- address5: string
-
- address4: string
-
- postalCode: string
-
- childLocations: string
-
- description: string
-
- name: string
-
- cityVillage: string
-
- stateProvince: string
-
- longitude: string
-
- attributes: string
-
- uuid: string
-
- latitude: string
-
- auditInfo: string
-
- tags: string
-
- countyDistrict: string
-
- address1: string
-
- address2: string
-
- parentLocation: string
-
- address3: string
-
- country: string
-
- address6: string
-
- address5: string
-
- address4: string
-
- postalCode: string
-
- childLocations: string
-
- description: string
-
- name: string
-
- cityVillage: string
-
- stateProvince: string
-
- longitude: string
-
- attributes: string
-
- latitude: string
-
- formFieldPath: string
-
- concept: string
-
- person: string
-
- order: string
-
- location: string
-
- obsDatetime: string
-
- formFieldNamespace: string
-
- groupMembers: string
-
- value: string
-
- accessionNumber: string
-
- encounter: string
-
- comment: string
-
- valueModifier: string
-
- valueCodedName: string
-
- formFieldPath: string
-
- concept: string
-
- person: string
-
- obsDatetime: string
-
- location: string
-
- formFieldNamespace: string
-
- groupMembers: string
-
- display: string
-
- encounter: string
-
- order: string
-
- voided: string
-
- value: string
-
- accessionNumber: string
-
- obsGroup: string
-
- uuid: string
-
- comment: string
-
- valueModifier: string
-
- auditInfo: string
-
- valueCodedName: string
-
- formFieldPath: string
-
- concept: string
-
- person: string
-
- order: string
-
- location: string
-
- obsDatetime: string
-
- formFieldNamespace: string
-
- groupMembers: string
-
- value: string
-
- accessionNumber: string
-
- encounter: string
-
- comment: string
-
- valueModifier: string
-
- valueCodedName: string
-
- durationUnits: string
-
- complex: string
-
- concept: string
-
- orderReasonNonCoded: string
-
- instructions: string
-
- autoExpireDate: string
-
- frequency: string
-
- encounter: string
-
- commentToFulfiller: string
-
- doseUnits: string
-
- careSetting: string
-
- type: string , x ∈ { drugorder , testorder }
-
- brandName: string
-
- dose: string
-
- urgency: string
-
- dateStopped: string
-
- patient: string
-
- dateActivated: string
-
- previousOrder: string
-
- action: string
-
- laterality: string
-
- quantity: string
-
- drug: string
-
- orderReason: string
-
- orderer: string
-
- dispenseAsWritten: string
-
- asNeededCondition: string
-
- display: string
-
- dosingInstructions: string
-
- asNeeded: string
-
- specimenSource: string
-
- units: string
-
- duration: string
-
- dosingType: string
-
- route: string
-
- numRefills: string
-
- quantityUnits: string
-
- orderNumber: string
-
- prn: string
-
- uuid: string
-
- numberOfRepeats: string
-
- clinicalHistory: string
-
- auditInfo: string
-
- concept: string
-
- frequencyPerDay: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- orderReason: string
-
- orderer: string
-
- orderReasonNonCoded: string
-
- concept: string
-
- instructions: string
-
- autoExpireDate: string
-
- display: string
-
- commentToFulfiller: string
-
- encounter: string
-
- careSetting: string
-
- urgency: string
-
- dateStopped: string
-
- patient: string
-
- dateActivated: string
-
- orderNumber: string
-
- action: string
-
- previousOrder: string
-
- uuid: string
-
- auditInfo: string
-
- conceptClasses: string
-
- javaClassName: string
-
- description: string
-
- name: string
-
- parent: string
-
- conceptClasses: string
-
- description: string
-
- javaClassName: string
-
- name: string
-
- retired: string
-
- parent: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- conceptClasses: string
-
- javaClassName: string
-
- description: string
-
- name: string
-
- parent: string
-
- person: string
-
- identifiers: string
-
- voided: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- location: string
-
- preferred: string
-
- identifierType: string
-
- identifier: string
-
- location: string
-
- voided: string
-
- display: string
-
- uuid: string
-
- preferred: string
-
- identifierType: string
-
- identifier: string
-
- auditInfo: string
-
- uniquenessBehavior: string
-
- description: string
-
- validator: string
-
- name: string
-
- locationBehavior: string
-
- checkDigit: string
-
- formatDescription: string
-
- format: string
-
- required: string
-
- uniquenessBehavior: string
-
- description: string
-
- validator: string
-
- name: string
-
- retired: string
-
- locationBehavior: string
-
- checkDigit: string
-
- formatDescription: string
-
- display: string
-
- format: string
-
- uuid: string
-
- required: string
-
- auditInfo: string
-
- uniquenessBehavior: string
-
- description: string
-
- validator: string
-
- name: string
-
- locationBehavior: string
-
- checkDigit: string
-
- formatDescription: string
-
- format: string
-
- required: string
-
- location: string
-
- preferred: string
-
- identifierType: string
-
- identifier: string
-
- startDate: string
-
- countyDistrict: string
-
- address1: string
-
- endDate: string
-
- address2: string
-
- address3: string
-
- preferred: string
-
- country: string
-
- address6: string
-
- address5: string
-
- postalCode: string
-
- address4: string
-
- cityVillage: string
-
- stateProvince: string
-
- longitude: string
-
- latitude: string
-
- startDate: string
-
- countyDistrict: string
-
- address1: string
-
- endDate: string
-
- display: string
-
- address2: string
-
- address3: string
-
- preferred: string
-
- country: string
-
- address6: string
-
- address5: string
-
- address4: string
-
- postalCode: string
-
- voided: string
-
- cityVillage: string
-
- stateProvince: string
-
- longitude: string
-
- uuid: string
-
- latitude: string
-
- auditInfo: string
-
- startDate: string
-
- countyDistrict: string
-
- address1: string
-
- endDate: string
-
- address2: string
-
- address3: string
-
- preferred: string
-
- country: string
-
- address6: string
-
- address5: string
-
- postalCode: string
-
- address4: string
-
- cityVillage: string
-
- stateProvince: string
-
- longitude: string
-
- latitude: string
-
- hydratedObject: string
-
- voided: string
-
- value: string
-
- display: string
-
- attributeType: string
-
- uuid: string
-
- auditInfo: string
-
- editPrivilege: string
-
- description: string
-
- name: string
-
- sortWeight: string
-
- format: string
-
- searchable: string
-
- foreignKey: string
-
- concept: string
-
- editPrivilege: string
-
- description: string
-
- name: string
-
- retired: string
-
- sortWeight: string
-
- display: string
-
- format: string
-
- uuid: string
-
- auditInfo: string
-
- searchable: string
-
- foreignKey: string
-
- editPrivilege: string
-
- description: string
-
- name: string
-
- sortWeight: string
-
- format: string
-
- searchable: string
-
- foreignKey: string
-
- birthdateEstimated: string
-
- names: string
-
- age: string
-
- birthdate: string
-
- deathdateEstimated: string
-
- causeOfDeath: string
-
- gender: string
-
- attributes: string
-
- addresses: string
-
- dead: string
-
- deathDate: string
-
- birthtime: string
-
- birthdateEstimated: string
-
- preferredName: string
-
- deathdateEstimated: string
-
- display: string
-
- deathDate: string
-
- preferredAddress: string
-
- voided: string
-
- names: string
-
- age: string
-
- birthdate: string
-
- gender: string
-
- causeOfDeath: string
-
- attributes: string
-
- uuid: string
-
- addresses: string
-
- dead: string
-
- auditInfo: string
-
- birthtime: string
-
- middleName: string
-
- familyName2: string
-
- degree: string
-
- familyNameSuffix: string
-
- prefix: string
-
- familyName: string
-
- givenName: string
-
- preferred: string
-
- familyNamePrefix: string
-
- middleName: string
-
- familyName2: string
-
- degree: string
-
- familyNameSuffix: string
-
- voided: string
-
- prefix: string
-
- familyName: string
-
- display: string
-
- givenName: string
-
- uuid: string
-
- preferred: string
-
- auditInfo: string
-
- familyNamePrefix: string
-
- middleName: string
-
- familyName2: string
-
- degree: string
-
- familyNameSuffix: string
-
- prefix: string
-
- familyName: string
-
- givenName: string
-
- preferred: string
-
- familyNamePrefix: string
-
- birthdateEstimated: string
-
- preferredName: string
-
- deathdateEstimated: string
-
- preferredAddress: string
-
- deathDate: string
-
- names: string
-
- age: string
-
- birthdate: string
-
- gender: string
-
- causeOfDeath: string
-
- attributes: string
-
- addresses: string
-
- dead: string
-
- birthtime: string
-
- modifier: string
-
- startDate: string
-
- person: string
-
- stopObs: string
-
- startObs: string
-
- sortWeight: string
-
- problem: string
-
- comments: string
-
- startDate: string
-
- person: string
-
- startObs: string
-
- stopObs: string
-
- sortWeight: string
-
- problem: string
-
- display: string
-
- endDate: string
-
- modifier: string
-
- voided: string
-
- uuid: string
-
- activeListType: string
-
- comments: string
-
- auditInfo: string
-
- modifier: string
-
- startDate: string
-
- person: string
-
- stopObs: string
-
- startObs: string
-
- sortWeight: string
-
- problem: string
-
- comments: string
-
- outcomesConcept: string
-
- concept: string
-
- description: string
-
- name: string
-
- retired: string
-
- patient: string
-
- location: string
-
- voided: string
-
- program: string
-
- states: string
-
- dateEnrolled: string
-
- outcome: string
-
- dateCompleted: string
-
- patient: string
-
- location: string
-
- voided: string
-
- program: string
-
- states: string
-
- display: string
-
- uuid: string
-
- dateEnrolled: string
-
- outcome: string
-
- auditInfo: string
-
- dateCompleted: string
-
- startDate: string
-
- patientProgram: string
-
- voided: string
-
- state: string
-
- endDate: string
-
- uuid: string
-
- auditInfo: string
-
- location: string
-
- voided: string
-
- states: string
-
- dateEnrolled: string
-
- outcome: string
-
- dateCompleted: string
-
- outcomesConcept: string
-
- concept: string
-
- description: string
-
- name: string
-
- retired: string
-
- allWorkflows: string
-
- uuid: string
-
- auditInfo: string
-
- outcomesConcept: string
-
- concept: string
-
- description: string
-
- name: string
-
- retired: string
-
- voided: string
-
- value: string
-
- display: string
-
- attributeType: string
-
- uuid: string
-
- auditInfo: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- person: string
-
- retired: string
-
- display: string
-
- attributes: string
-
- uuid: string
-
- identifier: string
-
- auditInfo: string
-
- startDate: string
-
- relationshipType: string
-
- endDate: string
-
- personA: string
-
- personB: string
-
- startDate: string
-
- relationshipType: string
-
- voided: string
-
- endDate: string
-
- display: string
-
- uuid: string
-
- personA: string
-
- personB: string
-
- auditInfo: string
-
- weight: string
-
- aIsToB: string
-
- description: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- bIsToA: string
-
- startDate: string
-
- relationshipType: string
-
- voided: string
-
- endDate: string
-
- description: string
-
- name: string
-
- class: string
-
- parameters: string
-
- uuid: string
-
- description: string
-
- name: string
-
- class: string
-
- parameters: string
-
- uuid: string
-
- description: string
-
- name: string
-
- class: string
-
- parameters: string
-
- uuid: string
-
- renderCompleteDatetime: string
-
- status: string
-
- description: string
-
- priority: string
-
- renderingMode: string
-
- requestDate: string
-
- uuid: string
-
- evaluateCompleteDatetime: string
-
- evaluateStartDatetime: string
-
- requestedBy: string
-
- allInheritedRoles: string
-
- description: string
-
- name: string
-
- retired: string
-
- privileges: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- inheritedRoles: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- value: string
-
- property: string
-
- preferredHandlerClassname: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- value: string
-
- display: string
-
- property: string
-
- uuid: string
-
- preferredHandlerClassname: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- value: string
-
- preferredHandlerClassname: string
-
- userProperties: string
-
- secretQuestion: string
-
- person: string
-
- username: string
-
- proficientLocales: string
-
- roles: string
-
- systemId: string
-
- password: string
-
- userProperties: string
-
- person: string
-
- retired: string
-
- privileges: string
-
- display: string
-
- username: string
-
- secretQuestion: string
-
- proficientLocales: string
-
- roles: string
-
- uuid: string
-
- systemId: string
-
- auditInfo: string
-
- allRoles: string
-
- userProperties: string
-
- secretQuestion: string
-
- person: string
-
- username: string
-
- proficientLocales: string
-
- roles: string
-
- systemId: string
-
- password: string
-
- voided: string
-
- value: string
-
- display: string
-
- attributeType: string
-
- uuid: string
-
- auditInfo: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- datatypeConfig: string
-
- datatypeClassname: string
-
- handlerConfig: string
-
- description: string
-
- maxOccurs: string
-
- name: string
-
- preferredHandlerClassname: string
-
- minOccurs: string
-
- patient: string
-
- stopDatetime: string
-
- location: string
-
- indication: string
-
- attributes: string
-
- encounters: string
-
- startDatetime: string
-
- visitType: string
-
- patient: string
-
- stopDatetime: string
-
- location: string
-
- voided: string
-
- indication: string
-
- display: string
-
- attributes: string
-
- encounters: string
-
- uuid: string
-
- auditInfo: string
-
- startDatetime: string
-
- visitType: string
-
- description: string
-
- name: string
-
- retired: string
-
- display: string
-
- uuid: string
-
- auditInfo: string
-
- stopDatetime: string
-
- location: string
-
- indication: string
-
- attributes: string
-
- encounters: string
-
- startDatetime: string
-
- visitType: string
-
Component Versions
The documentation above was automatically generated from a system running the following OpenMRS components.
| Component | Version |
|---|---|
| openmrs-core | 1.11.6 Build 0d2192 |
| atlas | 2.1 |
| formentryapp | 1.2 |
| reporting | 0.9.9-SNAPSHOT |
| metadatasharing | 1.1.10 |
| idgen | 3.2 |
| allergyui | 1.2 |
| emrapi | 1.11.1 |
| registrationapp | 1.3 |
| htmlformentryui | 1.3 |
| appframework | 2.4 |
| reportingrest | 1.6-SNAPSHOT |
| referencemetadata | 2.3.1 |
| metadatamapping | 1.0.2 |
| adminui | 1.0 |
| uiframework | 3.6 |
| referenceapplication | 2.3 |
| appui | 1.4 |
| dhisconnector | 0.1.1 |
| metadatadeploy | 1.5 |
| htmlwidgets | 1.7.0 |
| serialization.xstream | 0.2.10 |
| registrationcore | 1.2 |
| htmlformentry19ext | 1.6.1 |
| coreapps | 1.7 |
| event | 2.2.1 |
| providermanagement | 2.3 |
| chartsearch | 1.4.1 |
| calculation | 1.1 |
| allergyapi | 1.3 |
| appointmentschedulingui | 1.0.3 |
| owa | 1.4 |
| htmlformentry | 2.6 |
| uicommons | 1.7 |
| webservices.rest | 2.14.dc38aa |
| appointmentscheduling | 1.4 |
| dataexchange | 1.3.1 |
| uilibrary | 2.0.4 |
License
