REST Web Service Resources in OpenMRS 1.9

Owned by raff
Last updated: Sep 16, 2022 by Sharif Magembe

We have migrated to an enhanced online openmrs rest api documentation. Please visit 

https://rest.openmrs.org/#openmrs-rest-api


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

Examples

Call TypeSample URLOutput
GET/ws/rest/v1/conceptReturns a list of top 50 concepts with uuid, display and links
GET/ws/rest/v1/concept?v=custom:(uuid,name)Returns a list of top 50 concepts
GET/ws/rest/v1/concept/cbec024a-8bb4-4fcc-b59b-c7b706bb432e

Returns full description of a concept, including:
uuid, name, display, datatype, conceptClass, set, version, retired, names, mappings, etc.

GET/ws/rest/v1/concept?q=YesReturns list of concepts matching "Yes" with uuid, display and links
GET/ws/rest/v1/concept?q=COUGH&v=custom:(uuid,name)

Returns list of concepts matching "COUGH" with uuid and 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
conceptReferenceTerm
conceptMapType
links
resourceVersion

display
uuid
conceptReferenceTerm
conceptMapType
auditInfo
links
resourceVersion

conceptReferenceTerm
conceptMapType

conceptReferenceTerm
conceptMapType

ConceptMapType

URLs

url

description

GET /ws/rest/v1/conceptmaptype

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

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

Fetch by unique uuid

POST /ws/rest/v1/conceptmaptype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

uuid
display
name
description
isHidden
retired
auditInfo
links
resourceVersion

name
description
isHidden

name
description
isHidden

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

ConceptReferenceTerm

URLs

url

description

GET /ws/rest/v1/conceptreferenceterm

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

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

Fetch by unique uuid

POST /ws/rest/v1/conceptreferenceterm

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/conceptreferenceterm/{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
conceptSource
description
code
version
retired
conceptReferenceTermMaps
links
resourceVersion

uuid
display
name
conceptSource
description
code
version
retired
conceptReferenceTermMaps
auditInfo
links
resourceVersion

code
conceptSource
name
description
version
conceptReferenceTermMaps

code
conceptSource
name
description
version
conceptReferenceTermMaps

ConceptReferenceTermMap

URLs

url

description

GET /ws/rest/v1/conceptreferencetermmap

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

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

Fetch by unique uuid

POST /ws/rest/v1/conceptreferencetermmap

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid
display
termA
termB
conceptMapType
links
resourceVersion

uuid
display
termA
termB
conceptMapType
auditInfo
links
resourceVersion

termA
termB
conceptMapType

termA
termB
conceptMapType

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
visit
links
resourceVersion

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

encounterDatetime
patient
encounterType
location
form
provider
orders
obs
visit

encounterDatetime
patient
encounterType
location
form
provider
orders
obs
visit

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

Not supported

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

FormResource

URLs

url

description

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

Fetch by unique uuid

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

Fetch all non-retired

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

Create with properties in request

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

Edit with given uuid, only modifying properties in request

POST /ws/rest/v1/form/{parentUuid}/resource/{uuid}/valueEdit the value associated with this file stored in clob_data_type_storage (Essentially upload a file using multipart/formdata Content-Type)

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

uuid

name

valueReference

display

links

uuid

name

valueReference

dataType

handler

handlerConfig

display

links

valueReference

name

dataType

handler

handlerConfig


valueReference

name

dataType

handler

handlerConfig

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
attributes
links
resourceVersion

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

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

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

LocationAttribute

URLs

url

description

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

Fetch by unique uuid

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

Fetch all non-retired

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

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

Not supported

Not supported

value
attributeType

value
attributeType

LocationAttributeType

URLs

url

description

GET /ws/rest/v1/locationattributetype

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

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

Fetch by unique uuid

POST /ws/rest/v1/locationattributetype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/locationattributetype/{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
minOccurs
maxOccurs
datatypeClassname
preferredHandlerClassname
retired
links
resourceVersion

uuid
display
name
description
minOccurs
maxOccurs
datatypeClassname
datatypeConfig
preferredHandlerClassname
handlerConfig
retired
auditInfo
links
resourceVersion

name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig

name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig

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

patient

orderType
concept

encounter

careSetting

orderReason

orderReasonNonCoded

instructions
startDate
autoExpireDate
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

orderType

encounter

careSetting

orderReason

orderReasonNonCoded

instructions
startDate
autoExpireDate
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 is a required attribute but the API infers this from the specified mapping  in the system so you shouldn't specify this.


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/hydratedObject
attributeType

value
attributeType

* Use "value" if the value being stored is a simple string such as phone numbers, citizenship e.t.c. On the other hand if value represents an OpenMRS Attributable domain object then use "hydratedObject" passing the uuid of the corresponding object. Examples of Attributable domain object are concepts and locations. Using "hydratedObject" enables the module to translate the value correctly into corresponding internal IDs, otherwise it will be served in the system as is without transformation which won't work during retrieval.

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

Provider

URLs

url

description

GET /ws/rest/v1/provider

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

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

Fetch by unique uuid

POST /ws/rest/v1/provider

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/provider/{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
identifier
attributes
retired
links
resourceVersion

uuid
display
person
identifier
attributes
retired
auditInfo
links
resourceVersion

person
identifier
attributes
retired

person
identifier
attributes
retired

ProviderAttribute

URLs

url

description

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

Fetch by unique uuid

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

Fetch all non-retired

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

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

Not supported

Not supported

value
attributeType

value
attributeType

ProviderAttributeType

URLs

url

description

GET /ws/rest/v1/providerattributetype

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

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

Fetch by unique uuid

POST /ws/rest/v1/providerattributetype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/providerattributetype/{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
minOccurs
maxOccurs
datatypeClassname
preferredHandlerClassname
retired
links
resourceVersion

uuid
display
name
description
minOccurs
maxOccurs
datatypeClassname
datatypeConfig
preferredHandlerClassname
handlerConfig
retired
auditInfo
links
resourceVersion

name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig

name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig

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

Visit

URLs

url

description

GET /ws/rest/v1/visit

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

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

Fetch by unique uuid

POST /ws/rest/v1/visit

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

Not supported

Not supported

Not supported

patient
visitType
startDatetime
location
indication
stopDatetime
encounters
attributes

visitType
startDatetime
location
indication
stopDatetime
encounters
attributes

VisitAttribute

URLs

url

description

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

Fetch by unique uuid

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

Fetch all non-retired

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

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Delete this object from the database

Representations

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

Not supported

Not supported

value
attributeType

value
attributeType

VisitAttributeType

URLs

url

description

GET /ws/rest/v1/visitattributetype

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

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

Fetch by unique uuid

POST /ws/rest/v1/visitattributetype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

DELETE /ws/rest/v1/visitattributetype/{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
minOccurs
maxOccurs
datatypeClassname
preferredHandlerClassname
retired
links
resourceVersion

uuid
display
name
description
minOccurs
maxOccurs
datatypeClassname
datatypeConfig
preferredHandlerClassname
handlerConfig
retired
auditInfo
links
resourceVersion

name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig

name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig

VisitType

URLs

url

description

GET /ws/rest/v1/visittype

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

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

Fetch by unique uuid

POST /ws/rest/v1/visittype

Create with properties in request

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

Edit with given uuid, only modifying properties in request

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

Retire/Void this object

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

Related pages

REST Web Services API For Clients
REST Web Services API For Clients
Documentation
Read with this
REST Module
REST Module
Documentation
Read with this
Adding a Web Service Step by Step Guide for Module Developers
Adding a Web Service Step by Step Guide for Module Developers
Documentation
Read with this
Adding a Web Service Step by Step Guide for Core Developers
Adding a Web Service Step by Step Guide for Core Developers
Documentation
Read with this
Getting Started as a Developer
Getting Started as a Developer
Documentation
Read with this