OpenMRS

OpenMRS API Docs v1.11.5

OpenMRS RESTful API documentation generated by Swagger

Overview

This document is a summary of the OpenMRS API as implemented by the REST Module. More details about how to develop an API client can be found on the OpenMRS wiki.

Authorization

Basic

The OpenMRS API uses HTTP basic access authentication with your OpenMRS username and password. For example:

curl -u admin:Admin123 -i 'http://localhost:8080/openmrs/ws/rest/v1/concept'

Resource Summary

activelisttype

Operation	Description
POST /activelisttype	Create with properties in request
GET /activelisttype	Fetch all non-retired
POST /activelisttype/{uuid}	Edit with given uuid, only modifying properties in request
GET /activelisttype/{uuid}	Fetch by unique uuid

allergy

Operation	Description
POST /allergy	Create with properties in request
GET /allergy	Fetch all non-retired
POST /allergy/{uuid}	Edit with given uuid, only modifying properties in request
GET /allergy/{uuid}	Fetch by unique uuid

conceptsource

Operation	Description
POST /conceptsource/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptsource/{uuid}	Fetch by unique uuid
POST /conceptsource	Create with properties in request
GET /conceptsource	Fetch all non-retired

customdatatype

Operation	Description
GET /customdatatype	Fetch all non-retired
GET /customdatatype/{uuid}/handlers	Subresource
GET /customdatatype/{uuid}	Fetch by unique uuid

drug

Operation	Description
GET /drug (Search by parameters: q,locale,exactLocale)	Allows you to search for drugs, it matches on drug names, concept names of the associated concepts or the concept reference term codes of the drug reference term mappings
POST /drug/{uuid}	Edit with given uuid, only modifying properties in request
GET /drug/{uuid}	Fetch by unique uuid
GET /drug (Search by parameters: source,code,preferredMapTypes)	Allows you to find drugs by source, code and preferred map types(comma delimited). Gets the best matching drug, i.e. matching the earliest ConceptMapType passed if there are multiple matches for the highest-priority ConceptMapType
POST /drug	Create with properties in request
GET /drug	Fetch all non-retired

DrugOrder

subtype of Order

Operation	Description
POST /DrugOrder	Create with properties in request

encounter

Operation	Description
GET /encounter (Search by parameters: patient,encounterType,todate,fromdate,order)	Allows you to find Encounter by patient and encounterType (and optionally by from and to date range)
POST /encounter/{uuid}	Edit with given uuid, only modifying properties in request
GET /encounter/{uuid}	Fetch by unique uuid
POST /encounter	Create with properties in request
GET /encounter	Fetch all non-retired
POST /encounter/{uuid}/encounterprovider	Subresource
GET /encounter/{uuid}/encounterprovider	Subresource

encounterrole

Operation	Description
POST /encounterrole	Create with properties in request
GET /encounterrole	Fetch all non-retired
POST /encounterrole/{uuid}	Edit with given uuid, only modifying properties in request
GET /encounterrole/{uuid}	Fetch by unique uuid

encountertype

Operation	Description
POST /encountertype	Create with properties in request
GET /encountertype	Fetch all non-retired
POST /encountertype/{uuid}	Edit with given uuid, only modifying properties in request
GET /encountertype/{uuid}	Fetch by unique uuid

field

Operation	Description
POST /field	Create with properties in request
GET /field	Fetch all non-retired
POST /field/{uuid}/answer	Subresource
GET /field/{uuid}/answer	Subresource
POST /field/{uuid}	Edit with given uuid, only modifying properties in request
GET /field/{uuid}	Fetch by unique uuid

fieldtype

Operation	Description
POST /fieldtype	Create with properties in request
GET /fieldtype	Fetch all non-retired
POST /fieldtype/{uuid}	Edit with given uuid, only modifying properties in request
GET /fieldtype/{uuid}	Fetch by unique uuid

form

Operation	Description
POST /form/{uuid}	Edit with given uuid, only modifying properties in request
GET /form/{uuid}	Fetch by unique uuid
POST /form/{uuid}/formfield	Subresource
GET /form/{uuid}/formfield	Subresource
POST /form/{uuid}/resource	Subresource
GET /form/{uuid}/resource	Subresource
POST /form	Create with properties in request

caresetting

Operation	Description
GET /caresetting	Fetch all non-retired
GET /caresetting/{uuid}	Fetch by unique uuid

hl7

Operation	Description
POST /hl7/{uuid}	Edit with given uuid, only modifying properties in request
GET /hl7/{uuid}	Fetch by unique uuid
POST /hl7	Create with properties in request
GET /hl7	Fetch all non-retired

hl7source

Operation	Description
POST /hl7source	Create with properties in request
GET /hl7source	Fetch all non-retired
POST /hl7source/{uuid}	Edit with given uuid, only modifying properties in request
GET /hl7source/{uuid}	Fetch by unique uuid

location

Operation	Description
POST /location	Create with properties in request
GET /location	Fetch all non-retired
GET /location (Search by parameters: tag)	Allows you to find locations by tag uuid or tag name
POST /location/{uuid}	Edit with given uuid, only modifying properties in request
POST /location/{uuid}/attribute	Subresource

locationattributetype

Operation	Description
POST /locationattributetype	Create with properties in request
GET /locationattributetype	Fetch all non-retired
POST /locationattributetype/{uuid}	Edit with given uuid, only modifying properties in request
GET /locationattributetype/{uuid}	Fetch by unique uuid

locationtag

Operation	Description
POST /locationtag/{uuid}	Edit with given uuid, only modifying properties in request
GET /locationtag/{uuid}	Fetch by unique uuid
POST /locationtag	Create with properties in request
GET /locationtag	Fetch all non-retired

obs

Operation	Description
POST /obs/{uuid}	Edit with given uuid, only modifying properties in request
GET /obs/{uuid}	Fetch by unique uuid
POST /obs	Create with properties in request
GET /obs	Fetch all non-retired
GET /obs (Search by parameters: patient,concept)	Allows you to find Observations by patient and concept

order

Operation	Description
GET /order/{uuid}	Fetch by unique uuid
POST /order	Create with properties in request
GET /order	Fetch all non-retired

orderfrequency

Operation	Description
POST /orderfrequency	Create with properties in request
GET /orderfrequency	Fetch all non-retired
POST /orderfrequency/{uuid}	Edit with given uuid, only modifying properties in request
GET /orderfrequency/{uuid}	Fetch by unique uuid

ordertype

Operation	Description
POST /ordertype	Create with properties in request
GET /ordertype	Fetch all non-retired
POST /ordertype/{uuid}	Edit with given uuid, only modifying properties in request
GET /ordertype/{uuid}	Fetch by unique uuid

patient

Operation	Description
GET /patient (Search by parameters: identifier)	Allows you to find Patients by identifier
POST /patient/{uuid}/identifier	Subresource
GET /patient/{uuid}/identifier	Subresource
POST /patient/{uuid}	Edit with given uuid, only modifying properties in request
GET /patient/{uuid}	Fetch by unique uuid
POST /patient	Create with properties in request
GET /patient	Fetch all non-retired

cohort

Operation	Description
POST /cohort/{uuid}/member	Subresource
GET /cohort/{uuid}/member	Subresource
POST /cohort	Create with properties in request
GET /cohort	Fetch all non-retired
POST /cohort/{uuid}	Edit with given uuid, only modifying properties in request
GET /cohort/{uuid}	Fetch by unique uuid

patientidentifiertype

Operation	Description
POST /patientidentifiertype	Create with properties in request
GET /patientidentifiertype	Fetch all non-retired
POST /patientidentifiertype/{uuid}	Edit with given uuid, only modifying properties in request
GET /patientidentifiertype/{uuid}	Fetch by unique uuid

person

Operation	Description
POST /person/{uuid}/name	Subresource
GET /person/{uuid}/name	Subresource
POST /person/{uuid}/address	Subresource
GET /person/{uuid}/address	Subresource
POST /person/{uuid}/attribute	Subresource
GET /person/{uuid}/attribute	Subresource
POST /person	Create with properties in request
GET /person	Fetch all non-retired
POST /person/{uuid}	Edit with given uuid, only modifying properties in request
GET /person/{uuid}	Fetch by unique uuid

personattributetype

Operation	Description
POST /personattributetype	Create with properties in request
GET /personattributetype	Fetch all non-retired
POST /personattributetype/{uuid}	Edit with given uuid, only modifying properties in request
GET /personattributetype/{uuid}	Fetch by unique uuid

privilege

Operation	Description
POST /privilege	Create with properties in request
GET /privilege	Fetch all non-retired
POST /privilege/{uuid}	Edit with given uuid, only modifying properties in request
GET /privilege/{uuid}	Fetch by unique uuid

problem

Operation	Description
POST /problem/{uuid}	Edit with given uuid, only modifying properties in request
GET /problem/{uuid}	Fetch by unique uuid
POST /problem	Create with properties in request
GET /problem	Fetch all non-retired

program

Operation	Description
POST /program/{uuid}	Edit with given uuid, only modifying properties in request
GET /program/{uuid}	Fetch by unique uuid
POST /program	Create with properties in request
GET /program	Fetch all non-retired

programenrollment

Operation	Description
POST /programenrollment/{uuid}	Edit with given uuid, only modifying properties in request
GET /programenrollment/{uuid}	Fetch by unique uuid
POST /programenrollment	Create with properties in request
POST /programenrollment/{uuid}/state	Subresource
GET /programenrollment/{uuid}/state	Subresource

provider

Operation	Description
POST /provider	Create with properties in request
GET /provider	Fetch all non-retired
GET /provider (Search by parameters: user)	Allows you to find providers by user uuid
POST /provider/{uuid}	Edit with given uuid, only modifying properties in request
POST /provider/{uuid}/attribute	Subresource

providerattributetype

Operation	Description
POST /providerattributetype/{uuid}	Edit with given uuid, only modifying properties in request
GET /providerattributetype/{uuid}	Fetch by unique uuid
POST /providerattributetype	Create with properties in request
GET /providerattributetype	Fetch all non-retired

relationship

Operation	Description
GET /relationship (Search by parameters: personA,relation)	Allows you to find relationships of personA of given relationship type
POST /relationship/{uuid}	Edit with given uuid, only modifying properties in request
GET /relationship (Search by parameters: person,relatedPerson)	Allows you to find relationships between two persons by specifying their uuids
GET /relationship (Search by parameters: personB,personA,relation)	Allows you to find relationships between personA and personB given relationship type
GET /relationship (Search by parameters: personB,personA)	Allows you to find relationships between personA and personB
POST /relationship	Create with properties in request
GET /relationship (Search by parameters: person,relation)	Allows you to find relationships where person is related to other by type of relationship
GET /relationship (Search by parameters: personB,relation)	Allows you to find relationships of personB of given relationship type
GET /relationship (Search by parameters: person)	Allows you to find relationship by person uuid

concept

Operation	Description
GET /concept (Search by parameters: source,code)	Allows you to find concepts by source and code
POST /concept/{uuid}/mapping	Subresource
GET /concept/{uuid}/mapping	Subresource
POST /concept/{uuid}/description	Subresource
GET /concept/{uuid}/description	Subresource
POST /concept	Create with properties in request
GET /concept	Fetch all non-retired
GET /concept (Search by parameters: term)	Allows you to find concepts which map to term, uuid of term given as input
GET /concept (Search by parameters: name)	Allows you to find concepts by name
POST /concept/{uuid}	Edit with given uuid, only modifying properties in request
GET /concept/{uuid}	Fetch by unique uuid
POST /concept/{uuid}/name	Subresource
GET /concept/{uuid}/name	Subresource

relationshiptype

Operation	Description
POST /relationshiptype	Create with properties in request
GET /relationshiptype	Fetch all non-retired
POST /relationshiptype/{uuid}	Edit with given uuid, only modifying properties in request
GET /relationshiptype/{uuid}	Fetch by unique uuid

role

Operation	Description
POST /role/{uuid}	Edit with given uuid, only modifying properties in request
GET /role/{uuid}	Fetch by unique uuid
POST /role	Create with properties in request
GET /role	Fetch all non-retired

systemsetting

Operation	Description
POST /systemsetting	Create with properties in request
GET /systemsetting	Fetch all non-retired
POST /systemsetting/{uuid}	Edit with given uuid, only modifying properties in request
GET /systemsetting/{uuid}	Fetch by unique uuid

TestOrder

subtype of Order

Operation	Description
POST /TestOrder	Create with properties in request

user

Operation	Description
POST /user/{uuid}	Edit with given uuid, only modifying properties in request
GET /user/{uuid}	Fetch by unique uuid
POST /user	Create with properties in request
GET /user	Fetch all non-retired
GET /user (Search by parameters: username)	Allows you to find users by username

visit

Operation	Description
POST /visit/{uuid}/attribute	Subresource
POST /visit	Create with properties in request
POST /visit/{uuid}	Edit with given uuid, only modifying properties in request

visitattributetype

Operation	Description
POST /visitattributetype	Create with properties in request
GET /visitattributetype	Fetch all non-retired
POST /visitattributetype/{uuid}	Edit with given uuid, only modifying properties in request
GET /visitattributetype/{uuid}	Fetch by unique uuid

visittype

Operation	Description
POST /visittype	Create with properties in request
GET /visittype	Fetch all non-retired
POST /visittype/{uuid}	Edit with given uuid, only modifying properties in request
GET /visittype/{uuid}	Fetch by unique uuid

workflow

Operation	Description
GET /workflow/{uuid}	Fetch by unique uuid
POST /workflow	Create with properties in request
GET /workflow	Fetch all non-retired
GET /workflow/{uuid}//state	Subresource

conceptclass

Operation	Description
POST /conceptclass/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptclass/{uuid}	Fetch by unique uuid
POST /conceptclass	Create with properties in request
GET /conceptclass	Fetch all non-retired

conceptdatatype

Operation	Description
POST /conceptdatatype/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptdatatype/{uuid}	Fetch by unique uuid
POST /conceptdatatype	Create with properties in request
GET /conceptdatatype	Fetch all non-retired

conceptmaptype

Operation	Description
POST /conceptmaptype	Create with properties in request
GET /conceptmaptype	Fetch all non-retired
POST /conceptmaptype/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptmaptype/{uuid}	Fetch by unique uuid

conceptreferenceterm

Operation	Description
GET /conceptreferenceterm (Search by parameters: source,code,name)	Allows you to find terms by source, code and name
POST /conceptreferenceterm	Create with properties in request
GET /conceptreferenceterm	Fetch all non-retired
POST /conceptreferenceterm/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptreferenceterm/{uuid}	Fetch by unique uuid

conceptreferencetermmap

Operation	Description
GET /conceptreferencetermmap (Search by parameters: maps,maptype)	Allows you to find term maps by reference 'maps' (termA or termB uuid) and 'maptype' (uuid or name)
GET /conceptreferencetermmap (Search by parameters: termA,maptype)	Allows you to find term maps by reference 'termA' (uuid) and 'maptype' (uuid or name)
GET /conceptreferencetermmap (Search by parameters: termB,maptype)	Allows you to find term maps by reference 'termB' (uuid) and 'maptype' (uuid or name)
POST /conceptreferencetermmap	Create with properties in request
GET /conceptreferencetermmap	Fetch all non-retired
POST /conceptreferencetermmap/{uuid}	Edit with given uuid, only modifying properties in request
GET /conceptreferencetermmap/{uuid}	Fetch by unique uuid
GET /conceptreferencetermmap (Search by parameters: maps,to)	Allows you to find term maps by reference 'maps' (termA uuid) and 'to' (termB uuid)

Paths

Fetch all non-retired

GET /activelisttype

Resource: activelisttype

application/json

200 OK: activelisttype response

activelisttype

Create with properties in request

POST /activelisttype

Resource: activelisttype

Uses default content-types: application/json

Parameters: name(required) description(optional)

application/json

200 OK: activelisttype response

activelisttypecreateInput

Fetch by unique uuid

GET /activelisttype/{uuid}

Resource: activelisttype


uuid	uuid to filter by	path	string

application/json

200 OK: activelisttype response

activelisttype

Edit with given uuid, only modifying properties in request

POST /activelisttype/{uuid}

Resource: activelisttype

Uses default content-types: application/json

Parameters: name(required) description(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: activelisttype response

activelisttypeupdateInput

Fetch all non-retired

GET /allergy

Resource: allergy

application/json

200 OK: allergy response

allergy

Create with properties in request

POST /allergy

Resource: allergy

Uses default content-types: application/json

Parameters: person(required) startDate(required) comments(optional) startObs(optional) stopObs(optional) allergyType(required) allergen(required) reaction(optional) severity(optional)

application/json

200 OK: allergy response

allergycreateInput

Fetch by unique uuid

GET /allergy/{uuid}

Resource: allergy


uuid	uuid to filter by	path	string

application/json

200 OK: allergy response

allergy

Edit with given uuid, only modifying properties in request

POST /allergy/{uuid}

Resource: allergy

Uses default content-types: application/json

Parameters: person(required) startDate(required) comments(optional) startObs(optional) stopObs(optional) allergyType(required) allergen(required) reaction(optional) severity(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: allergy response

allergyupdateInput

Fetch all non-retired

GET /caresetting

Resource: caresetting

application/json

200 OK: caresetting response

caresetting

Fetch by unique uuid

GET /caresetting/{uuid}

Resource: caresetting


uuid	uuid to filter by	path	string

application/json

200 OK: caresetting response

caresetting

Fetch all non-retired

GET /cohort

Resource: cohort

application/json

200 OK: cohort response

cohort

Create with properties in request

POST /cohort

Resource: cohort

Uses default content-types: application/json

Parameters: name(required) description(required) memberIds(required)

application/json

200 OK: cohort response

cohortcreateInput

Fetch by unique uuid

GET /cohort/{uuid}

Resource: cohort


uuid	uuid to filter by	path	string

application/json

200 OK: cohort response

cohort

Edit with given uuid, only modifying properties in request

POST /cohort/{uuid}

Resource: cohort

Uses default content-types: application/json

Parameters: patient(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: cohort response

cohortupdateInput

Subresource

GET /cohort/{uuid}/member

Resource: cohort


uuid	uuid to filter by	path	string

application/json

200 OK: cohort response

Subresource

POST /cohort/{uuid}/member

Resource: cohort

Uses default content-types: application/json

Parameters: patient(required)


uuid	uuid to filter by	path	string

application/json

200 OK: cohort response

Fetch all non-retired

GET /concept

Resource: concept

application/json

200 OK: concept response

concept

Create with properties in request

POST /concept

Resource: concept

Uses default content-types: application/json

Parameters: names(required) datatype(required) conceptClass(required) descriptions(optional) set(optional) version(optional) mappings(optional) answers(optional) setMembers(optional)

application/json

200 OK: concept response

conceptcreateInput

Allows you to find concepts by name

GET /concept (Search by parameters: name)

Resource: concept

Allows you to find concepts by name


name		query	string

application/json

200 OK: concept response

concept

Allows you to find concepts by source and code

GET /concept (Search by parameters: source,code)

Resource: concept

Allows you to find concepts by source and code


source		query	string
code		query	string

application/json

200 OK: concept response

concept

Allows you to find concepts which map to term, uuid of term given as input

GET /concept (Search by parameters: term)

Resource: concept

Allows you to find concepts which map to term, uuid of term given as input


term		query	string

application/json

200 OK: concept response

concept

Fetch by unique uuid

GET /concept/{uuid}

Resource: concept


uuid	uuid to filter by	path	string

application/json

200 OK: concept response

concept

Edit with given uuid, only modifying properties in request

POST /concept/{uuid}

Resource: concept

Uses default content-types: application/json

Parameters: conceptReferenceTerm(required) conceptMapType(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: concept response

conceptupdateInput

Subresource

GET /concept/{uuid}/description

Resource: concept


uuid	uuid to filter by	path	string

application/json

200 OK: concept response

Subresource

POST /concept/{uuid}/description

Resource: concept

Uses default content-types: application/json

Parameters: description(required) locale(required)


uuid	uuid to filter by	path	string

application/json

200 OK: concept response

Subresource

GET /concept/{uuid}/mapping

Resource: concept


uuid	uuid to filter by	path	string

application/json

200 OK: concept response

Subresource

POST /concept/{uuid}/mapping

Resource: concept

Uses default content-types: application/json

Parameters: conceptReferenceTerm(required) conceptMapType(required)


uuid	uuid to filter by	path	string

application/json

200 OK: concept response

Subresource

GET /concept/{uuid}/name

Resource: concept


uuid	uuid to filter by	path	string

application/json

200 OK: concept response

Subresource

POST /concept/{uuid}/name

Resource: concept

Uses default content-types: application/json

Parameters: name(required) locale(required) localePreferred(optional) conceptNameType(optional)


uuid	uuid to filter by	path	string

application/json

200 OK: concept response

Fetch all non-retired

GET /conceptclass

Resource: conceptclass

application/json

200 OK: conceptclass response

conceptclass

Create with properties in request

POST /conceptclass

Resource: conceptclass

Uses default content-types: application/json

Parameters: name(required) description(optional)

application/json

200 OK: conceptclass response

conceptclasscreateInput

Fetch by unique uuid

GET /conceptclass/{uuid}

Resource: conceptclass


uuid	uuid to filter by	path	string

application/json

200 OK: conceptclass response

conceptclass

Edit with given uuid, only modifying properties in request

POST /conceptclass/{uuid}

Resource: conceptclass

Uses default content-types: application/json

Parameters: name(required) description(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: conceptclass response

conceptclassupdateInput

Fetch all non-retired

GET /conceptdatatype

Resource: conceptdatatype

application/json

200 OK: conceptdatatype response

conceptdatatype

Create with properties in request

POST /conceptdatatype

Resource: conceptdatatype

Uses default content-types: application/json

Parameters: name(required) description(optional)

application/json

200 OK: conceptdatatype response

conceptdatatypecreateInput

Fetch by unique uuid

GET /conceptdatatype/{uuid}

Resource: conceptdatatype


uuid	uuid to filter by	path	string

application/json

200 OK: conceptdatatype response

conceptdatatype

Edit with given uuid, only modifying properties in request

POST /conceptdatatype/{uuid}

Resource: conceptdatatype

Uses default content-types: application/json

Parameters: name(required) description(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: conceptdatatype response

conceptdatatypeupdateInput

Fetch all non-retired

GET /conceptmaptype

Resource: conceptmaptype

application/json

200 OK: conceptmaptype response

conceptmaptype

Create with properties in request

POST /conceptmaptype

Resource: conceptmaptype

Uses default content-types: application/json

Parameters: name(required) description(optional) isHidden(optional)

application/json

200 OK: conceptmaptype response

conceptmaptypecreateInput

Fetch by unique uuid

GET /conceptmaptype/{uuid}

Resource: conceptmaptype


uuid	uuid to filter by	path	string

application/json

200 OK: conceptmaptype response

conceptmaptype

Edit with given uuid, only modifying properties in request

POST /conceptmaptype/{uuid}

Resource: conceptmaptype

Uses default content-types: application/json

Parameters: name(required) description(optional) isHidden(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: conceptmaptype response

conceptmaptypeupdateInput

Fetch all non-retired

GET /conceptreferenceterm

Resource: conceptreferenceterm

application/json

200 OK: conceptreferenceterm response

conceptreferenceterm

Create with properties in request

POST /conceptreferenceterm

Resource: conceptreferenceterm

Uses default content-types: application/json

Parameters: code(required) conceptSource(required) name(optional) description(optional) version(optional)

application/json

200 OK: conceptreferenceterm response

conceptreferencetermcreateInput

Allows you to find terms by source, code and name

GET /conceptreferenceterm (Search by parameters: source,code,name)

Resource: conceptreferenceterm

Allows you to find terms by source, code and name


source	query	string
code	query	string
name	query	string

application/json

200 OK: conceptreferenceterm response

conceptreferenceterm

Fetch by unique uuid

GET /conceptreferenceterm/{uuid}

Resource: conceptreferenceterm


uuid	uuid to filter by	path	string

application/json

200 OK: conceptreferenceterm response

conceptreferenceterm

Edit with given uuid, only modifying properties in request

POST /conceptreferenceterm/{uuid}

Resource: conceptreferenceterm

Uses default content-types: application/json

Parameters: code(required) conceptSource(required) name(optional) description(optional) version(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: conceptreferenceterm response

conceptreferencetermupdateInput

Fetch all non-retired

GET /conceptreferencetermmap

Resource: conceptreferencetermmap

application/json

200 OK: conceptreferencetermmap response

conceptreferencetermmap

Create with properties in request

POST /conceptreferencetermmap

Resource: conceptreferencetermmap

Uses default content-types: application/json

Parameters: termA(required) termB(required) conceptMapType(required)

application/json

200 OK: conceptreferencetermmap response

conceptreferencetermmapcreateInput

Allows you to find term maps by reference 'maps' (termA or termB uuid) and 'maptype' (uuid or name)

GET /conceptreferencetermmap (Search by parameters: maps,maptype)

Resource: conceptreferencetermmap

Allows you to find term maps by reference 'maps' (termA or termB uuid) and 'maptype' (uuid or name)


maps		query	string
maptype		query	string

application/json

200 OK: conceptreferencetermmap response

conceptreferencetermmap

Allows you to find term maps by reference 'maps' (termA uuid) and 'to' (termB uuid)

GET /conceptreferencetermmap (Search by parameters: maps,to)

Resource: conceptreferencetermmap

Allows you to find term maps by reference 'maps' (termA uuid) and 'to' (termB uuid)


maps		query	string
to		query	string

application/json

200 OK: conceptreferencetermmap response

conceptreferencetermmap

Allows you to find term maps by reference 'termA' (uuid) and 'maptype' (uuid or name)

GET /conceptreferencetermmap (Search by parameters: termA,maptype)

Resource: conceptreferencetermmap

Allows you to find term maps by reference 'termA' (uuid) and 'maptype' (uuid or name)


termA		query	string
maptype		query	string

application/json

200 OK: conceptreferencetermmap response

conceptreferencetermmap

Allows you to find term maps by reference 'termB' (uuid) and 'maptype' (uuid or name)

GET /conceptreferencetermmap (Search by parameters: termB,maptype)

Resource: conceptreferencetermmap

Allows you to find term maps by reference 'termB' (uuid) and 'maptype' (uuid or name)


termB		query	string
maptype		query	string

application/json

200 OK: conceptreferencetermmap response

conceptreferencetermmap

Fetch by unique uuid

GET /conceptreferencetermmap/{uuid}

Resource: conceptreferencetermmap


uuid	uuid to filter by	path	string

application/json

200 OK: conceptreferencetermmap response

conceptreferencetermmap

Edit with given uuid, only modifying properties in request

POST /conceptreferencetermmap/{uuid}

Resource: conceptreferencetermmap

Uses default content-types: application/json

Parameters: termA(required) termB(required) conceptMapType(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: conceptreferencetermmap response

conceptreferencetermmapupdateInput

Fetch all non-retired

GET /conceptsource

Resource: conceptsource

application/json

200 OK: conceptsource response

conceptsource

Create with properties in request

POST /conceptsource

Resource: conceptsource

Uses default content-types: application/json

Parameters: name(required) description(required) hl7Code(optional)

application/json

200 OK: conceptsource response

conceptsourcecreateInput

Fetch by unique uuid

GET /conceptsource/{uuid}

Resource: conceptsource


uuid	uuid to filter by	path	string

application/json

200 OK: conceptsource response

conceptsource

Edit with given uuid, only modifying properties in request

POST /conceptsource/{uuid}

Resource: conceptsource

Uses default content-types: application/json

Parameters: name(required) description(required) hl7Code(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: conceptsource response

conceptsourceupdateInput

Fetch all non-retired

GET /customdatatype

Resource: customdatatype

application/json

200 OK: customdatatype response

customdatatype

Fetch by unique uuid

GET /customdatatype/{uuid}

Resource: customdatatype


uuid	uuid to filter by	path	string

application/json

200 OK: customdatatype response

customdatatype

Subresource

GET /customdatatype/{uuid}/handlers

Resource: customdatatype


uuid	uuid to filter by	path	string

application/json

200 OK: customdatatype response

Fetch all non-retired

GET /drug

Resource: drug

application/json

200 OK: drug response

drug

Create with properties in request

POST /drug

Resource: drug

Uses default content-types: application/json

Parameters: name(optional) description(optional) combination(required) concept(required) doseStrength(optional) maximumDailyDose(optional) minimumDailyDose(optional) units(optional) dosageForm(optional) route(optional)

application/json

200 OK: drug response

drugcreateInput

Allows you to search for drugs, it matches on drug names, concept names of the associated concepts or the concept reference term codes of the drug reference term mappings

GET /drug (Search by parameters: q,locale,exactLocale)

Resource: drug

Allows you to search for drugs, it matches on drug names, concept names of the associated concepts or the concept reference term codes of the drug reference term mappings


q	query	string
locale	query	string
exactLocale	query	string

application/json

200 OK: drug response

drug

Allows you to find drugs by source, code and preferred map types(comma delimited). Gets the best matching drug, i.e. matching the earliest ConceptMapType passed if there are multiple matches for the highest-priority ConceptMapType

GET /drug (Search by parameters: source,code,preferredMapTypes)

Resource: drug


source	query	string
code	query	string
preferredMapTypes	query	string

application/json

200 OK: drug response

drug

Fetch by unique uuid

GET /drug/{uuid}

Resource: drug


uuid	uuid to filter by	path	string

application/json

200 OK: drug response

drug

Edit with given uuid, only modifying properties in request

POST /drug/{uuid}

Resource: drug

Uses default content-types: application/json


uuid	uuid of the resource to update	path	string

application/json

200 OK: drug response

drugupdateInput

Create with properties in request

POST /DrugOrder

Resource: DrugOrder

Uses default content-types: application/json

Parameters: encounter(required) action(optional) dateActivated(optional) patient(optional) concept(optional) careSetting(optional) dateStopped(optional) autoExpireDate(optional) orderer(optional) previousOrder(optional) urgency(optional) orderReason(optional) orderReasonNonCoded(optional) instructions(optional) commentToFulfiller(optional) drug(optional) dosingType(optional) dose(optional) doseUnits(optional) frequency(optional) asNeeded(optional) asNeededCondition(optional) quantity(optional) quantityUnits(optional) numRefills(optional) administrationInstructions(optional) dosingInstructions(optional) duration(optional) durationUnits(optional) route(optional) brandName(optional) dispenseAsWritten(optional)

application/json

200 OK: DrugOrder response

DrugOrdercreateInput

Fetch all non-retired

GET /encounter

Resource: encounter

application/json

200 OK: encounter response

encounter

Create with properties in request

POST /encounter

Resource: encounter

Uses default content-types: application/json

Parameters: encounterDatetime(optional) patient(required) encounterType(required) location(optional) form(optional) provider(optional) orders(optional) obs(optional) visit(optional) encounterProviders(optional)

application/json

200 OK: encounter response

encountercreateInput

Allows you to find Encounter by patient and encounterType (and optionally by from and to date range)

GET /encounter (Search by parameters: patient,encounterType,todate,fromdate,order)

Resource: encounter

Allows you to find Encounter by patient and encounterType (and optionally by from and to date range)


patient	query	string
encounterType	query	string
todate	query	string
fromdate	query	string
order	query	string

application/json

200 OK: encounter response

encounter

Fetch by unique uuid

GET /encounter/{uuid}

Resource: encounter


uuid	uuid to filter by	path	string

application/json

200 OK: encounter response

encounter

Edit with given uuid, only modifying properties in request

POST /encounter/{uuid}

Resource: encounter

Uses default content-types: application/json

Parameters: encounterRole(optional) voided(optional) voidReason(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: encounter response

encounterupdateInput

Subresource

GET /encounter/{uuid}/encounterprovider

Resource: encounter


uuid	uuid to filter by	path	string

application/json

200 OK: encounter response

Subresource

POST /encounter/{uuid}/encounterprovider

Resource: encounter

Uses default content-types: application/json

Parameters: provider(optional) encounter(optional) encounterRole(optional)


uuid	uuid to filter by	path	string

application/json

200 OK: encounter response

Fetch all non-retired

GET /encounterrole

Resource: encounterrole

application/json

200 OK: encounterrole response

encounterrole

Create with properties in request

POST /encounterrole

Resource: encounterrole

Uses default content-types: application/json

Parameters: name(required) description(required)

application/json

200 OK: encounterrole response

encounterrolecreateInput

Fetch by unique uuid

GET /encounterrole/{uuid}

Resource: encounterrole


uuid	uuid to filter by	path	string

application/json

200 OK: encounterrole response

encounterrole

Edit with given uuid, only modifying properties in request

POST /encounterrole/{uuid}

Resource: encounterrole

Uses default content-types: application/json

Parameters: name(required) description(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: encounterrole response

encounterroleupdateInput

Fetch all non-retired

GET /encountertype

Resource: encountertype

application/json

200 OK: encountertype response

encountertype

Create with properties in request

POST /encountertype

Resource: encountertype

Uses default content-types: application/json

Parameters: name(required) description(required)

application/json

200 OK: encountertype response

encountertypecreateInput

Fetch by unique uuid

GET /encountertype/{uuid}

Resource: encountertype


uuid	uuid to filter by	path	string

application/json

200 OK: encountertype response

encountertype

Edit with given uuid, only modifying properties in request

POST /encountertype/{uuid}

Resource: encountertype

Uses default content-types: application/json

Parameters: name(required) description(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: encountertype response

encountertypeupdateInput

Fetch all non-retired

GET /field

Resource: field

application/json

200 OK: field response

field

Create with properties in request

POST /field

Resource: field

Uses default content-types: application/json

Parameters: name(required) description(optional) fieldType(required) selectMultiple(required) concept(optional) tableName(optional) attributeName(optional) defaultValue(optional)

application/json

200 OK: field response

fieldcreateInput

Fetch by unique uuid

GET /field/{uuid}

Resource: field


uuid	uuid to filter by	path	string

application/json

200 OK: field response

field

Edit with given uuid, only modifying properties in request

POST /field/{uuid}

Resource: field

Uses default content-types: application/json

Parameters: field(required) concept(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: field response

fieldupdateInput

Subresource

GET /field/{uuid}/answer

Resource: field


uuid	uuid to filter by	path	string

application/json

200 OK: field response

Subresource

POST /field/{uuid}/answer

Resource: field

Uses default content-types: application/json

Parameters: field(required) concept(required)


uuid	uuid to filter by	path	string

application/json

200 OK: field response

Fetch all non-retired

GET /fieldtype

Resource: fieldtype

application/json

200 OK: fieldtype response

fieldtype

Create with properties in request

POST /fieldtype

Resource: fieldtype

Uses default content-types: application/json

Parameters: name(required) description(optional)

application/json

200 OK: fieldtype response

fieldtypecreateInput

Fetch by unique uuid

GET /fieldtype/{uuid}

Resource: fieldtype


uuid	uuid to filter by	path	string

application/json

200 OK: fieldtype response

fieldtype

Edit with given uuid, only modifying properties in request

POST /fieldtype/{uuid}

Resource: fieldtype

Uses default content-types: application/json

Parameters: name(required) description(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: fieldtype response

fieldtypeupdateInput

Create with properties in request

POST /form

Resource: form

Uses default content-types: application/json

Parameters: name(required) description(optional) version(required) encounterType(optional) build(optional) published(optional) formFields(optional) xslt(optional) template(optional)

application/json

200 OK: form response

formcreateInput

Fetch by unique uuid

GET /form/{uuid}

Resource: form


uuid	uuid to filter by	path	string

application/json

200 OK: form response

form

Edit with given uuid, only modifying properties in request

POST /form/{uuid}

Resource: form

Uses default content-types: application/json

Parameters: form(optional) name(optional) dataType(optional) handler(optional) handlerConfig(optional) value(optional) valueReference(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: form response

formupdateInput

Subresource

GET /form/{uuid}/formfield

Resource: form


uuid	uuid to filter by	path	string

application/json

200 OK: form response

Subresource

POST /form/{uuid}/formfield

Resource: form

Uses default content-types: application/json

Parameters: form(required) field(required) required(required) parent(optional) fieldNumber(optional) fieldPart(optional) pageNumber(optional) minOccurs(optional) maxOccurs(optional) sortWeight(optional)


uuid	uuid to filter by	path	string

application/json

200 OK: form response

Subresource

GET /form/{uuid}/resource

Resource: form


uuid	uuid to filter by	path	string

application/json

200 OK: form response

Subresource

POST /form/{uuid}/resource

Resource: form

Uses default content-types: application/json

Parameters: form(optional) name(optional) dataType(optional) handler(optional) handlerConfig(optional) value(optional) valueReference(optional)


uuid	uuid to filter by	path	string

application/json

200 OK: form response

Fetch all non-retired

GET /hl7

Resource: hl7

application/json

200 OK: hl7 response

hl7

Create with properties in request

POST /hl7

Resource: hl7

Uses default content-types: application/json

Parameters: hl7(required)

application/json

200 OK: hl7 response

hl7createInput

Fetch by unique uuid

GET /hl7/{uuid}

Resource: hl7


uuid	uuid to filter by	path	string

application/json

200 OK: hl7 response

hl7

Edit with given uuid, only modifying properties in request

POST /hl7/{uuid}

Resource: hl7

Uses default content-types: application/json

Parameters: hl7(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: hl7 response

hl7updateInput

Fetch all non-retired

GET /hl7source

Resource: hl7source

application/json

200 OK: hl7source response

hl7source

Create with properties in request

POST /hl7source

Resource: hl7source

Uses default content-types: application/json

Parameters: name(required) description(required)

application/json

200 OK: hl7source response

hl7sourcecreateInput

Fetch by unique uuid

GET /hl7source/{uuid}

Resource: hl7source


uuid	uuid to filter by	path	string

application/json

200 OK: hl7source response

hl7source

Edit with given uuid, only modifying properties in request

POST /hl7source/{uuid}

Resource: hl7source

Uses default content-types: application/json

Parameters: name(required) description(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: hl7source response

hl7sourceupdateInput

Fetch all non-retired

GET /location

Resource: location

application/json

200 OK: location response

location

Create with properties in request

POST /location

Resource: location

Uses default content-types: application/json

Parameters: name(required) description(optional) address1(optional) address2(optional) cityVillage(optional) stateProvince(optional) country(optional) postalCode(optional) latitude(optional) longitude(optional) countyDistrict(optional) address3(optional) address4(optional) address5(optional) address6(optional) tags(optional) parentLocation(optional) childLocations(optional) attributes(optional)

application/json

200 OK: location response

locationcreateInput

Allows you to find locations by tag uuid or tag name

GET /location (Search by parameters: tag)

Resource: location

Allows you to find locations by tag uuid or tag name


tag		query	string

application/json

200 OK: location response

location

Edit with given uuid, only modifying properties in request

POST /location/{uuid}

Resource: location

Uses default content-types: application/json

Parameters: attributeType(required) value(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: location response

locationupdateInput

Subresource

POST /location/{uuid}/attribute

Resource: location

Uses default content-types: application/json

Parameters: attributeType(required) value(required)


uuid	uuid to filter by	path	string

application/json

200 OK: location response

Fetch all non-retired

GET /locationattributetype

Resource: locationattributetype

application/json

200 OK: locationattributetype response

locationattributetype

Create with properties in request

POST /locationattributetype

Resource: locationattributetype

Uses default content-types: application/json

Parameters: name(required) datatypeClassname(required) description(optional) minOccurs(optional) maxOccurs(optional) datatypeConfig(optional) preferredHandlerClassname(optional) handlerConfig(optional)

application/json

200 OK: locationattributetype response

locationattributetypecreateInput

Fetch by unique uuid

GET /locationattributetype/{uuid}

Resource: locationattributetype


uuid	uuid to filter by	path	string

application/json

200 OK: locationattributetype response

locationattributetype

Edit with given uuid, only modifying properties in request

POST /locationattributetype/{uuid}

Resource: locationattributetype

Uses default content-types: application/json


uuid	uuid of the resource to update	path	string

application/json

200 OK: locationattributetype response

locationattributetypeupdateInput

Fetch all non-retired

GET /locationtag

Resource: locationtag

application/json

200 OK: locationtag response

locationtag

Create with properties in request

POST /locationtag

Resource: locationtag

Uses default content-types: application/json

Parameters: name(required) description(optional) retired(optional) retireReason(optional)

application/json

200 OK: locationtag response

locationtagcreateInput

Fetch by unique uuid

GET /locationtag/{uuid}

Resource: locationtag


uuid	uuid to filter by	path	string

application/json

200 OK: locationtag response

locationtag

Edit with given uuid, only modifying properties in request

POST /locationtag/{uuid}

Resource: locationtag

Uses default content-types: application/json

Parameters: name(required) description(optional) retired(optional) retireReason(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: locationtag response

locationtagupdateInput

Fetch all non-retired

GET /obs

Resource: obs

application/json

200 OK: obs response

obs

Create with properties in request

POST /obs

Resource: obs

Uses default content-types: application/json

Parameters: person(required) obsDatetime(required) concept(required) location(optional) order(optional) encounter(optional) accessionNumber(optional) groupMembers(optional) valueCodedName(optional) comment(optional) value(optional) valueModifier(optional) formFieldPath(optional) formFieldNamespace(optional)

application/json

200 OK: obs response

obscreateInput

Allows you to find Observations by patient and concept

GET /obs (Search by parameters: patient,concept)

Resource: obs

Allows you to find Observations by patient and concept


patient		query	string
concept		query	string

application/json

200 OK: obs response

obs

Fetch by unique uuid

GET /obs/{uuid}

Resource: obs


uuid	uuid to filter by	path	string

application/json

200 OK: obs response

obs

Edit with given uuid, only modifying properties in request

POST /obs/{uuid}

Resource: obs

Uses default content-types: application/json


uuid	uuid of the resource to update	path	string

application/json

200 OK: obs response

obsupdateInput

Fetch all non-retired

GET /order

Resource: order

application/json

200 OK: order response

order

Create with properties in request

POST /order

Resource: order

Uses default content-types: application/json

application/json

200 OK: order response

ordercreateInput

Fetch by unique uuid

GET /order/{uuid}

Resource: order


uuid	uuid to filter by	path	string

application/json

200 OK: order response

order

Fetch all non-retired

GET /orderfrequency

Resource: orderfrequency

application/json

200 OK: orderfrequency response

orderfrequency

Create with properties in request

POST /orderfrequency

Resource: orderfrequency

Uses default content-types: application/json

Parameters: name(required) description(optional)

application/json

200 OK: orderfrequency response

orderfrequencycreateInput

Fetch by unique uuid

GET /orderfrequency/{uuid}

Resource: orderfrequency


uuid	uuid to filter by	path	string

application/json

200 OK: orderfrequency response

orderfrequency

Edit with given uuid, only modifying properties in request

POST /orderfrequency/{uuid}

Resource: orderfrequency

Uses default content-types: application/json

Parameters: name(required) description(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: orderfrequency response

orderfrequencyupdateInput

Fetch all non-retired

GET /ordertype

Resource: ordertype

application/json

200 OK: ordertype response

ordertype

Create with properties in request

POST /ordertype

Resource: ordertype

Uses default content-types: application/json

Parameters: name(required) description(optional) javaClassName(required) parent(optional) conceptClasses(optional)

application/json

200 OK: ordertype response

ordertypecreateInput

Fetch by unique uuid

GET /ordertype/{uuid}

Resource: ordertype


uuid	uuid to filter by	path	string

application/json

200 OK: ordertype response

ordertype

Edit with given uuid, only modifying properties in request

POST /ordertype/{uuid}

Resource: ordertype

Uses default content-types: application/json

Parameters: name(required) description(optional) javaClassName(required) parent(optional) conceptClasses(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: ordertype response

ordertypeupdateInput

Fetch all non-retired

GET /patient

Resource: patient

application/json

200 OK: patient response

patient

Create with properties in request

POST /patient

Resource: patient

Uses default content-types: application/json

Parameters: person(required) identifiers(required)

application/json

200 OK: patient response

patientcreateInput

Allows you to find Patients by identifier

GET /patient (Search by parameters: identifier)

Resource: patient

Allows you to find Patients by identifier


identifier		query	string

application/json

200 OK: patient response

patient

Fetch by unique uuid

GET /patient/{uuid}

Resource: patient


uuid	uuid to filter by	path	string

application/json

200 OK: patient response

patient

Edit with given uuid, only modifying properties in request

POST /patient/{uuid}

Resource: patient

Uses default content-types: application/json

Parameters: identifier(required) identifierType(required) location(optional) preferred(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: patient response

patientupdateInput

Subresource

GET /patient/{uuid}/identifier

Resource: patient


uuid	uuid to filter by	path	string

application/json

200 OK: patient response

Subresource

POST /patient/{uuid}/identifier

Resource: patient

Uses default content-types: application/json

Parameters: identifier(required) identifierType(required) location(optional) preferred(optional)


uuid	uuid to filter by	path	string

application/json

200 OK: patient response

Fetch all non-retired

GET /patientidentifiertype

Resource: patientidentifiertype

application/json

200 OK: patientidentifiertype response

patientidentifiertype

Create with properties in request

POST /patientidentifiertype

Resource: patientidentifiertype

Uses default content-types: application/json

Parameters: name(required) description(required) format(optional) formatDescription(optional) required(optional) checkDigit(optional) validator(optional) locationBehavior(optional) uniquenessBehavior(optional)

application/json

200 OK: patientidentifiertype response

patientidentifiertypecreateInput

Fetch by unique uuid

GET /patientidentifiertype/{uuid}

Resource: patientidentifiertype


uuid	uuid to filter by	path	string

application/json

200 OK: patientidentifiertype response

patientidentifiertype

Edit with given uuid, only modifying properties in request

POST /patientidentifiertype/{uuid}

Resource: patientidentifiertype

Uses default content-types: application/json


uuid	uuid of the resource to update	path	string

application/json

200 OK: patientidentifiertype response

patientidentifiertypeupdateInput

Fetch all non-retired

GET /person

Resource: person

application/json

200 OK: person response

person

Create with properties in request

POST /person

Resource: person

Uses default content-types: application/json

Parameters: names(required) gender(required) age(optional) birthdate(optional) birthdateEstimated(optional) dead(optional) deathDate(optional) causeOfDeath(optional) addresses(optional) attributes(optional) deathdateEstimated(optional) birthtime(optional)

application/json

200 OK: person response

personcreateInput

Fetch by unique uuid

GET /person/{uuid}

Resource: person


uuid	uuid to filter by	path	string

application/json

200 OK: person response

person

Edit with given uuid, only modifying properties in request

POST /person/{uuid}

Resource: person

Uses default content-types: application/json

Parameters: givenName(required) familyName(required) middleName(optional) familyName2(optional) preferred(optional) prefix(optional) familyNamePrefix(optional) familyNameSuffix(optional) degree(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: person response

personupdateInput

Subresource

GET /person/{uuid}/address

Resource: person


uuid	uuid to filter by	path	string

application/json

200 OK: person response

Subresource

POST /person/{uuid}/address

Resource: person

Uses default content-types: application/json

Parameters: preferred(optional) address1(optional) address2(optional) cityVillage(optional) stateProvince(optional) country(optional) postalCode(optional) latitude(optional) longitude(optional) countyDistrict(optional) address3(optional) address4(optional) address5(optional) address6(optional) startDate(optional) endDate(optional)


uuid	uuid to filter by	path	string

application/json

200 OK: person response

Subresource

GET /person/{uuid}/attribute

Resource: person


uuid	uuid to filter by	path	string

application/json

200 OK: person response

Subresource

POST /person/{uuid}/attribute

Resource: person

Uses default content-types: application/json

Parameters: value(optional) attributeType(required) hydratedObject(optional)


uuid	uuid to filter by	path	string

application/json

200 OK: person response

Subresource

GET /person/{uuid}/name

Resource: person


uuid	uuid to filter by	path	string

application/json

200 OK: person response

Subresource

POST /person/{uuid}/name

Resource: person

Uses default content-types: application/json


uuid	uuid to filter by	path	string

application/json

200 OK: person response

Fetch all non-retired

GET /personattributetype

Resource: personattributetype

application/json

200 OK: personattributetype response

personattributetype

Create with properties in request

POST /personattributetype

Resource: personattributetype

Uses default content-types: application/json

Parameters: name(required) description(required) format(optional) foreignKey(optional) sortWeight(optional) searchable(optional) editPrivilege(optional)

application/json

200 OK: personattributetype response

personattributetypecreateInput

Fetch by unique uuid

GET /personattributetype/{uuid}

Resource: personattributetype


uuid	uuid to filter by	path	string

application/json

200 OK: personattributetype response

personattributetype

Edit with given uuid, only modifying properties in request

POST /personattributetype/{uuid}

Resource: personattributetype

Uses default content-types: application/json

Parameters: name(required) description(required) format(optional) foreignKey(optional) sortWeight(optional) searchable(optional) editPrivilege(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: personattributetype response

personattributetypeupdateInput

Fetch all non-retired

GET /privilege

Resource: privilege

application/json

200 OK: privilege response

privilege

Create with properties in request

POST /privilege

Resource: privilege

Uses default content-types: application/json

Parameters: name(required) description(optional)

application/json

200 OK: privilege response

privilegecreateInput

Fetch by unique uuid

GET /privilege/{uuid}

Resource: privilege


uuid	uuid to filter by	path	string

application/json

200 OK: privilege response

privilege

Edit with given uuid, only modifying properties in request

POST /privilege/{uuid}

Resource: privilege

Uses default content-types: application/json

Parameters: description(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: privilege response

privilegeupdateInput

Fetch all non-retired

GET /problem

Resource: problem

application/json

200 OK: problem response

problem

Create with properties in request

POST /problem

Resource: problem

Uses default content-types: application/json

Parameters: person(required) startDate(required) comments(optional) startObs(optional) stopObs(optional) problem(required) modifier(optional) sortWeight(optional)

application/json

200 OK: problem response

problemcreateInput

Fetch by unique uuid

GET /problem/{uuid}

Resource: problem


uuid	uuid to filter by	path	string

application/json

200 OK: problem response

problem

Edit with given uuid, only modifying properties in request

POST /problem/{uuid}

Resource: problem

Uses default content-types: application/json

Parameters: person(required) startDate(required) comments(optional) startObs(optional) stopObs(optional) problem(required) modifier(optional) sortWeight(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: problem response

problemupdateInput

Fetch all non-retired

GET /program

Resource: program

application/json

200 OK: program response

program

Create with properties in request

POST /program

Resource: program

Uses default content-types: application/json

Parameters: name(required) description(required) concept(required) outcomesConcept(optional) retired(optional)

application/json

200 OK: program response

programcreateInput

Fetch by unique uuid

GET /program/{uuid}

Resource: program


uuid	uuid to filter by	path	string

application/json

200 OK: program response

program

Edit with given uuid, only modifying properties in request

POST /program/{uuid}

Resource: program

Uses default content-types: application/json

Parameters: name(required) description(required) concept(required) outcomesConcept(optional) retired(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: program response

programupdateInput

Create with properties in request

POST /programenrollment

Resource: programenrollment

Uses default content-types: application/json

Parameters: patient(required) program(required) dateEnrolled(required) dateCompleted(optional) states(optional) outcome(optional) location(optional) voided(optional)

application/json

200 OK: programenrollment response

programenrollmentcreateInput

Fetch by unique uuid

GET /programenrollment/{uuid}

Resource: programenrollment


uuid	uuid to filter by	path	string

application/json

200 OK: programenrollment response

programenrollment

Edit with given uuid, only modifying properties in request

POST /programenrollment/{uuid}

Resource: programenrollment

Uses default content-types: application/json

Parameters: state(required) startDate(optional) endDate(optional) voided(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: programenrollment response

programenrollmentupdateInput

Subresource

GET /programenrollment/{uuid}/state

Resource: programenrollment


uuid	uuid to filter by	path	string

application/json

200 OK: programenrollment response

Subresource

POST /programenrollment/{uuid}/state

Resource: programenrollment

Uses default content-types: application/json

Parameters: state(required)


uuid	uuid to filter by	path	string

application/json

200 OK: programenrollment response

Fetch all non-retired

GET /provider

Resource: provider

application/json

200 OK: provider response

provider

Create with properties in request

POST /provider

Resource: provider

Uses default content-types: application/json

Parameters: person(required) identifier(required) attributes(optional) retired(optional)

application/json

200 OK: provider response

providercreateInput

Allows you to find providers by user uuid

GET /provider (Search by parameters: user)

Resource: provider

Allows you to find providers by user uuid


user		query	string

application/json

200 OK: provider response

provider

Edit with given uuid, only modifying properties in request

POST /provider/{uuid}

Resource: provider

Uses default content-types: application/json

Parameters: attributeType(required) value(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: provider response

providerupdateInput

Subresource

POST /provider/{uuid}/attribute

Resource: provider

Uses default content-types: application/json

Parameters: attributeType(required) value(required)


uuid	uuid to filter by	path	string

application/json

200 OK: provider response

Fetch all non-retired

GET /providerattributetype

Resource: providerattributetype

application/json

200 OK: providerattributetype response

providerattributetype

Create with properties in request

POST /providerattributetype

Resource: providerattributetype

Uses default content-types: application/json

application/json

200 OK: providerattributetype response

providerattributetypecreateInput

Fetch by unique uuid

GET /providerattributetype/{uuid}

Resource: providerattributetype


uuid	uuid to filter by	path	string

application/json

200 OK: providerattributetype response

providerattributetype

Edit with given uuid, only modifying properties in request

POST /providerattributetype/{uuid}

Resource: providerattributetype

Uses default content-types: application/json


uuid	uuid of the resource to update	path	string

application/json

200 OK: providerattributetype response

providerattributetypeupdateInput

Create with properties in request

POST /relationship

Resource: relationship

Uses default content-types: application/json

Parameters: personA(required) relationshipType(required) personB(required) startDate(optional) endDate(optional)

application/json

200 OK: relationship response

relationshipcreateInput

Allows you to find relationship by person uuid

GET /relationship (Search by parameters: person)

Resource: relationship

Allows you to find relationship by person uuid


person		query	string

application/json

200 OK: relationship response

relationship

Allows you to find relationships between two persons by specifying their uuids

GET /relationship (Search by parameters: person,relatedPerson)

Resource: relationship

Allows you to find relationships between two persons by specifying their uuids


person		query	string
relatedPerson		query	string

application/json

200 OK: relationship response

relationship

Allows you to find relationships where person is related to other by type of relationship

GET /relationship (Search by parameters: person,relation)

Resource: relationship

Allows you to find relationships where person is related to other by type of relationship


person		query	string
relation		query	string

application/json

200 OK: relationship response

relationship

Allows you to find relationships of personA of given relationship type

GET /relationship (Search by parameters: personA,relation)

Resource: relationship

Allows you to find relationships of personA of given relationship type


personA		query	string
relation		query	string

application/json

200 OK: relationship response

relationship

Allows you to find relationships between personA and personB

GET /relationship (Search by parameters: personB,personA)

Resource: relationship

Allows you to find relationships between personA and personB


personB		query	string
personA		query	string

application/json

200 OK: relationship response

relationship

Allows you to find relationships between personA and personB given relationship type

GET /relationship (Search by parameters: personB,personA,relation)

Resource: relationship

Allows you to find relationships between personA and personB given relationship type


personB	query	string
personA	query	string
relation	query	string

application/json

200 OK: relationship response

relationship

Allows you to find relationships of personB of given relationship type

GET /relationship (Search by parameters: personB,relation)

Resource: relationship

Allows you to find relationships of personB of given relationship type


personB		query	string
relation		query	string

application/json

200 OK: relationship response

relationship

Edit with given uuid, only modifying properties in request

POST /relationship/{uuid}

Resource: relationship

Uses default content-types: application/json

Parameters: relationshipType(required) startDate(optional) endDate(optional) voided(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: relationship response

relationshipupdateInput

Fetch all non-retired

GET /relationshiptype

Resource: relationshiptype

application/json

200 OK: relationshiptype response

relationshiptype

Create with properties in request

POST /relationshiptype

Resource: relationshiptype

Uses default content-types: application/json

Parameters: aIsToB(required) bIsToA(required) weight(optional) description(optional)

application/json

200 OK: relationshiptype response

relationshiptypecreateInput

Fetch by unique uuid

GET /relationshiptype/{uuid}

Resource: relationshiptype


uuid	uuid to filter by	path	string

application/json

200 OK: relationshiptype response

relationshiptype

Edit with given uuid, only modifying properties in request

POST /relationshiptype/{uuid}

Resource: relationshiptype

Uses default content-types: application/json

Parameters: aIsToB(required) bIsToA(required) weight(optional) description(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: relationshiptype response

relationshiptypeupdateInput

Fetch all non-retired

GET /role

Resource: role

application/json

200 OK: role response

role

Create with properties in request

POST /role

Resource: role

Uses default content-types: application/json

Parameters: name(required) description(optional) privileges(optional) inheritedRoles(optional)

application/json

200 OK: role response

rolecreateInput

Fetch by unique uuid

GET /role/{uuid}

Resource: role


uuid	uuid to filter by	path	string

application/json

200 OK: role response

role

Edit with given uuid, only modifying properties in request

POST /role/{uuid}

Resource: role

Uses default content-types: application/json

Parameters: description(optional) privileges(optional) inheritedRoles(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: role response

roleupdateInput

Fetch all non-retired

GET /systemsetting

Resource: systemsetting

application/json

200 OK: systemsetting response

systemsetting

Create with properties in request

POST /systemsetting

Resource: systemsetting

Uses default content-types: application/json

Parameters: property(required) description(required) datatypeClassname(optional) datatypeConfig(optional) preferredHandlerClassname(optional) handlerConfig(optional) value(required)

application/json

200 OK: systemsetting response

systemsettingcreateInput

Fetch by unique uuid

GET /systemsetting/{uuid}

Resource: systemsetting


uuid	uuid to filter by	path	string

application/json

200 OK: systemsetting response

systemsetting

Edit with given uuid, only modifying properties in request

POST /systemsetting/{uuid}

Resource: systemsetting

Uses default content-types: application/json

Parameters: description(required) datatypeClassname(optional) datatypeConfig(optional) preferredHandlerClassname(optional) handlerConfig(optional) value(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: systemsetting response

systemsettingupdateInput

Create with properties in request

POST /TestOrder

Resource: TestOrder

Uses default content-types: application/json

application/json

200 OK: TestOrder response

TestOrdercreateInput

Fetch all non-retired

GET /user

Resource: user

application/json

200 OK: user response

user

Create with properties in request

POST /user

Resource: user

Uses default content-types: application/json

Parameters: username(required) password(required) person(required) systemId(optional) userProperties(optional) roles(optional) proficientLocales(optional) secretQuestion(optional)

application/json

200 OK: user response

usercreateInput

Allows you to find users by username

GET /user (Search by parameters: username)

Resource: user

Allows you to find users by username


username		query	string

application/json

200 OK: user response

user

Fetch by unique uuid

GET /user/{uuid}

Resource: user


uuid	uuid to filter by	path	string

application/json

200 OK: user response

user

Edit with given uuid, only modifying properties in request

POST /user/{uuid}

Resource: user

Uses default content-types: application/json

Parameters: username(required) password(required) person(required) systemId(optional) userProperties(optional) roles(optional) proficientLocales(optional) secretQuestion(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: user response

userupdateInput

Create with properties in request

POST /visit

Resource: visit

Uses default content-types: application/json

Parameters: patient(required) visitType(required) startDatetime(optional) location(optional) indication(optional) stopDatetime(optional) encounters(optional) attributes(optional)

application/json

200 OK: visit response

visitcreateInput

Edit with given uuid, only modifying properties in request

POST /visit/{uuid}

Resource: visit

Uses default content-types: application/json

Parameters: attributeType(required) value(required)


uuid	uuid of the resource to update	path	string

application/json

200 OK: visit response

visitupdateInput

Subresource

POST /visit/{uuid}/attribute

Resource: visit

Uses default content-types: application/json

Parameters: attributeType(required) value(required)


uuid	uuid to filter by	path	string

application/json

200 OK: visit response

Fetch all non-retired

GET /visitattributetype

Resource: visitattributetype

application/json

200 OK: visitattributetype response

visitattributetype

Create with properties in request

POST /visitattributetype

Resource: visitattributetype

Uses default content-types: application/json

application/json

200 OK: visitattributetype response

visitattributetypecreateInput

Fetch by unique uuid

GET /visitattributetype/{uuid}

Resource: visitattributetype


uuid	uuid to filter by	path	string

application/json

200 OK: visitattributetype response

visitattributetype

Edit with given uuid, only modifying properties in request

POST /visitattributetype/{uuid}

Resource: visitattributetype

Uses default content-types: application/json


uuid	uuid of the resource to update	path	string

application/json

200 OK: visitattributetype response

visitattributetypeupdateInput

Fetch all non-retired

GET /visittype

Resource: visittype

application/json

200 OK: visittype response

visittype

Create with properties in request

POST /visittype

Resource: visittype

Uses default content-types: application/json

Parameters: name(required) description(optional)

application/json

200 OK: visittype response

visittypecreateInput

Fetch by unique uuid

GET /visittype/{uuid}

Resource: visittype


uuid	uuid to filter by	path	string

application/json

200 OK: visittype response

visittype

Edit with given uuid, only modifying properties in request

POST /visittype/{uuid}

Resource: visittype

Uses default content-types: application/json

Parameters: name(required) description(optional)


uuid	uuid of the resource to update	path	string

application/json

200 OK: visittype response

visittypeupdateInput

Fetch all non-retired

GET /workflow

Resource: workflow

application/json

200 OK: workflow response

workflow

Create with properties in request

POST /workflow

Resource: workflow

Uses default content-types: application/json

Parameters: name(required) description(optional)

application/json

200 OK: workflow response

workflowcreateInput

Fetch by unique uuid

GET /workflow/{uuid}

Resource: workflow


uuid	uuid to filter by	path	string

application/json

200 OK: workflow response

workflow

Subresource

GET /workflow/{uuid}//state

Resource: workflow


uuid	uuid to filter by	path	string

application/json

200 OK: workflow response

Schema definitions

activelisttype: object

auditInfo: string
display: string
resourceVersion: string
name: string
description: string
links: string
retired: string
uuid: string

activelisttypeCreateInput: object

auditInfo: string
display: string
resourceVersion: string
name: string
description: string
links: string
retired: string
uuid: string

activelisttypeUpdateInput: object

auditInfo: string
display: string
resourceVersion: string
name: string
description: string
links: string
retired: string
uuid: string

allergy: object

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

allergyCreateInput: object

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

allergyUpdateInput: object

severity: string
allergen: string
startObs: string
comments: string
reaction: string
endDate: string
display: string
resourceVersion: string
allergyType: string