Documentation

Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Documentation

Page tree
Skip to end of metadata
Go to start of metadata

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

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

encounterDatetime
patient
encounterType
location
form
provider
orders
obs

encounterDatetime
patient
encounterType
location
form
provider
orders
obs

EncounterType

URLs

url

description

GET /ws/rest/v1/encountertype

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

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

Fetch by unique uuid

POST /ws/rest/v1/encountertype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/encountertype/{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

Field

URLs

url

description

GET /ws/rest/v1/field

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

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

Fetch by unique uuid

POST /ws/rest/v1/field

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/field/{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
fieldType
concept
tableName
attributeName
defaultValue
selectMultiple
retired
links
resourceVersion

uuid
display
name
description
fieldType
concept
tableName
attributeName
defaultValue
selectMultiple
retired
auditInfo
links
resourceVersion

name
description
fieldType
selectMultiple
concept
tableName
attributeName
defaultValue

name
description
fieldType
selectMultiple
concept
tableName
attributeName
defaultValue

FieldAnswer

URLs

url

description

GET /ws/rest/v1/field/{parentUuid}/answer/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/field/{parentUuid}/answer

Fetch all non-retired

POST /ws/rest/v1/field/{parentUuid}/answer

Create with properties in request

POST /ws/rest/v1/field/{parentUuid}/answer/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/field/{parentUuid}/answer/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/field/{parentUuid}/answer/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
concept
field
links
resourceVersion

uuid
display
concept
field
auditInfo
links
resourceVersion

field
concept

field
concept

FieldType

URLs

url

description

GET /ws/rest/v1/fieldtype

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

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

Fetch by unique uuid

POST /ws/rest/v1/fieldtype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/fieldtype/{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
isSet
retired
links
resourceVersion

uuid
display
name
description
isSet
retired
auditInfo
links
resourceVersion

name
description

name
description

Form

URLs

url

description

GET /ws/rest/v1/form

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

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

Fetch by unique uuid

POST /ws/rest/v1/form

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/form/{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
encounterType
version
build
published
formFields
retired
links
resourceVersion

uuid
display
name
description
encounterType
version
build
published
formFields
xslt
template
retired
auditInfo
links
resourceVersion

name
description
version
encounterType
build
published
formFields
xslt
template

name
description
version
encounterType
build
published
xslt
template

FormField

URLs

url

description

GET /ws/rest/v1/form/{parentUuid}/formfield/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/form/{parentUuid}/formfield

Fetch all non-retired

POST /ws/rest/v1/form/{parentUuid}/formfield

Create with properties in request

POST /ws/rest/v1/form/{parentUuid}/formfield/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/form/{parentUuid}/formfield/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/form/{parentUuid}/formfield/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
parent
form
field
fieldNumber
fieldPart
pageNumber
minOccurs
maxOccurs
required
sortWeight
retired
links
resourceVersion

uuid
display
parent
form
field
fieldNumber
fieldPart
pageNumber
minOccurs
maxOccurs
required
sortWeight
retired
auditInfo
links
resourceVersion

form
field
required
parent
fieldNumber
fieldPart
pageNumber
minOccurs
maxOccurs
sortWeight

form
field
required
parent
fieldNumber
fieldPart
pageNumber
minOccurs
maxOccurs
sortWeight

HL7

URLs

url

description

GET /ws/rest/v1/hl7

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

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

Fetch by unique uuid

POST /ws/rest/v1/hl7

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
messageState
links
resourceVersion

uuid
display
source
sourceKey
data
messageState
links
resourceVersion

hl7

hl7

HL7Source

URLs

url

description

GET /ws/rest/v1/hl7source

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

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

Fetch by unique uuid

POST /ws/rest/v1/hl7source

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/hl7source/{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

Location

URLs

url

description

GET /ws/rest/v1/location

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

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

Fetch by unique uuid

POST /ws/rest/v1/location

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/location/{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
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
tags
parentLocation
childLocations
retired
links
resourceVersion

uuid
display
name
description
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
tags
parentLocation
childLocations
retired
auditInfo
links
resourceVersion

name
description
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
tags
parentLocation
childLocations

name
description
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
tags
parentLocation
childLocations

LocationTag

URLs

url

description

GET /ws/rest/v1/locationtag

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

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

Fetch by unique uuid

POST /ws/rest/v1/locationtag

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/locationtag/{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
retired
retireReason

name
description
retired
retireReason

Obs

URLs

url

description

GET /ws/rest/v1/obs

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

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

Fetch by unique uuid

POST /ws/rest/v1/obs

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/obs/{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
concept
value
valueModifier
obsDatetime
accessionNumber
obsGroup
valueCodedName
groupMembers
comment
location
order
encounter
voided
links
resourceVersion

uuid
display
person
concept
value
valueModifier
obsDatetime
accessionNumber
obsGroup
valueCodedName
groupMembers
comment
location
order
encounter
voided
auditInfo
links
resourceVersion

person
obsDatetime
concept
location
order
encounter
value
valueModifier
accessionNumber
groupMembers
valueCodedName
comment

person
obsDatetime
concept
location
order
encounter
value
valueModifier
accessionNumber
groupMembers
valueCodedName
comment

Order

URLs

url

description

GET /ws/rest/v1/order

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

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

Fetch by unique uuid

POST /ws/rest/v1/order

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links
type

uuid
display
orderType
patient
concept
instructions
startDate
autoExpireDate
encounter
orderer
accessionNumber
discontinuedBy
discontinuedDate
discontinuedReason
discontinuedReasonNonCoded
links
type
resourceVersion

uuid
display
orderType
patient
concept
instructions
startDate
autoExpireDate
encounter
orderer
accessionNumber
discontinuedBy
discontinuedDate
discontinuedReason
discontinuedReasonNonCoded
auditInfo
links
type
resourceVersion

orderType
patient
concept
instructions
startDate
autoExpireDate
encounter
orderer
discontinuedBy
discontinuedDate
discontinuedReason
discontinuedReasonNonCoded
accessionNumber

orderType
patient
concept
instructions
startDate
autoExpireDate
encounter
orderer
discontinuedBy
discontinuedDate
discontinuedReason
discontinuedReasonNonCoded
accessionNumber

DrugOrder subclass of Order

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links
type

uuid
display
orderType
patient
concept
instructions
startDate
autoExpireDate
encounter
orderer
accessionNumber
discontinuedBy
discontinuedDate
discontinuedReason
discontinuedReasonNonCoded
dose
units
frequency
prn
complex
quantity
drug
links
type
resourceVersion

uuid
display
orderType
patient
concept
instructions
startDate
autoExpireDate
encounter
orderer
accessionNumber
discontinuedBy
discontinuedDate
discontinuedReason
discontinuedReasonNonCoded
auditInfo
dose
units
frequency
prn
complex
quantity
drug
links
type
resourceVersion

patient
concept
instructions
startDate
autoExpireDate
encounter
orderer
discontinuedBy
discontinuedDate
discontinuedReason
discontinuedReasonNonCoded
accessionNumber
dose
units
frequency
prn
complex
quantity
drug

patient
concept
instructions
startDate
autoExpireDate
encounter
orderer
discontinuedBy
discontinuedDate
discontinuedReason
discontinuedReasonNonCoded
accessionNumber
dose
units
frequency
prn
complex
quantity
drug

OrderType

URLs

url

description

GET /ws/rest/v1/ordertype

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

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

Fetch by unique uuid

POST /ws/rest/v1/ordertype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/ordertype/{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

Patient

URLs

url

description

GET /ws/rest/v1/patient

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

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

Fetch by unique uuid

POST /ws/rest/v1/patient

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
identifiers
person
voided
links
resourceVersion

uuid
display
identifiers
person
voided
auditInfo
links
resourceVersion

person
identifiers

null

PatientIdentifier

URLs

url

description

GET /ws/rest/v1/patient/{parentUuid}/identifier/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/patient/{parentUuid}/identifier

Fetch all non-retired

POST /ws/rest/v1/patient/{parentUuid}/identifier

Create with properties in request

POST /ws/rest/v1/patient/{parentUuid}/identifier/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/patient/{parentUuid}/identifier/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/patient/{parentUuid}/identifier/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

display
uuid
identifier
identifierType
location
preferred
voided
links
resourceVersion

display
uuid
identifier
identifierType
location
preferred
voided
auditInfo
links
resourceVersion

identifier
identifierType
location
preferred

identifier
identifierType
location
preferred

PatientIdentifierType

URLs

url

description

GET /ws/rest/v1/patientidentifiertype

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

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

Fetch by unique uuid

POST /ws/rest/v1/patientidentifiertype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/patientidentifiertype/{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
format
formatDescription
required
checkDigit
validator
locationBehavior
retired
links
resourceVersion

uuid
display
name
description
format
formatDescription
required
checkDigit
validator
locationBehavior
retired
auditInfo
links
resourceVersion

name
description
format
formatDescription
required
checkDigit
validator
locationBehavior
uniquenessBehavior

name
description
format
formatDescription
required
checkDigit
validator
locationBehavior
uniquenessBehavior

Person

URLs

url

description

GET /ws/rest/v1/person

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

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

Fetch by unique uuid

POST /ws/rest/v1/person

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
gender
age
birthdate
birthdateEstimated
dead
deathDate
causeOfDeath
preferredName
preferredAddress
attributes
voided
links
resourceVersion

uuid
display
gender
age
birthdate
birthdateEstimated
dead
deathDate
causeOfDeath
preferredName
preferredAddress
names
addresses
attributes
voided
auditInfo
links
resourceVersion

names
gender
age
birthdate
birthdateEstimated
dead
deathDate
causeOfDeath
addresses
attributes

gender
birthdate
birthdateEstimated
dead
deathDate
causeOfDeath
preferredName
preferredAddress

PersonAddress

URLs

url

description

GET /ws/rest/v1/person/{parentUuid}/address/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/person/{parentUuid}/address

Fetch all non-retired

POST /ws/rest/v1/person/{parentUuid}/address

Create with properties in request

POST /ws/rest/v1/person/{parentUuid}/address/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/person/{parentUuid}/address/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/person/{parentUuid}/address/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

display
uuid
preferred
address1
address2
cityVillage
stateProvince
country
postalCode
countyDistrict
address3
address4
address5
address6
startDate
endDate
latitude
longitude
voided
links
resourceVersion

display
uuid
preferred
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
startDate
endDate
voided
auditInfo
links
resourceVersion

preferred
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
startDate
endDate

preferred
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
startDate
endDate

PersonAttribute

URLs

url

description

GET /ws/rest/v1/person/{parentUuid}/attribute/{uuid}

Fetch by unique uuid

GET /ws/rest/v1/person/{parentUuid}/attribute

Fetch all non-retired

POST /ws/rest/v1/person/{parentUuid}/attribute

Create with properties in request

POST /ws/rest/v1/person/{parentUuid}/attribute/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/person/{parentUuid}/attribute/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/person/{parentUuid}/attribute/{uuid}?purge

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

display
uuid
value
attributeType
voided
links
resourceVersion

display
uuid
value
attributeType
voided
auditInfo
links
resourceVersion

value
attributeType

value
attributeType

PersonAttributeType

URLs

url

description

GET /ws/rest/v1/personattributetype

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

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

Fetch by unique uuid

POST /ws/rest/v1/personattributetype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/personattributetype/{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
format
foreignKey
sortWeight
searchable
editPrivilege
retired
links
resourceVersion

uuid
display
name
description
format
foreignKey
sortWeight
searchable
editPrivilege
retired
auditInfo
links
resourceVersion

name
description
format
foreignKey
sortWeight
searchable
editPrivilege

name
description
format
foreignKey
sortWeight
searchable
editPrivilege

PersonName

URLs

url

description

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

Fetch by unique uuid

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

Fetch all non-retired

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

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/person/{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
givenName
middleName
familyName
familyName2
voided
links
resourceVersion

display
uuid
givenName
middleName
familyName
familyName2
preferred
prefix
familyNamePrefix
familyNameSuffix
degree
voided
auditInfo
links
resourceVersion

givenName
familyName
middleName
familyName2
preferred
prefix
familyNamePrefix
familyNameSuffix
degree

givenName
familyName
middleName
familyName2
preferred
prefix
familyNamePrefix
familyNameSuffix
degree

Privilege

URLs

url

description

GET /ws/rest/v1/privilege

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

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

Fetch by unique uuid

POST /ws/rest/v1/privilege

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/privilege/{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

description

Problem

URLs

url

description

GET /ws/rest/v1/problem

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

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

Fetch by unique uuid

POST /ws/rest/v1/problem

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/problem/{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
modifier
sortWeight
problem
links
resourceVersion

uuid
display
person
activeListType
startDate
endDate
startObs
stopObs
comments
voided
auditInfo
modifier
sortWeight
problem
links
resourceVersion

person
startDate
comments
startObs
stopObs
problem
modifier
sortWeight

person
startDate
comments
startObs
stopObs
problem
modifier
sortWeight

Role

URLs

url

description

GET /ws/rest/v1/role

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

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

Fetch by unique uuid

POST /ws/rest/v1/role

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/role/{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
privileges
inheritedRoles
links
resourceVersion

uuid
display
name
description
retired
privileges
inheritedRoles
allInheritedRoles
auditInfo
links
resourceVersion

name
description
privileges
inheritedRoles

description
privileges
inheritedRoles

User

URLs

url

description

GET /ws/rest/v1/user

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

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

Fetch by unique uuid

POST /ws/rest/v1/user

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
username
systemId
userProperties
person
privileges
roles
retired
links
resourceVersion

uuid
display
username
systemId
userProperties
person
privileges
roles
allRoles
proficientLocales
secretQuestion
retired
auditInfo
links
resourceVersion

username
password
person
systemId
userProperties
roles
proficientLocales
secretQuestion

username
password
person
systemId
userProperties
roles
proficientLocales
secretQuestion

  • No labels

8 Comments

  1. Darius Jazayeri

    Hard to see the difference in header sizes. Something needs to use h2 (since that gets underlines). Also try adding the table of contents macro at the top

    1. Roger Friedman

      Or get rid of all the underlines and put a horizontal rule between resources

  2. Roger Friedman

    Daniel --

       None of the reference representations have voided as a component.  Is this an omission, an assumption, or a design change?

       AFAIK, the ref representation for ConceptDescription should not include description, ref representations include exactly UUID, display, links and void.

       I can't believe we really want to expose user.

       The purge parameter is not well explained.  Get rid of the !purge and fix the description to read void/retire, for the other fix the description to void/retire and purge (unless we want to exclude the possiblity of voiding/retiring and purging in the same step, requiring a resource to be voided/retired before any attempt to purge it).

  3. Sateesh Kavuri

    Attributes are extra properties not supported in the core. Once attributes are added in OpenMRS, they can be accessed via WebServices REST client. An example to add attributes for Person object is as under:

    Attributes POST example
    echo '
{"gender":"F","age":12,"names":[{"givenName":"jjj","middleName":"kkk","familyName":"mmm"}],"addresses":[{"preferred":true,"address1":"addr1","address2":"addr2","cityVillage":"addg","stateProvince":"df","country":"Never","address3":null,"postalCode":"1111"}],"attributes":[{"value":"abc@def.com","attributeType":"3c64c1aa-0401-47f7-aa9d-73d803a90e22"}]}
' | curl -i -H "Content-type: application/json" -X POST -d @- https://localhost:8443/openmrs/ws/rest/v1/person -k -b cookies.txt -3

  4. Sateesh Kavuri

    Observation POST example
    echo '
{
"person":"707ed494-22fe-43cd-9751-0c39242b741b",
"obsDatetime":"2012-09-19T00:00:00.000+0530",
"concept":"2f098028-153a-4f30-bcef-bd62fa01255b",
"location":"8d6c993e-c2cc-11de-8d13-0010c6dffd0f",
"encounter":"e585bd32-3e43-4391-81b7-9ff575225671",
"value":"no problem"
}
' | curl -i -H "Content-type: application/json" -X POST -d @- https://localhost:8443/openmrs/ws/rest/v1/obs -k -b cookies.txt -3

  5. Sateesh Kavuri

    Concept POST example
    echo '
{
"names":[{"name":"Myname","locale":"en", "conceptNameType":"FULLY_SPECIFIED"}],
"datatype":"8d4a48b6-c2cc-11de-8d13-0010c6dffd0f",
"conceptClass":"8d491a9a-c2cc-11de-8d13-0010c6dffd0f",
"set":true,
"setMembers":["2f098028-153a-4f30-bcef-bd62fa01255b","2f098028-153a-4f30-bcef-bd62fa01255b"]
}
' | curl -i -H "Content-type: application/json" -X POST -d @- [https://localhost:8443/openmrs/ws/rest/v1/concept] -k -b cookies.txt -3

  6. Sateesh Kavuri

    Drug Order POST example
    echo '
{
"patient":"5a3c5ee8-dadf-42af-9c63-44735069bf76",
"startDate":"2012-09-19T00:00:00.000+0530",
"concept":"4815af70-c1c1-4c93-9262-b20e4151f080",
"drug":"40cac5e6-b043-4e72-935d-e56e5647b851",
"encounter":"1dee2c17-5fd9-4fb7-be31-9a75d0b530d2",
"orderer":"dc99ef4c-f69e-401c-a8a2-dca3b7cd0eef",
"dose":"4",
"units":"mg",
"frequency":"2 per day",
"quantity":10,
"type":"drugorder"
}
' | curl -i -H "Content-type: application/json" -X POST -d @- https://localhost:8443/openmrs/ws/rest/v1/order -k -b cookies.txt -3

  7. Sateesh Kavuri

    Encounter POST example
    echo '
{
"encounterDatetime":"2012-09-16T14:08:40.000+0530",
"patient":"2b0bd331-c9d1-4fba-b617-348249baebe6",
"location":"8d6c993e-c2cc-11de-8d13-0010c6dffd0f",
"encounterType":"99555b93-d060-42b0-9a95-0c267426b7da",
"provider":"ee8cd379-0843-4711-b2fd-c07c91752c8e"
}
' | curl -i -H "Content-type: application/json" -X POST -d @- https://localhost:8443/openmrs110/ws/rest/v1/encounter -k -b cookies.txt -3

Feedback on this page? Questions?

Visit OpenMRS Talk, our community discussion hub.

Copyright © 2004-2016 OpenMRS Inc. By using this site, you agree to the OpenMRS Privacy Policy.
Text is available under the Creative Commons 4.0 International Attribution License (CC BY 4.0).
Software is available under the Mozilla Public License 2.0 with Healthcare Disclaimer (MPL 2.0 HD).
"OpenMRS" is a registered trademark and the OpenMRS graphic logo is a trademark of OpenMRS Inc.