Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Adding expected parameter to clarify how to construct the correct REST resources!

...

url

description

GET /ws/rest/v1/cohort?q={searchString}

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/cohort

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

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

...

GET ref

GET default

GET full

POST create

POST update

display
links

display
patient
links
resourceVersion

display
patient
links
resourceVersion

patient

patient

...

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

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

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

names
datatype
conceptClass
descriptions
set
version
answers
setMembers

datatype
conceptClass
set
version
answers
setMembers
name

ConceptClass

URLs

url

description

GET /ws/rest/v1/conceptclass?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/conceptclass

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

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

Not supported

Not supported

...

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

Not supported

Not supported

...

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

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

Delete this object from the database

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

Delete this object from the database

...

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

Drug

URLs

url

description

GET /ws/rest/v1/drug?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/drug

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

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

Not supported

Not supported

...

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?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/encountertype

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

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?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/field

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

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

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

Not supported

Not supported

...

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

Not supported

Not supported

...

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

Not supported

Not supported

...

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

Not supported

Not supported

...

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

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

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

Not supported

Not supported

...

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

...

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?patient={patient-uuid}

Fetch all non-voided obs for a patient with the given uuid

GET /ws/rest/v1/obs?encounter={encounter-uuid}

Fetch all non-retired obs for an encounter with the given uuid

GET /ws/rest/v1/obs?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/obs

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

GET ref

GET default

GET full

POST create

POST update

uuid
display
links

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

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

person
obsDatetime
concept
location
order
encounter
value
accessionNumber
groupMembers
valueCodedName
comment

person
obsDatetime
concept
location
order
encounter
value
accessionNumber
groupMembers
valueCodedName
comment

Order

URLs

url

description

GET /ws/rest/v1/order?patient

Fetch all non-voided orders for the patient with the given uuid. Use type=(subtype) to limit to a particular subtype.

GET /ws/rest/v1/order?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/order

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

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

...

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
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

Patient

URLs

url

description

GET /ws/rest/v1/patient?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/patient

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/privilege

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

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

Role

...

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?q

Fetch all non-retired that match this parameter

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

Fetch by unique uuid

GET /ws/rest/v1/user

Fetch all non-retired

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

Delete this object from the database

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

Delete this object from the database

...

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