Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid (Replace SERVER_URL)
HTTP Method GET
Example Response See Patient Grid Resource ( Ref Representation)
{
"results": [
{
"uuid": "1d6c993e-c2cc-11de-8d13-0010c6dffd0a",
"display": "My Patients",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/1d6c993e-c2cc-11de-8d13-0010c6dffd0a"
}
]
},
{
"uuid": "2d6c993e-c2cc-11de-8d13-0010c6dffd0a",
"display": "Male Patients",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a"
}
]
}
]
}
To Include all the column and filter metadata for the grid, note that we fetch the full representation otherwise you can exclude it the request parameter.
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}?v=full
HTTP Method GET
Example Response See Patient Grid Resource ( Full Representation)
{
"uuid": "2d6c993e-c2cc-11de-8d13-0010c6dffd0a",
"display": "Male Patients",
"name": "Male Patients",
"description": "Male patient grid",
"retired": false,
"auditInfo": {
"creator": {
"uuid": "1010d442-e134-11de-babe-001e378eb67e",
"display": "admin",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/user/1010d442-e134-11de-babe-001e378eb67e"
}
]
},
"dateCreated": "2022-08-28T00:00:00.000-0500",
"changedBy": null,
"dateChanged": null
},
"owner": {
"uuid": "c1d8f5c2-e131-11de-babe-001e378eb67e",
"display": "bruno",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/user/c1d8f5c2-e131-11de-babe-001e378eb67e"
}
]
},
"columns": [
{
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "gender",
"name": "gender",
"description": "patient gender",
"datatype": "GENDER",
"filters": [
{
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0c",
"display": "is male",
"name": "is male",
"column": {
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "gender",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "column"
},
"operand": "M",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c?v=full"
}
],
"resourceVersion": "1.8"
}
],
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b?v=full"
}
],
"type": "column",
"resourceVersion": "1.8"
},
{
"uuid": "2f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "civilStatus",
"name": "civilStatus",
"description": "patient civil status",
"datatype": "OBS",
"filters": [
],
"concept": {
"uuid": "89ca642a-dab6-4f20-b712-e12ca4fc6d36",
"display": "CIVIL STATUS",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/concept/89ca642a-dab6-4f20-b712-e12ca4fc6d36"
}
]
},
"encounterType": {
"uuid": "19218f76-6c39-45f4-8efa-4c5c6c199f50",
"display": "Initial",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/encountertype/19218f76-6c39-45f4-8efa-4c5c6c199f50"
}
]
},
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/2f6c993e-c2cc-11de-8d13-0010c6dffd0b"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/2f6c993e-c2cc-11de-8d13-0010c6dffd0b?v=full"
}
],
"type": "obscolumn",
"resourceVersion": "1.8"
}
],
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a"
}
],
"resourceVersion": "1.8"
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid
HTTP Method POST
Example Payload
{
"name": "test",
"description": "test description",
"columns": [
{
"type": "column",
"name": "name",
"datatype": "NAME"
},
{
"type": "obscolumn",
"name": "weight",
"datatype": "OBS",
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
{
"type": "agecolumn",
"name": "age",
"datatype": "ENC_AGE",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50",
"filters": [
{
"name": "equal 12",
"operand": "12"
}
]
}
]
}
Example Response: ( Default Representation)
{
"uuid": "7e6add6c-ca68-443a-92fa-9395845bc383",
"display": "test",
"name": "test",
"description": "test description",
"retired": false,
"owner": null,
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/7e6add6c-ca68-443a-92fa-9395845bc383"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/7e6add6c-ca68-443a-92fa-9395845bc383?v=full"
}
],
"resourceVersion": "1.8"
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}
HTTP Method DELETE
Request Parameter
reason Reason for deleting the grid
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/column/{COLUMN_UUID}
HTTP Method GET
Example Response See Grid Column Resource, ( Default Representation)
{
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "gender",
"name": "gender",
"description": "patient gender",
"datatype": "GENDER",
"filters": [
{
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0c",
"display": "is male",
"name": "is male",
"column": {
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "gender",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "column"
},
"operand": "M",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c?v=full"
}
],
"resourceVersion": "1.8"
}
],
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b?v=full"
}
],
"type": "column",
"resourceVersion": "1.8"
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/column
HTTP Method GET
Example Response See Grid Column Resource, ( Default Representation)
{
"results": [
{
"uuid": "0e6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "name",
"name": "name",
"description": "patient name",
"datatype": "NAME",
"filters": [
],
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/0e6c993e-c2cc-11de-8d13-0010c6dffd0b"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/0e6c993e-c2cc-11de-8d13-0010c6dffd0b?v=full"
}
],
"type": "column",
"resourceVersion": "1.8"
},
{
"uuid": "2f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "civilStatus",
"name": "civilStatus",
"description": "patient civil status",
"datatype": "OBS",
"filters": [
{
"uuid": "2f6c993e-c2cc-11de-8d13-0010c6dffd0c",
"display": "is single",
"name": "is single",
"column": {
"uuid": "2f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "civilStatus",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/2f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "obscolumn"
},
"operand": "32d3611a-6699-4d52-823f-b4b788bac3e3",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/2f6c993e-c2cc-11de-8d13-0010c6dffd0c"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/2f6c993e-c2cc-11de-8d13-0010c6dffd0c?v=full"
}
],
"resourceVersion": "1.8"
},
{
"uuid": "3f6c993e-c2cc-11de-8d13-0010c6dffd0c",
"display": "is divorced",
"name": "is divorced",
"column": {
"uuid": "2f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "civilStatus",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/2f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "obscolumn"
},
"operand": "92afda7c-78c9-47bd-a841-0de0817027d4",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/3f6c993e-c2cc-11de-8d13-0010c6dffd0c"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/3f6c993e-c2cc-11de-8d13-0010c6dffd0c?v=full"
}
],
"resourceVersion": "1.8"
}
],
"concept": {
"uuid": "89ca642a-dab6-4f20-b712-e12ca4fc6d36",
"display": "CIVIL STATUS",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/concept/89ca642a-dab6-4f20-b712-e12ca4fc6d36"
}
]
},
"encounterType": {
"uuid": "19218f76-6c39-45f4-8efa-4c5c6c199f50",
"display": "Initial",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/encountertype/19218f76-6c39-45f4-8efa-4c5c6c199f50"
}
]
},
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/2f6c993e-c2cc-11de-8d13-0010c6dffd0b"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/2f6c993e-c2cc-11de-8d13-0010c6dffd0b?v=full"
}
],
"type": "obscolumn",
"resourceVersion": "1.8"
}
]
}
Currently, not supported, there is a ticket to to add support for this.
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/column/{COLUMN_UUID}
HTTP Method POST
Example Payload
{
"name": "New Name"
}
Example Response
{
"uuid": "1e6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "New Name",
"name": "New Name",
"description": "patient name",
"datatype": "NAME",
"filters": [
],
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/1d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1e6c993e-c2cc-11de-8d13-0010c6dffd0b"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/1d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1e6c993e-c2cc-11de-8d13-0010c6dffd0b?v=full"
}
],
"type": "column",
"resourceVersion": "1.8"
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/column/{COLUMN_UUID}
HTTP Method DELETE
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/filter/{FILTER_UUID}
HTTP Method GET
Example Response See Grid Filter Resource, ( Default Representation)
{
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0c",
"display": "is male",
"name": "is male",
"column": {
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "gender",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "column"
},
"operand": "M",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c?v=full"
}
],
"resourceVersion": "1.8"
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/filter
HTTP Method GET
Example Response: See Grid Filter Resource, ( Default Representation)
{
"results": [
{
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0c",
"display": "is male",
"name": "is male",
"column": {
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "gender",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "column"
},
"operand": "M",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c?v=full"
}
],
"resourceVersion": "1.8"
},
{
"uuid": "2f6c993e-c2cc-11de-8d13-0010c6dffd0c",
"display": "is single",
"name": "is single",
"column": {
"uuid": "2f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "civilStatus",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/2f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "obscolumn"
},
"operand": "32d3611a-6699-4d52-823f-b4b788bac3e3",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/2f6c993e-c2cc-11de-8d13-0010c6dffd0c"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/2f6c993e-c2cc-11de-8d13-0010c6dffd0c?v=full"
}
],
"resourceVersion": "1.8"
}
]
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/filter
HTTP Method POST
Example Payload
{
"name": "male patients",
"column": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"operand": "M"
}
Example Response:
{
"uuid": "84e778f2-9794-4d5c-93fd-c646357eab5a",
"display": "male patients",
"name": "male patients",
"column": {
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "gender",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "column"
},
"operand": "M",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/84e778f2-9794-4d5c-93fd-c646357eab5a"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/84e778f2-9794-4d5c-93fd-c646357eab5a?v=full"
}
],
"resourceVersion": "1.8"
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/filter/{FILTER_UUID}
(Replace GRID_UUID and FILTER_UUID)
HTTP Method POST
Example Payload (ONLY include properties you need to modify or set)
{
"name": "New Name",
"operand": "F"
}
Example Response
{
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0c",
"display": "New Name",
"name": "New Name",
"column": {
"uuid": "1f6c993e-c2cc-11de-8d13-0010c6dffd0b",
"display": "gender",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/column/1f6c993e-c2cc-11de-8d13-0010c6dffd0b"
}
],
"type": "column"
},
"operand": "F",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c"
},
{
"rel": "full",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/2d6c993e-c2cc-11de-8d13-0010c6dffd0a/filter/1f6c993e-c2cc-11de-8d13-0010c6dffd0c?v=full"
}
],
"resourceVersion": "1.8"
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/filter/{FILTER_UUID}
HTTP Method DELETE
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/agerange
HTTP Method GET
Example Response
{
"results": [
{
"minAge": 0,
"minAgeUnit": "YEARS",
"maxAge": 17,
"maxAgeUnit": "YEARS",
"label": "<18yrs",
"display": "<18yrs"
},
{
"minAge": 18,
"minAgeUnit": "YEARS",
"maxAge": null,
"maxAgeUnit": "YEARS",
"label": "18+",
"display": "18+"
}
]
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/report
HTTP Method GET
Request Parameters
refresh If set to true, any caches from previous runs are discarded, i.e. the patient grid is re-evaluated to produce
fresh data
Example Response See Grid Report Resource, ( Ref Representation)
Please pay extra attention to obs column values, for more see the note on obs value properties under Grid Report Resource
{
"results": [
{
"patientGrid": {
"uuid": "1d6c993e-c2cc-11de-8d13-0010c6dffd0a",
"display": "My Patients",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/1d6c993e-c2cc-11de-8d13-0010c6dffd0a"
}
]
},
"report": [
{
"country": "United States",
"encDate": "2022-08-28T00:00:00.000-0500",
"cd4": {
"formFieldPath": null,
"formFieldNamespace": null,
"encounter": {
"uuid": "9619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "29218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "25fb7f47-b80a-4056-9285-bd798be13c63",
"value": 1080.0,
"concept": "a09ab2c5-878e-4905-b25d-5784167d0216"
},
"gender": "M",
"name": "Johnny Test Doe",
"weight": {
"formFieldPath": null,
"formFieldNamespace": null,
"encounter": {
"uuid": "6619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "64fb7f47-b80a-4056-9285-bd798be13c63",
"value": 72.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd"
},
"ageCategory": "18+",
"uuid": "a7e04421-525f-442f-8138-05b619d16def",
"ageAtInitial": 46,
"structure": "Austin",
"civilStatus": {
"formFieldPath": null,
"formFieldNamespace": null,
"encounter": {
"uuid": "6619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "94fb7f47-b80a-4056-9285-bd798be13c63",
"value": {
"uuid": "32d3611a-6699-4d52-823f-b4b788bac3e3",
"display": "SINGLE"
},
"concept": "89ca642a-dab6-4f20-b712-e12ca4fc6d36"
}
},
{
"country": "United States",
"encDate": "2022-08-27T00:00:00.000-0500",
"cd4": null,
"gender": "F",
"name": "Collet Test Chebaskwony",
"weight": {
"formFieldPath": null,
"formFieldNamespace": null,
"encounter": {
"uuid": "7619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "74fb7f47-b80a-4056-9285-bd798be13c63",
"value": 88.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd"
},
"ageCategory": "18+",
"uuid": "5946f880-b197-400b-9caa-a3c661d23041",
"ageAtInitial": 45,
"structure": "Austin",
"civilStatus": {
"formFieldPath": null,
"formFieldNamespace": null,
"encounter": {
"uuid": "7619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "04fb7f47-b80a-4056-9285-bd798be13c63",
"value": {
"uuid": "92afda7c-78c9-47bd-a841-0de0817027d4",
"display": "MARRIED"
},
"concept": "89ca642a-dab6-4f20-b712-e12ca4fc6d36"
}
},
{
"country": "Uganda",
"encDate": "2022-08-26T00:00:00.000-0500",
"cd4": {
"formFieldPath": null,
"formFieldNamespace": null,
"encounter": {
"uuid": "2619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "29218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "15fb7f47-b80a-4056-9285-bd798be13c63",
"value": 1060.0,
"concept": "a09ab2c5-878e-4905-b25d-5784167d0216"
},
"gender": "M",
"name": "Mr. Horatio Test Hornblower",
"weight": {
"formFieldPath": null,
"formFieldNamespace": null,
"encounter": {
"uuid": "4619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "44fb7f47-b80a-4056-9285-bd798be13c63",
"value": 84.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd"
},
"ageCategory": "18+",
"uuid": "da7f524f-27ce-4bb2-86d6-6d1d05312bd5",
"ageAtInitial": 47,
"structure": "Kampala",
"civilStatus": {
"formFieldPath": null,
"formFieldNamespace": null,
"encounter": {
"uuid": "4619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "84fb7f47-b80a-4056-9285-bd798be13c63",
"value": {
"uuid": "32d3611a-6699-4d52-823f-b4b788bac3e3",
"display": "SINGLE"
},
"concept": "89ca642a-dab6-4f20-b712-e12ca4fc6d36"
}
}
],
"resourceVersion": "1.8"
}
]
}
**
Endpoint** {SERVER_URL}/openmrs/ws/rest/v1/encounter?s=patientgridGetEncounterHistory&patient={PATIENT_UUID}&encounterType={ENCOUNTER_TYPE_UUID}&v=custom:obs:(uuid,concept:ref,value,formFieldNamespace,formFieldPath,encounter:(uuid,encounterType:ref)))
HTTP Method GET
Request Parameters
v Standard OpenMRS REST API request parameter to specify the representation to return, note that we are requesting for
a trimmed down response payload to just include the encounter observations and requesting specific fields for each
observation, if you need the full encounter and observations payloads, you can set the value to full
*s MUST always be set to patientgridGetEncounterHistory
*patient The UUID of the patient to match
*encounterType The UUID of the encounter type to match
Example Response ( Custom Representation)
{
"results": [
{
"obs": [
{
"uuid": "15fb7f47-b80a-4056-9285-bd798be13c63",
"concept": {
"uuid": "a09ab2c5-878e-4905-b25d-5784167d0216",
"display": "CD4 COUNT",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/concept/a09ab2c5-878e-4905-b25d-5784167d0216"
}
]
},
"value": 1060.0,
"formFieldNamespace": null,
"formFieldPath": null,
"encounter": {
"uuid": "2619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": {
"uuid": "29218f76-6c39-45f4-8efa-4c5c6c199f50",
"display": "Follow Up",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/encountertype/29218f76-6c39-45f4-8efa-4c5c6c199f50"
}
]
}
}
},
{
"uuid": "34fb7f47-b80a-4056-9285-bd798be13c63",
"concept": {
"uuid": "c607c80f-1ea9-4da3-bb88-6276ce8868dd",
"display": "WEIGHT (KG)",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/concept/c607c80f-1ea9-4da3-bb88-6276ce8868dd"
}
]
},
"value": 83.0,
"formFieldNamespace": null,
"formFieldPath": null,
"encounter": {
"uuid": "2619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": {
"uuid": "29218f76-6c39-45f4-8efa-4c5c6c199f50",
"display": "Follow Up",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/encountertype/29218f76-6c39-45f4-8efa-4c5c6c199f50"
}
]
}
}
}
]
}
]
}
Endpoint {SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/{GRID_UUID}/download
HTTP Method GET
Example Response See Grid Download Resource, ( Ref Representation)
Please pay extra attention to entries in the report that have key that is a UUID, and also the nested obs list values, for more see the note on obs value properties under Grid Download Resource
{
"results": [
{
"patientGrid": {
"uuid": "1d6c993e-c2cc-11de-8d13-0010c6dffd0a",
"display": "My Patients",
"links": [
{
"rel": "self",
"uri": "{SERVER_URL}/ws/rest/v1/patientgrid/patientgrid/1d6c993e-c2cc-11de-8d13-0010c6dffd0a"
}
]
},
"report": [
{
"country": "United States",
"gender": "M",
"name": "Johnny Test Doe",
"encDate": "2022-08-28T00:00:00.000-0500",
"29218f76-6c39-45f4-8efa-4c5c6c199f50": [
{
"6e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "9619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "29218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "25fb7f47-b80a-4056-9285-bd798be13c63",
"value": 1080.0,
"concept": "a09ab2c5-878e-4905-b25d-5784167d0216",
"formFieldNamespace": null
}
}
],
"19218f76-6c39-45f4-8efa-4c5c6c199f50": [
{
"4e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "6619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "64fb7f47-b80a-4056-9285-bd798be13c63",
"value": 72.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd",
"formFieldNamespace": null
},
"5e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "6619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "94fb7f47-b80a-4056-9285-bd798be13c63",
"value": {
"uuid": "32d3611a-6699-4d52-823f-b4b788bac3e3",
"display": "SINGLE"
},
"concept": "89ca642a-dab6-4f20-b712-e12ca4fc6d36",
"formFieldNamespace": null
}
}
],
"ageCategory": "18+",
"uuid": "a7e04421-525f-442f-8138-05b619d16def",
"ageAtInitial": 46,
"structure": "Austin"
},
{
"country": "United States",
"gender": "F",
"name": "Collet Test Chebaskwony",
"encDate": "2022-08-27T00:00:00.000-0500",
"29218f76-6c39-45f4-8efa-4c5c6c199f50": [
{
}
],
"19218f76-6c39-45f4-8efa-4c5c6c199f50": [
{
"4e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "7619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "74fb7f47-b80a-4056-9285-bd798be13c63",
"value": 88.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd",
"formFieldNamespace": null
},
"5e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "7619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "04fb7f47-b80a-4056-9285-bd798be13c63",
"value": {
"uuid": "92afda7c-78c9-47bd-a841-0de0817027d4",
"display": "MARRIED"
},
"concept": "89ca642a-dab6-4f20-b712-e12ca4fc6d36",
"formFieldNamespace": null
}
}
],
"ageCategory": "18+",
"uuid": "5946f880-b197-400b-9caa-a3c661d23041",
"ageAtInitial": 45,
"structure": "Austin"
},
{
"country": "Uganda",
"gender": "M",
"name": "Mr. Horatio Test Hornblower",
"encDate": "2022-08-26T00:00:00.000-0500",
"29218f76-6c39-45f4-8efa-4c5c6c199f50": [
{
"4e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "2619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "29218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "34fb7f47-b80a-4056-9285-bd798be13c63",
"value": 83.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd",
"formFieldNamespace": null
},
"6e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "2619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "29218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "15fb7f47-b80a-4056-9285-bd798be13c63",
"value": 1060.0,
"concept": "a09ab2c5-878e-4905-b25d-5784167d0216",
"formFieldNamespace": null
}
}
],
"19218f76-6c39-45f4-8efa-4c5c6c199f50": [
{
"4e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "1619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "24fb7f47-b80a-4056-9285-bd798be13c63",
"value": 82.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd",
"formFieldNamespace": null
}
},
{
"4e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "5619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "54fb7f47-b80a-4056-9285-bd798be13c63",
"value": 85.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd",
"formFieldNamespace": null
}
},
{
"4e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "4619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "44fb7f47-b80a-4056-9285-bd798be13c63",
"value": 84.0,
"concept": "c607c80f-1ea9-4da3-bb88-6276ce8868dd",
"formFieldNamespace": null
},
"5e6c993e-c2cc-11de-8d13-0010c6dffd0b": {
"formFieldPath": null,
"encounter": {
"uuid": "4619d653-393b-4118-9e83-a3715b82d4ac",
"encounterType": "19218f76-6c39-45f4-8efa-4c5c6c199f50"
},
"uuid": "84fb7f47-b80a-4056-9285-bd798be13c63",
"value": {
"uuid": "32d3611a-6699-4d52-823f-b4b788bac3e3",
"display": "SINGLE"
},
"concept": "89ca642a-dab6-4f20-b712-e12ca4fc6d36",
"formFieldNamespace": null
}
}
],
"ageCategory": "18+",
"uuid": "da7f524f-27ce-4bb2-86d6-6d1d05312bd5",
"ageAtInitial": 47,
"structure": "Kampala"
}
],
"resourceVersion": "1.8"
}
]
}