Procedure API endpoint
Something done to a subject, such as a surgery, an implant or an injection, with fields that depend on its type.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/modules/procedure/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/modules/procedure/(read-only, public projects, no token) - Response keys:
procedure(detail, create, update),procedures(list) - Permissions: inherited through
subject→projects(fromproject) - Schema payload:
typeselects a Procedure type; send its fields indetails.type_schema_versionis set by the server; do not send it. - Schema payload:
coordinates_systemselects a Coordinates type; send its fields incoordinates_details.coordinates_schema_versionis set by the server; do not send it. - Deleting: also deletes the linked
materialusage,procedurelogrecords
Fields
[required] fields must be sent on create; [read-only] fields are returned but cannot be set. A nestable relation can be traversed in filters (filter{field.other}) and sideloaded with include[]=field.*; other relations can only be compared with ids (filter{field}=<id>). See the query syntax.
| Field | Description |
|---|---|
id | UUID string [read-only] |
type | one of the Procedure types [required] |
status | one of planned, performed, cancelled [required]. Planned: prepared but nothing has happened yet. Performed: this record describes what was done. Cancelled: planned and then dropped; kept for the record. |
notes | string; max 500 characters; nullable |
subject | subject id [required]; nestable |
procedure_episode | procedureepisode id; nullable. Perioperative episode this procedure belongs to. |
performed_by | user id; nullable. Person who physically performed this procedure (may differ from the record creator). |
date_time | datetime; nullable |
licenses | list of license ids. Licenses authorizing this specific procedure |
protocol | protocol id; nullable |
equipment | list of equipment ids |
details | JSON object |
target_regions | list of anatomicalregion ids; nestable |
coordinates_system | one of the Coordinates types [required] |
coordinates_details | JSON object |
updated_at | datetime [read-only] |
created_at | datetime [read-only]; nullable |
type_schema_version | string [set by the server]. Schema version for type_json field |
coordinates_schema_version | string [set by the server]. Schema version for coordinates_json field |
anatomical_reference | anatomicalreference id; nullable |
coordinate_transform | coordinatetransform id; nullable |
materials | computed [read-only] |
stages | computed [read-only] |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/modules/procedure/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('procedure', load_all=True)
records = resp['procedures']
Use example (MATLAB API tool)
resp = client.load('procedure', 'load_all', true);
records = resp.procedures;
Response example
{
"procedures": [
{
"id": "<id>",
"type": "Analgesic",
"status": "performed",
"notes": "",
"subject": "<subject-id>",
"procedure_episode": "<procedureepisode-id>",
"performed_by": "<user-id>",
"date_time": "2024-03-22T10:30:00Z",
"licenses": [
"<license-id>"
],
"protocol": "<protocol-id>",
"equipment": [
"<equipment-id>"
],
"details": {
"...": "see the schema of the selected type"
},
"target_regions": [
"<anatomicalregion-id>"
],
"coordinates_system": "",
"coordinates_details": {
"...": "see the schema of the selected type"
},
"updated_at": "2024-03-22T10:30:00Z",
"created_at": "2024-03-22T10:30:00Z",
"type_schema_version": "set by the server",
"coordinates_schema_version": "set by the server",
"anatomical_reference": "<anatomicalreference-id>",
"coordinate_transform": "<coordinatetransform-id>",
"materials": null,
"stages": null
}
],
"meta": {
"page": 1,
"per_page": 100,
"total_results": 1,
"total_pages": 1
}
}
Add
- Allowed portals: private
- Request method: POST
- URL:
https://www.brainstem.org/api/private/modules/procedure/ - Data: JSON object with at least the required fields
- Responses:
201Created;400Bad request (validation errors per field);403Not allowed
Use example (Python API tool)
resp = client.save('procedure', data={"type": "Anesthesia", "status": "performed", "subject": "<subject-id>", "details": {"...": "see the schema of the selected type"}, "coordinates_system": "Stereotaxic_BregmaBrainSurface", "coordinates_details": {"...": "the fields of the selected Coordinates type"}})
record = resp.json()['procedure']
Use example (MATLAB API tool)
created = client.save(struct('type', 'Anesthesia', 'status', 'performed', 'subject', '<subject-id>', 'details', struct(), 'coordinates_system', 'Stereotaxic_BregmaBrainSurface', 'coordinates_details', struct()), 'procedure'); % struct() stands for the fields of the selected type
record = created.procedure;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/modules/procedure/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('procedure', id='<id>')
record = resp.json()['procedure']
Use example (MATLAB API tool)
out = client.load('procedure', 'id', '<id>');
record = out.procedure;
Response example
{
"procedure": {
"id": "<id>",
"type": "Analgesic",
"status": "performed",
"notes": "",
"subject": "<subject-id>",
"procedure_episode": "<procedureepisode-id>",
"performed_by": "<user-id>",
"date_time": "2024-03-22T10:30:00Z",
"licenses": [
"<license-id>"
],
"protocol": "<protocol-id>",
"equipment": [
"<equipment-id>"
],
"details": {
"...": "see the schema of the selected type"
},
"target_regions": [
"<anatomicalregion-id>"
],
"coordinates_system": "",
"coordinates_details": {
"...": "see the schema of the selected type"
},
"updated_at": "2024-03-22T10:30:00Z",
"created_at": "2024-03-22T10:30:00Z",
"type_schema_version": "set by the server",
"coordinates_schema_version": "set by the server",
"anatomical_reference": "<anatomicalreference-id>",
"coordinate_transform": "<coordinatetransform-id>",
"materials": null,
"stages": null
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/modules/procedure/<id>/ - Data: JSON object with the fields to change. Lists (
projects,tags, …) and JSON payloads (details, coordinates) are replaced as a whole: read the record first and send the full list or object. - Responses:
200OK;400Bad request;403Not allowed;404Not found
Use example (Python API tool)
resp = client.save('procedure', id='<id>', data={"notes": "new value"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'notes', 'new value'), 'procedure', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/modules/procedure/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('procedure', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'procedure');
Custom actions
| Action | Request |
|---|---|
apply_material_template | POST /api/private/modules/procedure/<id>/apply-material-template/ |
coordinate_context_options | GET /api/private/modules/procedure/coordinate-context-options/ |
coordinate_preview | POST /api/private/modules/procedure/coordinate-preview/ |
saved_coordinate_preview | GET /api/private/modules/procedure/<id>/coordinate-preview/ |
material_options | GET /api/private/modules/procedure/material-options/ |
materials | GET, PUT /api/private/modules/procedure/<id>/materials/ |
materials returns the ordered material usage rows of the procedure; PUT replaces them as a whole (a stale list is refused with 409). apply-material-template copies the rows of a material usage template onto the procedure. material-options lists the material roles and allowed sources of a procedure type (?type=<Type>). coordinate-preview renders the saved or posted coordinates in the atlas of the subject’s species.
Data model
The fields are described for the web forms on the Procedure data model page.