OpenMRS RESTful API documentation generated by Swagger
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.
curl -u admin:Admin123 -i 'http://localhost:8080/openmrs/ws/rest/v1/concept'
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 |
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 |
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 |
Operation | Description |
---|---|
GET /customdatatype | Fetch all non-retired |
GET /customdatatype/{uuid}/handlers | Subresource |
GET /customdatatype/{uuid} | Fetch by unique uuid |
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 |
subtype of Order
Operation | Description |
---|---|
POST /DrugOrder | Create with properties in request |
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 |
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 |
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 |
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 |
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 |
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 |
Operation | Description |
---|---|
GET /caresetting | Fetch all non-retired |
GET /caresetting/{uuid} | Fetch by unique uuid |
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 |
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 |
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 |
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 |
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 |
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 |
Operation | Description |
---|---|
GET /order/{uuid} | Fetch by unique uuid |
POST /order | Create with properties in request |
GET /order | Fetch all non-retired |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
subtype of Order
Operation | Description |
---|---|
POST /TestOrder | Create with properties in request |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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) |
application/json
activelisttype response
Uses default content-types: application/json
Parameters: name(required) description(optional)
application/json
activelisttype response
Uses default content-types: application/json
Parameters: name(required) description(optional)
uuid | uuid of the resource to update |
path | string |
application/json
activelisttype response
application/json
allergy response
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
allergy response
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
allergy response
application/json
caresetting response
Uses default content-types: application/json
Parameters: name(required) description(required) memberIds(required)
application/json
cohort response
Uses default content-types: application/json
Parameters: patient(required)
uuid | uuid of the resource to update |
path | string |
application/json
cohort response
uuid | uuid to filter by |
path | string |
application/json
cohort response
Uses default content-types: application/json
Parameters: patient(required)
uuid | uuid to filter by |
path | string |
application/json
cohort response
application/json
concept response
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
concept response
Allows you to find concepts by name
name | query | string |
application/json
concept response
Allows you to find concepts by source and code
source | query | string | ||
code | query | string |
application/json
concept response
Allows you to find concepts which map to term, uuid of term given as input
term | query | string |
application/json
concept response
Uses default content-types: application/json
Parameters: conceptReferenceTerm(required) conceptMapType(required)
uuid | uuid of the resource to update |
path | string |
application/json
concept response
uuid | uuid to filter by |
path | string |
application/json
concept response
Uses default content-types: application/json
Parameters: description(required) locale(required)
uuid | uuid to filter by |
path | string |
application/json
concept response
uuid | uuid to filter by |
path | string |
application/json
concept response
Uses default content-types: application/json
Parameters: conceptReferenceTerm(required) conceptMapType(required)
uuid | uuid to filter by |
path | string |
application/json
concept response
uuid | uuid to filter by |
path | string |
application/json
concept response
Uses default content-types: application/json
Parameters: name(required) locale(required) localePreferred(optional) conceptNameType(optional)
uuid | uuid to filter by |
path | string |
application/json
concept response
application/json
conceptclass response
Uses default content-types: application/json
Parameters: name(required) description(optional)
application/json
conceptclass response
Uses default content-types: application/json
Parameters: name(required) description(optional)
uuid | uuid of the resource to update |
path | string |
application/json
conceptclass response
application/json
conceptdatatype response
Uses default content-types: application/json
Parameters: name(required) description(optional)
application/json
conceptdatatype response
Uses default content-types: application/json
Parameters: name(required) description(optional)
uuid | uuid of the resource to update |
path | string |
application/json
conceptdatatype response
application/json
conceptmaptype response
Uses default content-types: application/json
Parameters: name(required) description(optional) isHidden(optional)
application/json
conceptmaptype response
Uses default content-types: application/json
Parameters: name(required) description(optional) isHidden(optional)
uuid | uuid of the resource to update |
path | string |
application/json
conceptmaptype response
application/json
conceptreferenceterm response
Uses default content-types: application/json
Parameters: code(required) conceptSource(required) name(optional) description(optional) version(optional)
application/json
conceptreferenceterm response
Allows you to find terms by source, code and name
source | query | string | ||
code | query | string | ||
name | query | string |
application/json
conceptreferenceterm response
uuid | uuid to filter by |
path | string |
application/json
conceptreferenceterm response
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
conceptreferenceterm response
application/json
conceptreferencetermmap response
Uses default content-types: application/json
Parameters: termA(required) termB(required) conceptMapType(required)
application/json
conceptreferencetermmap response
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
conceptreferencetermmap response
Allows you to find term maps by reference 'maps' (termA uuid) and 'to' (termB uuid)
maps | query | string | ||
to | query | string |
application/json
conceptreferencetermmap response
Allows you to find term maps by reference 'termA' (uuid) and 'maptype' (uuid or name)
termA | query | string | ||
maptype | query | string |
application/json
conceptreferencetermmap response
Allows you to find term maps by reference 'termB' (uuid) and 'maptype' (uuid or name)
termB | query | string | ||
maptype | query | string |
application/json
conceptreferencetermmap response
uuid | uuid to filter by |
path | string |
application/json
conceptreferencetermmap response
Uses default content-types: application/json
Parameters: termA(required) termB(required) conceptMapType(required)
uuid | uuid of the resource to update |
path | string |
application/json
conceptreferencetermmap response
application/json
conceptsource response
Uses default content-types: application/json
Parameters: name(required) description(required) hl7Code(optional)
application/json
conceptsource response
Uses default content-types: application/json
Parameters: name(required) description(required) hl7Code(optional)
uuid | uuid of the resource to update |
path | string |
application/json
conceptsource response
application/json
customdatatype response
uuid | uuid to filter by |
path | string |
application/json
customdatatype response
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
drug response
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
drug response
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
source | query | string | ||
code | query | string | ||
preferredMapTypes | query | string |
application/json
drug response
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)
uuid | uuid of the resource to update |
path | string |
application/json
drug response
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
DrugOrder response
application/json
encounter response
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
encounter response
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
encounter response
Uses default content-types: application/json
Parameters: encounterRole(optional) voided(optional) voidReason(optional)
uuid | uuid of the resource to update |
path | string |
application/json
encounter response
uuid | uuid to filter by |
path | string |
application/json
encounter response
Uses default content-types: application/json
Parameters: provider(optional) encounter(optional) encounterRole(optional)
uuid | uuid to filter by |
path | string |
application/json
encounter response
application/json
encounterrole response
Uses default content-types: application/json
Parameters: name(required) description(required)
application/json
encounterrole response
Uses default content-types: application/json
Parameters: name(required) description(required)
uuid | uuid of the resource to update |
path | string |
application/json
encounterrole response
application/json
encountertype response
Uses default content-types: application/json
Parameters: name(required) description(required)
application/json
encountertype response
Uses default content-types: application/json
Parameters: name(required) description(required)
uuid | uuid of the resource to update |
path | string |
application/json
encountertype response
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
field response
Uses default content-types: application/json
Parameters: field(required) concept(required)
uuid | uuid of the resource to update |
path | string |
application/json
field response
uuid | uuid to filter by |
path | string |
application/json
field response
Uses default content-types: application/json
Parameters: field(required) concept(required)
uuid | uuid to filter by |
path | string |
application/json
field response
application/json
fieldtype response
Uses default content-types: application/json
Parameters: name(required) description(optional)
application/json
fieldtype response
Uses default content-types: application/json
Parameters: name(required) description(optional)
uuid | uuid of the resource to update |
path | string |
application/json
fieldtype response
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
form response
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
form response
uuid | uuid to filter by |
path | string |
application/json
form response
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
form response
uuid | uuid to filter by |
path | string |
application/json
form response
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
form response
Uses default content-types: application/json
Parameters: hl7(required)
application/json
hl7 response
Uses default content-types: application/json
Parameters: hl7(required)
uuid | uuid of the resource to update |
path | string |
application/json
hl7 response
application/json
hl7source response
Uses default content-types: application/json
Parameters: name(required) description(required)
application/json
hl7source response
Uses default content-types: application/json
Parameters: name(required) description(required)
uuid | uuid of the resource to update |
path | string |
application/json
hl7source response
application/json
location response
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
location response
Allows you to find locations by tag uuid or tag name
tag | query | string |
application/json
location response
Uses default content-types: application/json
Parameters: attributeType(required) value(required)
uuid | uuid of the resource to update |
path | string |
application/json
location response
Uses default content-types: application/json
Parameters: attributeType(required) value(required)
uuid | uuid to filter by |
path | string |
application/json
location response
application/json
locationattributetype response
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
locationattributetype response
uuid | uuid to filter by |
path | string |
application/json
locationattributetype response
Uses default content-types: application/json
Parameters: name(required) datatypeClassname(required) description(optional) minOccurs(optional) maxOccurs(optional) datatypeConfig(optional) preferredHandlerClassname(optional) handlerConfig(optional)
uuid | uuid of the resource to update |
path | string |
application/json
locationattributetype response
application/json
locationtag response
Uses default content-types: application/json
Parameters: name(required) description(optional) retired(optional) retireReason(optional)
application/json
locationtag response
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
locationtag response
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
obs response
Allows you to find Observations by patient and concept
patient | query | string | ||
concept | query | string |
application/json
obs response
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)
uuid | uuid of the resource to update |
path | string |
application/json
obs response
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)
application/json
order response
application/json
orderfrequency response
Uses default content-types: application/json
Parameters: name(required) description(optional)
application/json
orderfrequency response
Uses default content-types: application/json
Parameters: name(required) description(optional)
uuid | uuid of the resource to update |
path | string |
application/json
orderfrequency response
application/json
ordertype response
Uses default content-types: application/json
Parameters: name(required) description(optional) javaClassName(required) parent(optional) conceptClasses(optional)
application/json
ordertype response
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
ordertype response
application/json
patient response
Uses default content-types: application/json
Parameters: person(required) identifiers(required)
application/json
patient response
Allows you to find Patients by identifier
identifier | query | string |
application/json
patient response
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
patient response
uuid | uuid to filter by |
path | string |
application/json
patient response
Uses default content-types: application/json
Parameters: identifier(required) identifierType(required) location(optional) preferred(optional)
uuid | uuid to filter by |
path | string |
application/json
patient response
application/json
patientidentifiertype response
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
patientidentifiertype response
uuid | uuid to filter by |
path | string |
application/json
patientidentifiertype response
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)
uuid | uuid of the resource to update |
path | string |
application/json
patientidentifiertype response
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
person response
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
person response
uuid | uuid to filter by |
path | string |
application/json
person response
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
person response
uuid | uuid to filter by |
path | string |
application/json
person response
Uses default content-types: application/json
Parameters: value(optional) attributeType(required) hydratedObject(optional)
uuid | uuid to filter by |
path | string |
application/json
person response
uuid | uuid to filter by |
path | string |
application/json
person response
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 to filter by |
path | string |
application/json
person response
application/json
personattributetype response
Uses default content-types: application/json
Parameters: name(required) description(required) format(optional) foreignKey(optional) sortWeight(optional) searchable(optional) editPrivilege(optional)
application/json
personattributetype response
uuid | uuid to filter by |
path | string |
application/json
personattributetype response
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
personattributetype response
application/json
privilege response
Uses default content-types: application/json
Parameters: name(required) description(optional)
application/json
privilege response
Uses default content-types: application/json
Parameters: description(optional)
uuid | uuid of the resource to update |
path | string |
application/json
privilege response
application/json
problem response
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
problem response
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
problem response
application/json
program response
Uses default content-types: application/json
Parameters: name(required) description(required) concept(required) outcomesConcept(optional) retired(optional)
application/json
program response
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
program response
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
programenrollment response
uuid | uuid to filter by |
path | string |
application/json
programenrollment response
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
programenrollment response
uuid | uuid to filter by |
path | string |
application/json
programenrollment response
Uses default content-types: application/json
Parameters: state(required)
uuid | uuid to filter by |
path | string |
application/json
programenrollment response
application/json
provider response
Uses default content-types: application/json
Parameters: person(required) identifier(required) attributes(optional) retired(optional)
application/json
provider response
Allows you to find providers by user uuid
user | query | string |
application/json
provider response
Uses default content-types: application/json
Parameters: attributeType(required) value(required)
uuid | uuid of the resource to update |
path | string |
application/json
provider response
Uses default content-types: application/json
Parameters: attributeType(required) value(required)
uuid | uuid to filter by |
path | string |
application/json
provider response
application/json
providerattributetype response
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
providerattributetype response
uuid | uuid to filter by |
path | string |
application/json
providerattributetype response
Uses default content-types: application/json
Parameters: name(required) datatypeClassname(required) description(optional) minOccurs(optional) maxOccurs(optional) datatypeConfig(optional) preferredHandlerClassname(optional) handlerConfig(optional)
uuid | uuid of the resource to update |
path | string |
application/json
providerattributetype response
Uses default content-types: application/json
Parameters: personA(required) relationshipType(required) personB(required) startDate(optional) endDate(optional)
application/json
relationship response
Allows you to find relationship by person uuid
person | query | string |
application/json
relationship response
Allows you to find relationships where person is related to other by type of relationship
person | query | string | ||
relation | query | string |
application/json
relationship response
Allows you to find relationships of personA of given relationship type
personA | query | string | ||
relation | query | string |
application/json
relationship response
Allows you to find relationships between personA and personB
personB | query | string | ||
personA | query | string |
application/json
relationship response
Allows you to find relationships between personA and personB given relationship type
personB | query | string | ||
personA | query | string | ||
relation | query | string |
application/json
relationship response
Allows you to find relationships of personB of given relationship type
personB | query | string | ||
relation | query | string |
application/json
relationship response
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
relationship response
application/json
relationshiptype response
Uses default content-types: application/json
Parameters: aIsToB(required) bIsToA(required) weight(optional) description(optional)
application/json
relationshiptype response
uuid | uuid to filter by |
path | string |
application/json
relationshiptype response
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
relationshiptype response
Uses default content-types: application/json
Parameters: name(required) description(optional) privileges(optional) inheritedRoles(optional)
application/json
role response
Uses default content-types: application/json
Parameters: description(optional) privileges(optional) inheritedRoles(optional)
uuid | uuid of the resource to update |
path | string |
application/json
role response
application/json
systemsetting response
Uses default content-types: application/json
Parameters: property(required) description(required) datatypeClassname(optional) datatypeConfig(optional) preferredHandlerClassname(optional) handlerConfig(optional) value(required)
application/json
systemsetting response
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
systemsetting response
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) specimenSource(optional) laterality(optional) clinicalHistory(optional) frequency(optional) numberOfRepeats(optional)
application/json
TestOrder response
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
user response
Allows you to find users by username
username | query | string |
application/json
user response
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
user response
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
visit response
Uses default content-types: application/json
Parameters: attributeType(required) value(required)
uuid | uuid of the resource to update |
path | string |
application/json
visit response
Uses default content-types: application/json
Parameters: attributeType(required) value(required)
uuid | uuid to filter by |
path | string |
application/json
visit response
application/json
visitattributetype response
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
visitattributetype response
uuid | uuid to filter by |
path | string |
application/json
visitattributetype response
Uses default content-types: application/json
Parameters: name(required) datatypeClassname(required) description(optional) minOccurs(optional) maxOccurs(optional) datatypeConfig(optional) preferredHandlerClassname(optional) handlerConfig(optional)
uuid | uuid of the resource to update |
path | string |
application/json
visitattributetype response
application/json
visittype response
Uses default content-types: application/json
Parameters: name(required) description(optional)
application/json
visittype response
Uses default content-types: application/json
Parameters: name(required) description(optional)
uuid | uuid of the resource to update |
path | string |
application/json
visittype response
application/json
workflow response
Uses default content-types: application/json
Parameters: name(required) description(optional)
application/json
workflow response
uuid | uuid to filter by |
path | string |
application/json
workflow response