REST Web Service Resources in OpenMRS 1.8

Owned by Daniel Kayiwa
Last updated: Mar 12, 2013 by raff

This page is generated automatically and must not be edited manually. It describes the urls/resources published by the REST Module.

For more information on conventions, authentication, and setup, see the main REST Web Services API For Clients page.

When a parameter has a bang "!" in front of it, it means that url will only be called if that parameter does NOT exist.

Properties listed in bold must not be null.

ActiveListType

URLs

url

description

GET /ws/rest/v1/activelisttype

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/activelisttype/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/activelisttype

Create with properties in request

POST /ws/rest/v1/activelisttype/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/activelisttype/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/activelisttype/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
name
description
retired
links
resourceVersion

uuid
display
name
description
retired
auditInfo
links
resourceVersion

name
description

name
description

Allergy

URLs

url

description

GET /ws/rest/v1/allergy

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/allergy/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/allergy

Create with properties in request

POST /ws/rest/v1/allergy/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/allergy/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/allergy/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
person
activeListType
startDate
endDate
startObs
stopObs
comments
voided
allergyType
reaction
severity
allergen
links
resourceVersion

uuid
display
person
activeListType
startDate
endDate
startObs
stopObs
comments
voided
auditInfo
allergyType
reaction
severity
allergen
links
resourceVersion

person
startDate
comments
startObs
stopObs
allergyType
allergen
reaction
severity

person
startDate
comments
startObs
stopObs
allergyType
allergen
reaction
severity

Cohort

URLs

url

description

GET /ws/rest/v1/cohort

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/cohort/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/cohort

Create with properties in request

POST /ws/rest/v1/cohort/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/cohort/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/cohort/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
name
description
voided
memberIds
links
resourceVersion

uuid
display
name
description
memberIds
voided
auditInfo
links
resourceVersion

name
description
memberIds

name
description

CohortMember

URLs

url

description

GET /ws/rest/v1/cohort/{parentUuid}/member/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/cohort/{parentUuid}/member

Fetch all non-retired

POST /ws/rest/v1/cohort/{parentUuid}/member

Create with properties in request

POST /ws/rest/v1/cohort/{parentUuid}/member/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/cohort/{parentUuid}/member/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/cohort/{parentUuid}/member/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

display
links

display
patient
links
resourceVersion

display
patient
links
resourceVersion

patient

patient

Concept

URLs

url

description

GET /ws/rest/v1/concept

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/concept/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/concept

Create with properties in request

POST /ws/rest/v1/concept/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/concept/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/concept/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
name
datatype
conceptClass
set
version
retired
names
descriptions
mappings
answers
setMembers
links
resourceVersion

uuid
display
name
datatype
conceptClass
set
version
retired
names
descriptions
mappings
answers
setMembers
auditInfo
links
resourceVersion

names
datatype
conceptClass
descriptions
set
version
mappings
answers
setMembers

datatype
conceptClass
set
version
mappings
answers
setMembers
name

ConceptClass

URLs

url

description

GET /ws/rest/v1/conceptclass

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/conceptclass/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/conceptclass

Create with properties in request

POST /ws/rest/v1/conceptclass/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/conceptclass/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/conceptclass/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
name
description
retired
links
resourceVersion

uuid
display
name
description
retired
auditInfo
links
resourceVersion

name
description

name
description

ConceptDatatype

URLs

url

description

GET /ws/rest/v1/conceptdatatype

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/conceptdatatype/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/conceptdatatype

Create with properties in request

POST /ws/rest/v1/conceptdatatype/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/conceptdatatype/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/conceptdatatype/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
name
description
hl7Abbreviation
retired
links
resourceVersion

uuid
display
name
description
hl7Abbreviation
retired
auditInfo
links
resourceVersion

name
description

name
description

ConceptDescription

URLs

url

description

GET /ws/rest/v1/concept/{parentUuid}/description/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/concept/{parentUuid}/description

Fetch all non-retired

POST /ws/rest/v1/concept/{parentUuid}/description

Create with properties in request

POST /ws/rest/v1/concept/{parentUuid}/description/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/concept/{parentUuid}/description/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/concept/{parentUuid}/description/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

display
uuid
description
locale
links
resourceVersion

uuid
description
locale
auditInfo
links
resourceVersion

description
locale

description
locale

ConceptMap

URLs

url

description

GET /ws/rest/v1/concept/{parentUuid}/mapping/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/concept/{parentUuid}/mapping

Fetch all non-retired

POST /ws/rest/v1/concept/{parentUuid}/mapping

Create with properties in request

POST /ws/rest/v1/concept/{parentUuid}/mapping/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/concept/{parentUuid}/mapping/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/concept/{parentUuid}/mapping/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

display
uuid
source
sourceCode
links
resourceVersion

display
uuid
source
sourceCode
comment
auditInfo
links
resourceVersion

source
sourceCode

source
sourceCode

ConceptName

URLs

url

description

GET /ws/rest/v1/concept/{parentUuid}/name/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/concept/{parentUuid}/name

Fetch all non-retired

POST /ws/rest/v1/concept/{parentUuid}/name

Create with properties in request

POST /ws/rest/v1/concept/{parentUuid}/name/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/concept/{parentUuid}/name/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/concept/{parentUuid}/name/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

display
uuid
name
locale
localePreferred
conceptNameType
links
resourceVersion

display
uuid
name
locale
localePreferred
conceptNameType
auditInfo
links
resourceVersion

name
locale
localePreferred
conceptNameType

name
locale
localePreferred
conceptNameType

ConceptSource

URLs

url

description

GET /ws/rest/v1/conceptsource

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/conceptsource/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/conceptsource

Create with properties in request

POST /ws/rest/v1/conceptsource/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/conceptsource/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/conceptsource/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
name
description
hl7Code
retired
links
resourceVersion

uuid
display
name
description
hl7Code
retired
auditInfo
links
resourceVersion

name
description
hl7Code

name
description
hl7Code

Drug

URLs

url

description

GET /ws/rest/v1/drug

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/drug/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/drug

Create with properties in request

POST /ws/rest/v1/drug/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/drug/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/drug/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

display
uuid
name
description
retired
dosageForm
doseStrength
maximumDailyDose
minimumDailyDose
units
concept
combination
route
links
resourceVersion

display
uuid
name
description
retired
dosageForm
doseStrength
maximumDailyDose
minimumDailyDose
units
concept
combination
route
auditInfo
links
resourceVersion

name
description
combination
concept
doseStrength
maximumDailyDose
minimumDailyDose
units
dosageForm
route

name
description
combination
concept
doseStrength
maximumDailyDose
minimumDailyDose
units
dosageForm
route

Encounter

URLs

url

description

GET /ws/rest/v1/encounter

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/encounter/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/encounter

Create with properties in request

POST /ws/rest/v1/encounter/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/encounter/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/encounter/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
encounterDatetime
patient
location
form
encounterType
provider
obs
orders
voided
links
resourceVersion