Procedure data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the procedure |
created_at | string (date-time) | No | When the procedure record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the procedure record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient the procedure was performed on |
encounter_id | string | No | The encounter in which the procedure was performed |
practitioner_ids | string[] | No | The practitioners who performed the procedure |
location_id | string | No | Where the procedure was performed |
condition_ids | string[] | No | Conditions that justified the procedure |
name | string | No | Human-readable name of the procedure |
codes | HealthcareCode[] | No | Codings for the procedure (e.g. CPT, SNOMED CT) |
codes[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
codes[].code | string | No | The code within the system |
codes[].display | string | No | Human-readable display text for the code |
status | enum | No | Status of the procedure Values: PREPARATION, IN_PROGRESS, NOT_DONE, ON_HOLD, STOPPED, COMPLETED, ENTERED_IN_ERROR, UNKNOWN, OTHER |
reasons | HealthcareCode[] | No | Codings for the reason the procedure was performed |
reasons[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
reasons[].code | string | No | The code within the system |
reasons[].display | string | No | Human-readable display text for the code |
body_sites | HealthcareCode[] | No | Codings for the anatomical locations of the procedure |
body_sites[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
body_sites[].code | string | No | The code within the system |
body_sites[].display | string | No | Human-readable display text for the code |
start_at | string (date-time) | No | When the procedure was performed (or started) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | When the procedure ended (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
notes | string | No | Free-text notes about the procedure |
metadata | HealthcareMetadata[] | No | Custom field values |
metadata[].id | string | No | Identifier of the custom field |
metadata[].value | object | No | The custom field value |
metadata[].namespace | string | No | The scope or origin of the custom field |
metadata[].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | Additional data about the custom field |
metadata[].slug | string | No | The custom field key |
Are we missing anything? Let us know