What is an Event?
An event is an occurrence of an action that happens within Canvas. For example, a patient being prescribed a medication, a user searching for a condition or an appointment being created are all examples of events.
Why should I use them?
By writing plugins that respond to events, plugin code is notified and can react to events that occur in Canvas. This enables plugin authors to create custom workflows whenever a relevant event takes place, such as making a POST request to a webhook.
How do I use them?
To make plugin code react to an event, you can add the event types listed below into the RESPONDS_TO list of a plugin that inherits from BaseHandler. For example:
from canvas_sdk.events import EventType
from canvas_sdk.handlers import BaseHandler
class MyHandler ( BaseHandler ):
RESPONDS_TO = [ EventType . Name ( EventType . ALLERGY_INTOLERANCE_CREATED )]
def compute ( self ):
...
The plugin author can enter custom workflow code into the compute method that will execute every time an Allergy Intolerance is created in Canvas.
For more information on writing plugins, see the guide here .
A handler's compute method runs only for the events listed in its RESPONDS_TO, which can be a single event name or a list. A handler with no RESPONDS_TO, or one that leaves out the event you expect, installs and enables without error but never runs. If compute never fires, check that RESPONDS_TO names the right event.
Sending outbound webhooks # A common pattern is to send an outbound webhook to a third-party system when something changes in Canvas. To do this, write a handler that responds to the relevant events, builds a custom payload, and sends it to your external URL (see making HTTP requests ). You have full control over the payload shape. The event itself typically gives you the entity id and patient id; use the data modules to enrich the payload with additional details — for example, retrieve a patient’s email address from a PatientContactPointsecret rather than hard-coding it.
For firewall allowlisting, outbound events (such as note state change webhooks) are sent from one of three static source IP addresses:
52.70.89.1554.86.133.23534.197.78.70 Event Actor # The actor is the user that initiated the event. It can be accessed within the compute method of the plugin by self.event.actor. For side-effect events or automated events where the action cannot be attributed to a specific user, the actor may be absent.
The actor is available in the following contexts:
SimpleAPI Action button Application Note state change events — NOTE_STATE_CHANGE_EVENT_PRE_CREATE, NOTE_STATE_CHANGE_EVENT_CREATED, NOTE_STATE_CHANGE_EVENT_UPDATEDNote UI events — NOTE_OPENED, NOTE_CLOSEDNote restrictions events — GET_NOTE_RESTRICTIONSNote footer events — NOTE_FOOTER__GET_CONFIGURATIONPhone dial events — PHONE_DIAL__GET_CONFIGURATION, PHONE_NUMBER_CLICKEDAppointment scheduling events — all APPOINTMENT__* eventsPatient chart and profile events — all PATIENT_CHART__* events (conditions, medications, detected issues, etc.), chart summary configuration, panel sections, and patient metadataPatient timeline events — PATIENT_TIMELINE__GET_CONFIGURATIONHomepage events — GET_HOMEPAGE_CONFIGURATIONCommand additional-fields events — COMMAND__FORM__GET_ADDITIONAL_FIELDSLab order command events — LAB_ORDER_COMMAND__PRE_SEND, HEALTH_GORILLA_LAB_ORDER_PREPAREDClaim events — CLAIM__CONDITIONSSSO events — SSO__PROCESS_ADDITIONAL_REQUEST_DATA, SSO__GET_POST_LOGIN_REDIRECTPayment processor events — all REVENUE__PAYMENT_PROCESSOR__* eventsStored card charge events — REVENUE__STORED_CARD__CHARGE_RESPONSE, carrying the actor of the effect that requested the chargePatient portal events — all PATIENT_PORTAL__* eventsfrom canvas_sdk.effects import Effect
from canvas_sdk.handlers import BaseHandler
from logger import log
class CustomHandler ( BaseHandler ):
RESPONDS_TO = []
def compute ( self ) -> list [ Effect ]:
actor = self . event . actor
log . info ( actor . dbid ) # The database ID of the actor, if available
log . info ( actor . instance ) # The corresponding CanvasUser instance
log . info ( actor . instance . person_subclass ) # The corresponding Staff or Patient instance
return []
Event Types and Context # The event target object can be accessed within the compute method of the plugin by self.event.target. If self.event.target.type exists, it provides the same type that would be imported from the Data module. For example, a type of Condition would be the same as what you can import from canvas_sdk.v1.data.condition.
The event context object can be accessed via self.event.context. The content present in each event’s context depends on the event type. The table below shows what you can expect for each event type, or you could take a look yourself by logging it out.
Common Context Patterns # Many events include common contextual information to help you understand the scope and origin of the event:
Patient context : Most patient-related events include "patient": {"id": pt_id} in the context, allowing you to identify which patient the event relates to.Note context : Command lifecycle events (PRE_COMMIT, POST_COMMIT, etc.) include "note": {"uuid": note_id} in the context, indicating the note where the command was executed.User context : All command-related PRE_SEARCH and POST_SEARCH events include "user": {"staff": staff_key} in the context, containing the staff key of the user performing the search. This allows you to customize search results based on user-specific preferences, roles, or permissions.Search results context : Command POST_SEARCH events include "results", the list the search returned. Command PRE_SEARCH events fire before the search runs, so their context holds only search_term and user. To modify the results a search returns, respond to the POST_SEARCH event. When several handlers respond to the same PRE_SEARCH event, a handler that runs after one that returned an AUTOCOMPLETE_SEARCH_RESULTS effect finds those results in "results".from canvas_sdk.events import EventType
from canvas_sdk.handlers import BaseHandler
from logger import log
class MyHandler ( BaseHandler ):
RESPONDS_TO = [ EventType . Name ( EventType . ALLERGY_INTOLERANCE_CREATED )]
def compute ( self ):
log . info ( self . event . context )
return []
Record lifecycle events # These events fire as a result of records being created, updated, or deleted.
Patients # PATIENT_CREATED Occurs when a patient is created. Target object Context object "id": pt_id
"type": Patient empty
When a patient is created through the FHIR API, Canvas saves the patient and fires PATIENT_CREATED before it saves the patient's external identifiers. It then fires PATIENT_EXTERNAL_IDENTIFIER_CREATED for each identifier, and only then does the FHIR create finish. So a PATIENT_CREATED handler can't see the identifiers yet. To act on them, for example to recognize a patient your own FHIR POST created, listen for PATIENT_EXTERNAL_IDENTIFIER_CREATED instead.
PATIENT_UPDATED Occurs when a patient's data is updated. Target object Context object "id": pt_id
"type": Patient empty
PATIENT_PREFERRED_PHARMACY_UPDATED Occurs when a patient's preferred pharmacy is created or updated. Target object Context object "id": pt_id
"type": Patient "patient":
"id": pt_id
CARE_TEAM_MEMBERSHIP_CREATED Occurs when a new care team member is added for a patient. Target object Context object "id": care_team_membership_id
"type": CareTeamMembership "patient":
"id": pt_id
CARE_TEAM_MEMBERSHIP_UPDATED Occurs when a care team member is adjusted for a patient. Target object Context object "id": care_team_membership_id
"type": CareTeamMembership "patient":
"id": pt_id
CARE_TEAM_MEMBERSHIP_DELETED Occurs when a care team member is removed for a patient. Target object Context object "id": care_team_membership_id
"type": CareTeamMembership "patient":
"id": pt_id
PATIENT_ADDRESS_CREATED Occurs when an address is added for a patient. Target object Context object "id": address_id
"type": PatientAddress "patient":
"id": pt_id
PATIENT_ADDRESS_UPDATED Occurs when one of a patient's addresses is updated. Target object Context object "id": address_id
"type": PatientAddress "patient":
"id": pt_id
PATIENT_ADDRESS_DELETED Occurs when one of a patient's addresses is removed. Target object Context object "id": address_id
"type": PatientAddress "patient":
"id": pt_id
PATIENT_CONTACT_PERSON_CREATED Occurs when a contact is added for a patient. Target object Context object "id": contact_person_id
"type": None "patient":
"id": pt_id
PATIENT_CONTACT_PERSON_UPDATED Occurs when one of a patient's contacts is updated. Target object Context object "id": contact_person_id
"type": None "patient":
"id": pt_id
PATIENT_CONTACT_PERSON_DELETED Occurs when one of a patient's contacts is removed. Target object Context object "id": contact_person_id
"type": None "patient":
"id": pt_id
PATIENT_CONTACT_POINT_CREATED Occurs when a contact method for a patient is added. Target object Context object "id": contact_point_id
"type": PatientContactPoint "patient":
"id": pt_id
PATIENT_CONTACT_POINT_UPDATED Occurs when a contact method for a patient is updated. Target object Context object "id": contact_point_id
"type": PatientContactPoint "patient":
"id": pt_id
PATIENT_CONTACT_POINT_DELETED Occurs when a contact method for a patient is removed. Target object Context object "id": contact_point_id
"type": PatientContactPoint "patient":
"id": pt_id
PATIENT_EXTERNAL_IDENTIFIER_CREATED Occurs when an external identifier is created for a patient. Target object Context object "id": patientexternalidentifier_id
"type": PatientExternalIdentifier "patient":
"id": pt_id
PATIENT_EXTERNAL_IDENTIFIER_UPDATED Occurs when an external identifier for a patient is updated. Target object Context object "id": patientexternalidentifier_id
"type": PatientExternalIdentifier "patient":
"id": pt_id
PATIENT_EXTERNAL_IDENTIFIER_DELETED Occurs when an external identifier for a patient is deleted. Target object Context object "id": patientexternalidentifier_id
"type": PatientExternalIdentifier "patient":
"id": pt_id
Patient Facility Address # PATIENT_FACILITY_ADDRESS_CREATED Occurs when a patient facility address is created. Target object Context object "id": patientfacilityaddress_id
"type": PatientFacilityAddress "patient":
"id": pt_id
PATIENT_FACILITY_ADDRESS_UPDATED Occurs when a patient facility address is updated. Target object Context object "id": patientfacilityaddress_id
"type": PatientFacilityAddress "patient":
"id": pt_id
PATIENT_FACILITY_ADDRESS_DELETED Occurs when a patient facility address is deleted. Deleting a facility address also fires PATIENT_ADDRESS_DELETED (see note below). Target object Context object "id": patientfacilityaddress_id
"type": PatientFacilityAddress "patient":
"id": pt_id
Facility addresses have their own PATIENT_FACILITY_ADDRESS_* events. Assigning a facility to a patient fires PATIENT_FACILITY_ADDRESS_CREATED only, not PATIENT_ADDRESS_CREATED. Deleting one fires both PATIENT_FACILITY_ADDRESS_DELETED and PATIENT_ADDRESS_DELETED. Listen for the PATIENT_FACILITY_ADDRESS_* events for every facility address change.
Patient Metadata # PATIENT_METADATA_CREATED Occurs when a patient's metadata is created. Target object Context object "id": patientmetadata_id
"type": PatientMetadata "patient":
"id": pt_id
PATIENT_METADATA_UPDATED Occurs when a patient's metadata is updated. Target object Context object "id": patientmetadata_id
"type": PatientMetadata "patient":
"id": pt_id
Allergy Intolerances # ALLERGY_INTOLERANCE_CREATED Occurs when an allergy is created for a patient. Additional details for the allergy may become available with subsequent ALLERGY_INTOLERANCE_UPDATED events. Target object Context object "id": allergy_id
"type": AllergyIntolerance "patient":
"id": pt_id
ALLERGY_INTOLERANCE_UPDATED Occurs when an allergy is updated for a patient. Target object Context object "id": allergy_id
"type": AllergyIntolerance "patient":
"id": pt_id
Appointments # To keep an external system in sync with appointment changes made in the Canvas UI (for example, an onboarding flow that tracks whether a patient has scheduled their intake), listen for the appointment lifecycle events and post a webhook to your system. The appointment-sync-webhook reference plugin demonstrates this: it responds to APPOINTMENT_CREATED, APPOINTMENT_CANCELED, and APPOINTMENT_NO_SHOWED, fetches the full appointment details, builds a payload with appointment and patient information, and sends an HTTP POST to a webhook URL configured as a plugin secret .
APPOINTMENT_CREATED Occurs when an appointment is first created/booked. Target object Context object "id": appointment_id
"type": Appointment "patient":
"id": pt_id
APPOINTMENT_UPDATED Occurs when details of an appointment are updated. Target object Context object "id": appointment_id
"type": Appointment "patient":
"id": pt_id
APPOINTMENT_CHECKED_IN Occurs when a patient has arrived and been checked in for their appointment. Target object Context object "id": appointment_id
"type": Appointment "patient":
"id": pt_id
APPOINTMENT_RESTORED Occurs when a cancelled appointment is restored to a non-cancelled status. Target object Context object "id": appointment_id
"type": Appointment "patient":
"id": pt_id
APPOINTMENT_CANCELED Occurs when an appointment is cancelled. Target object Context object "id": appointment_id
"type": Appointment "patient":
"id": pt_id
APPOINTMENT_NO_SHOWED Occurs when an appointment is marked as a no-show. Target object Context object "id": appointment_id
"type": Appointment "patient":
"id": pt_id
APPOINTMENT_RESCHEDULED Occurs when an appointment is rescheduled by cancelling it and creating a replacement, which is what the provider UI, the patient portal, and the Appointment effect's reschedule() all do. The target is the new appointment, and APPOINTMENT_CREATED fires for it as well. Moving an appointment by updating it in place instead, through the Appointment effect's update() or the FHIR API, fires only APPOINTMENT_UPDATED. See Detecting rescheduled appointments . Target object Context object "id": appointment_id
"type": Appointment "patient":
"id": pt_id
APPOINTMENT_LABEL_ADDED Occurs when one or more labels are added to an appointment. Target object Context object "id": appointment_id
"type": None "patient":
"id": pt_id
"label": label_name
APPOINTMENT_LABEL_REMOVED Occurs when one or more labels are removed from an appointment. Target object Context object "id": appointment_id
"type": None "patient":
"id": pt_id
"label": label_name
APPOINTMENT__SLOTS__POST_SEARCH Occurs when requesting slot availability when scheduling an appointment. Target object Context object "slots_by_provider": list[dict] "selected_values": dict
APPOINTMENT__FORM__PROVIDERS__PRE_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "category": NoteTypeCategories
APPOINTMENT__FORM__PROVIDERS__POST_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "providers": list[dict]
"selected_values": dict
"category": NoteTypeCategories
APPOINTMENT__FORM__LOCATIONS__PRE_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "category": NoteTypeCategories
APPOINTMENT__FORM__LOCATIONS__POST_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "locations": list[dict]
"selected_values": dict
"category": NoteTypeCategories
APPOINTMENT__FORM__VISIT_TYPES__PRE_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "category": NoteTypeCategories
APPOINTMENT__FORM__VISIT_TYPES__POST_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "visit_types": list[dict]
"selected_values": dict
"category": NoteTypeCategories
APPOINTMENT__FORM__DURATIONS__PRE_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "category": NoteTypeCategories
APPOINTMENT__FORM__DURATIONS__POST_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "durations": list[dict]
"selected_values": dict
"category": NoteTypeCategories
APPOINTMENT__FORM__REASON_FOR_VISIT__PRE_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "category": NoteTypeCategories
APPOINTMENT__FORM__REASON_FOR_VISIT__POST_SEARCH Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "reason_for_visit": list[dict]
"selected_values": dict
"category": NoteTypeCategories
APPOINTMENT__FORM__GET_ADDITIONAL_FIELDS Occurs when a schedule appointment form is loaded. Target object Context object "id": appointment_id
"type": Appointment "category": NoteTypeCategories
APPOINTMENT__FORM__UPDATED Occurs when a schedule appointment form is updated. Target object Context object "id": appointment_id
"type": Appointment "patient_id": int
"selected_values": dict
"category": NoteTypeCategories
Command Metadata # COMMAND_METADATA_CREATED Occurs when metadata is created on a command. Target object Context object "id": commandmetadata_id
"type": CommandMetadata empty
COMMAND_METADATA_UPDATED Occurs when metadata on a command is updated. Target object Context object "id": commandmetadata_id
"type": CommandMetadata empty
Appointment Metadata # APPOINTMENT_METADATA_CREATED Occurs when an appointment's metadata is created. Target object Context object "id": appointmentmetadata_id
"type": AppointmentMetadata "appointment":
"id": appointment_id
"patient": # present only when the appointment has a patient
"id": pt_id
APPOINTMENT_METADATA_UPDATED Occurs when an appointment's metadata is updated. Target object Context object "id": appointmentmetadata_id
"type": AppointmentMetadata "appointment":
"id": appointment_id
"patient": # present only when the appointment has a patient
"id": pt_id
Claims # CLAIM_CREATED Occurs when a claim is created. Target object Context object "id": claim_id
"type": Claim "patient":
"id": pt_id
"note":
"id": note_id
CLAIM_UPDATED Occurs when a claim is updated. Target object Context object "id": claim_id
"type": Claim "patient":
"id": pt_id
"note":
"id": note_id
CLAIM_QUEUE_MOVED Occurs when a claim moves from one queue to another. Target object Context object "id": claim_id
"type": Claim "patient":
"id": pt_id
"note":
"id": note_id
"queue_entered":
"id": queue_id
"queue_exited":
"id": queue_id
CLAIM__CONDITIONS Fires when the conditions list is loaded inside the claim summary view. Plugins can use this event to surface plugin-specific diagnosis information alongside the existing diagnosis codes on the claim. Target object Context object "id": claim_id
"type": Claim [
"id": str,
"codings": [
"code": str,
"system": str,
"display": str
]
]
CLAIM_SUPERVISING_PROVIDER_CHANGED Occurs when a claim's supervising provider snapshot is created or updated. The context includes the previous value(s) of any changed fields. Target object Context object "id": claim_id
"type": Claim "previous": null | {
"first_name": str,
"last_name": str,
...
}
CLAIM_INCIDENT_TO_CHANGED Occurs when a claim's incident_to billing flag is changed. The context includes the previous boolean value. Target object Context object "id": claim_id
"type": Claim "previous": bool
CLAIM_BALANCE_CHANGED Occurs when a claim's patient balance or aggregate coverage balance changes. Use it to follow payments as they post and to see when the amount the patient or their insurance owes changes. A balance can change from:Payments collected in Canvas, from the claim, from the patient's billing, or by the patient in the patient portal Insurance payments and adjustments from remittances (ERAs) and manual remits Payments recorded through the FHIR PaymentNotice API, including copays Payments posted by plugins, with ClaimEffect.post_paymentstored card charge Adjustments, write-offs, and transfers of a balance between payers or to the patient Changes to the claim's charges or coverages previous holds the balances from before the transaction's first change, so previous and current show the net change. Balances are strings with two decimal places, such as "150.00" or "-12.50". To react to balance changes, use this event instead of CLAIM_UPDATED, which fires on every claim save and doesn't include balances. Target object Context object "id": claim_id
"type": Claim "patient": # present only when the claim's note has a patient
"id": pt_id
"note": # present only when the claim has a note
"id": note_id
"previous":
"patient_balance": str
"aggregate_coverage_balance": str
"current":
"patient_balance": str
"aggregate_coverage_balance": str
Billing Line Items # BILLING_LINE_ITEM_CREATED Occurs when a billing line item is created from adding a CPT code to a note. Target object Context object "id": billing_line_item_id
"type": BillingLineItem "patient":
"id": pt_id
BILLING_LINE_ITEM_UPDATED Occurs when a billing line item is modified. Target object Context object "id": billing_line_item_id
"type": BillingLineItem "patient":
"id": pt_id
Calendars # CALENDAR_CREATED Occurs when a calendar is created. Target object Context object "id": calendar_id
"type": Calendar empty
CALENDAR_UPDATED Occurs when a calendar is updated. Target object Context object "id": calendar_id
"type": Calendar empty
CALENDAR_DELETED Occurs when a calendar is deleted. Target object Context object "id": calendar_id
"type": Calendar empty
Calendar Events # CALENDAR_EVENT_CREATED Occurs when a calendar event is created. Target object Context object "id": event_id
"type": Event empty
CALENDAR_EVENT_UPDATED Occurs when a calendar event is updated. Target object Context object "id": event_id
"type": Event empty
CALENDAR_EVENT_DELETED Occurs when a calendar event is deleted. Target object Context object "id": event_id
"type": Event empty
Patient Payments # PATIENT_PAYMENT_PROCESSED Occurs when a patient payment is processed in Canvas. Target object Context object "id": pt_id
"type": Patient "patient_id": str
"total_amount_cents": str
"timestamp": str
"payment_method_and_description": str
"claim_payments": [
{
"claim_id": str,
"allocated_cents": str
}
]
Clinical Documents # These events fire during the lifecycle of documents in the Data Integration module — including inbound faxes, uploaded documents, and electronic transmissions. Each event’s context includes document metadata from the underlying IntegrationTask .
Use DOCUMENT_RECEIVED to automate inbound-document intake, such as inbound faxes. It fires when a new IntegrationTask is created, from any channel (fax, document upload, lab, and so on).
Getting the file: the event context carries the file URL as document["content_url"]. The IntegrationTask data class doesn’t include the file, so this event is where you get it. Fetch it with requests.get(document["content_url"]), and check document["channel"] first if you only want one channel.Following one document: every event in this family uses the IntegrationTask UUID as its target and document["id"], so you can match one document across DOCUMENT_RECEIVED, DOCUMENT_LINKED_TO_PATIENT, DOCUMENT_CATEGORIZED, DOCUMENT_REVIEWER_ASSIGNED, DOCUMENT_REVIEWED, and DOCUMENT_DELETED.After it’s filed to a chart: use the DocumentReference data class, which has a presigned document_url.DOCUMENT_RECEIVED Occurs when a new clinical document is received via fax, upload, or electronic transmission. Target object Context object "id": document_id
"type": IntegrationTask "document":
"id": document_id
"channel": str
"status": str
"title": str
"type": str
"content_url": str
"content_type": str
"created_at": datetime str
"patient":
"id": pt_id
"available_document_types":
"key": str
"name": str
"report_type": str
"template_type": str
"template_fields":
"name": str
"label": str
"type": str
"required": bool
DOCUMENT_LINKED_TO_PATIENT Occurs when a clinical document is linked to a patient. Target object Context object "id": document_id
"type": IntegrationTask "document":
"id": document_id
"channel": str
"status": str
"title": str
"type": str
"content_url": str
"content_type": str
"created_at": datetime str
"patient":
"id": pt_id
"previous_patient":
"id": pt_id
"linked_at": datetime str
"available_document_types":
"key": str
"name": str
"report_type": str
"template_type": str
"template_fields":
"name": str
"label": str
"type": str
"required": bool
DOCUMENT_CATEGORIZED Occurs when a clinical document is categorized. Target object Context object "id": document_id
"type": IntegrationTask "document":
"id": document_id
"channel": str
"status": str
"title": str
"type": str
"content_url": str
"content_type": str
"created_at": datetime str
"document_type":
"key": str
"name": str
"report_type": str
"template_type": str
"previous_document_type":
"key": str
"name": str
"report_type": str
"template_type": str
"categorized_at": datetime str
"patient":
"id": pt_id
DOCUMENT_REVIEWER_ASSIGNED Occurs when a reviewer (Staff or Team) is assigned or reassigned on the Data Integration document review panel. This does not fire when a reviewer is assigned on a LabReport or ImagingReport — only when the IntegrationTaskReview reviewer changes. Target object Context object "id": document_id
"type": IntegrationTask "document":
"id": document_id
"channel": str
"status": str
"title": str
"type": str
"content_url": str
"content_type": str
"created_at": datetime str
"assigned_at": datetime str
"reviewer":
"type": str
"id": reviewer_id
"name": str
"previous_reviewer":
"type": str
"id": reviewer_id
"name": str
"patient":
"id": pt_id
DOCUMENT_REVIEWED Occurs when a clinical document is marked as reviewed. This fires when the Data Integration task status changes to reviewed, or when a Lab Results Review, Imaging Report Review, Consult Report Review, or Uncategorized Document Review command is committed. Target object Context object "id": document_id
"type": IntegrationTask "document":
"id": document_id
"channel": str
"status": str
"title": str
"type": str
"content_url": str
"content_type": str
"created_at": datetime str
"review":
"reviewer":
"type": str
"id": reviewer_id
"name": str
"status": str
"patient_communication_method": str
"internal_comment": str
"message_to_patient": str
"reviewed_at": datetime str
"document_type":
"key": str
"name": str
"report_type": str
"template_type": str
"patient":
"id": pt_id
DOCUMENT_DELETED Occurs when a document is junked/deleted from the Data Integration panel. This does not fire when a report is junked from the patient chart. Target object Context object "id": document_id
"type": IntegrationTask "document":
"id": document_id
"channel": str
"status": str
"title": str
"type": str
"content_url": str
"content_type": str
"created_at": datetime str
"deleted_at": datetime str
"patient":
"id": pt_id
"document_type":
"key": str
"name": str
"report_type": str
"template_type": str
"deleted_by":
"id": user_id
"name": str
DOCUMENT_FIELDS_UPDATED Occurs when a clinical document's fields are updated. This fires when a Lab Report, Imaging Report, or Specialist Consult Report is parsed and its values are saved. The updated_fields list contains each changed field with its new and previous values. Target object Context object "id": document_id
"type": IntegrationTask "document":
"id": document_id
"channel": str
"status": str
"title": str
"type": str
"content_url": str
"content_type": str
"created_at": datetime str
"patient":
"id": pt_id
"updated_fields":
"name": str
"value": str | int | float | bool
"previous_value": str | int | float | bool | None
"document_type":
"key": str
"name": str
"report_type": str
"template_type": str
"updated_at": datetime str
Document Review Delegation # The DOCUMENT_DELEGATED event fires when an uncategorized clinical document’s review is delegated to another staff member or team, or routed back to its owner. It is a review-workflow event, separate from the Data Integration document-lifecycle events above.
DOCUMENT_DELEGATED Occurs when an uncategorized clinical document review is delegated to another staff member or team from the document review surface, or routed back to its owner. This is distinct from DOCUMENT_REVIEWER_ASSIGNED, which fires only for Data Integration reviewer changes. signature_consent indicates whether the recipient may apply the owner's signature; routed_back is true when the document was returned to its owner; comment carries the delegator's instructions. Target object Context object "id": document_id
"type": IntegrationTask "document": UncategorizedClinicalDocument
"id": document_id
"channel": str
"status": str
"title": str
"type": str
"content_url": str
"content_type": str
"created_at": datetime str
"delegated_at": datetime str
"delegated_by": Staff
"type": str ("STAFF")
"id": staff_id
"name": str
"delegated_to": Staff or Team
"type": str ("STAFF" or "TEAM")
"id": staff_or_team_id
"name": str
"on_behalf_of": Staff
"type": str ("STAFF")
"id": staff_id
"name": str
"signature_consent": bool
"routed_back": bool
"comment": str
"patient": Patient
"id": pt_id
Conditions # CONDITION_ASSESSED Occurs when a condition is assessed through the Assess Condition command. Target object Context object "id": condition_id
"type": Condition "patient":
"id": pt_id
CONDITION_CREATED Occurs when a condition is diagnosed for a patient. Additional details for the condition may become available with subsequent CONDITION_UPDATED events. Target object Context object "id": condition_id
"type": Condition "patient":
"id": pt_id
CONDITION_RESOLVED Occurs when a condition is resolved through the Resolve Condition command. Target object Context object "id": condition_id
"type": Condition "patient":
"id": pt_id
CONDITION_UPDATED Occurs when a condition is updated for a patient, including when committing an Assess command moves it onto or off the problem list. Target object Context object "id": condition_id
"type": Condition "patient":
"id": pt_id
Consents # CONSENT_CREATED Occurs when a patient consent is created. Target object Context object "id": consent_id
"type": None "patient":
"id": pt_id
CONSENT_DELETED Occurs when a patient consent is removed/deleted. Target object Context object "id": consent_id
"type": None "patient":
"id": pt_id
CONSENT_UPDATED Occurs when a patient consent is updated. Target object Context object "id": consent_id
"type": None "patient":
"id": pt_id
Coverages # COVERAGE_CREATED Occurs when a coverage for a patient is created. Target object Context object "id": coverage_id
"type": Coverage "patient":
"id": pt_id
COVERAGE_UPDATED Occurs when a coverage for a patient is updated. Target object Context object "id": coverage_id
"type": Coverage "patient":
"id": pt_id
Eligibility responses # A COVERAGE_ELIGIBILITY_RESPONSE_CREATED or COVERAGE_ELIGIBILITY_RESPONSE_UPDATED event fires on every eligibility response save. When the response resolves to a definite status, a matching COVERAGE_ELIGIBILITY_RESPONSE_ACTIVE, COVERAGE_ELIGIBILITY_RESPONSE_INACTIVE, or COVERAGE_ELIGIBILITY_RESPONSE_FAILED event fires alongside it. For example, when a failed eligibility check is first recorded, both COVERAGE_ELIGIBILITY_RESPONSE_CREATED and COVERAGE_ELIGIBILITY_RESPONSE_FAILED fire. Each event’s context carries the derived status string and the associated coverage; _FAILED events also include the payer errors.
COVERAGE_ELIGIBILITY_RESPONSE_CREATED Occurs when an eligibility response is created for a coverage. Target object Context object "id": eligibility_response_id
"type": EligibilityResponse "coverage":
"id": coverage_id
"patient":
"id": pt_id
"status": str
COVERAGE_ELIGIBILITY_RESPONSE_UPDATED Occurs when an eligibility response is updated. Target object Context object "id": eligibility_response_id
"type": EligibilityResponse "coverage":
"id": coverage_id
"patient":
"id": pt_id
"status": str
COVERAGE_ELIGIBILITY_RESPONSE_ACTIVE Occurs when an eligibility response resolves to an active status. Target object Context object "id": eligibility_response_id
"type": EligibilityResponse "coverage":
"id": coverage_id
"patient":
"id": pt_id
"status": str
COVERAGE_ELIGIBILITY_RESPONSE_INACTIVE Occurs when an eligibility response resolves to an inactive status. Target object Context object "id": eligibility_response_id
"type": EligibilityResponse "coverage":
"id": coverage_id
"patient":
"id": pt_id
"status": str
COVERAGE_ELIGIBILITY_RESPONSE_FAILED Occurs when an eligibility response check fails to complete (the payer response errored). Target object Context object "id": eligibility_response_id
"type": EligibilityResponse "coverage":
"id": coverage_id
"patient":
"id": pt_id
"status": str
"errors": list[str]
Detected Issues # DETECTED_ISSUE_CREATED Occurs when a detected issue is created. Target object Context object "id": detected_issue_id
"type": DetectedIssue "patient":
"id": pt_id
DETECTED_ISSUE_UPDATED Occurs when a detected issue is updated. Target object Context object "id": detected_issue_id
"type": DetectedIssue "patient":
"id": pt_id
DETECTED_ISSUE_EVIDENCE_CREATED Occurs when detected issue evidence is created. Target object Context object "id": detected_issue_evidence_id
"type": DetectedIssueEvidence empty
DETECTED_ISSUE_EVIDENCE_UPDATED Occurs when a detected issue evidence is updated. Target object Context object "id": detected_issue_evidence_id
"type": DetectedIssueEvidence empty
Devices # DEVICE_CREATED Occurs when a device is created. Target object Context object "id": device_id
"type": Device "patient":
"id": pt_id
DEVICE_UPDATED Occurs when a device is updated. Target object Context object "id": device_id
"type": Device "patient":
"id": pt_id
Document References # DOCUMENT_REFERENCE_CREATED Occurs when a document reference is created. Target object Context object "id": document_reference_id
"type": None "patient":
"id": pt_id
DOCUMENT_REFERENCE_UPDATED Occurs when a document reference is updated. Target object Context object "id": document_reference_id
"type": None "patient":
"id": pt_id
DOCUMENT_REFERENCE_DELETED Occurs when a document reference is deleted. Target object Context object "id": document_reference_id
"type": None "patient":
"id": pt_id
Encounters # ENCOUNTER_CREATED Occurs when an encounter is created. Target object Context object "id": encounter_id
"type": Encounter empty
ENCOUNTER_UPDATED Occurs when an encounter is updated. Target object Context object "id": encounter_id
"type": Encounter empty
Imaging Reports # IMAGING_REPORT_CREATED Occurs when an imaging report is entered into the data integration section of canvas. Target object Context object "id": report_id
"type": ImagingReport "patient":
"id": pt_id
IMAGING_REPORT_UPDATED Occurs when an imaging report is updated. Target object Context object "id": report_id
"type": ImagingReport "patient":
"id": pt_id
Immunizations # IMMUNIZATION_CREATED Occurs when an immunization is created. Additional details for the immunization may become available with subsequent IMMUNIZATION_STATEMENT_UPDATED events. Target object Context object "id": immunization_id
"type": Immunization "patient":
"id": pt_id
IMMUNIZATION_UPDATED Occurs when an immunization is updated. Target object Context object "id": immunization_id
"type": Immunization "patient":
"id": pt_id
IMMUNIZATION_STATEMENT_CREATED Occurs when an immunization statement is created. Additional details for the immunization statement may become available with subsequent IMMUNIZATION_STATEMENT_UPDATED events. Target object Context object "id": immunization_id
"type": Immunization "patient":
"id": pt_id
IMMUNIZATION_STATEMENT_UPDATED Occurs when an immunization statement is updated. Target object Context object "id": immunization_id
"type": Immunization "patient":
"id": pt_id
Instructions # INSTRUCTION_CREATED Occurs when an instruction is created using the Instruct command. Additional details for the instruction may become available with subsequent INSTRUCTION_UPDATED events. Target object Context object "id": instruction_id
"type": None "patient":
"id": pt_id
INSTRUCTION_UPDATED Occurs when an instruction is updated. Target object Context object "id": instruction_id
"type": None "patient":
"id": pt_id
Interviews # INTERVIEW_CREATED Occurs when an interview is created using the Questionnaire command or through the Questionnaire endpoint in the FHIR API. Additional details for the interview may become available with subsequent INTERVIEW_UPDATED events. Target object Context object "id": interview_id
"type": Interview "patient":
"id": pt_id
INTERVIEW_UPDATED Occurs when an interview is updated. Target object Context object "id": interview_id
"type": Interview "patient":
"id": pt_id
Labs # To be notified when lab results (documents and individual records) are added to Canvas, use the lab order and report events in this section. Pair them with the LabReport data module to read the result details.
LAB_ORDER_CREATED Occurs when a lab order is created via the Lab Order command. Additional details for the lab order may become available with subsequent LAB_ORDER_UPDATED events. Target object Context object "id": laborder_id
"type": LabOrder "patient":
"id": pt_id
LAB_ORDER_UPDATED Occurs when a lab order is updated. Target object Context object "id": laborder_id
"type": LabOrder "patient":
"id": pt_id
LAB_REPORT_CREATED Occurs when a lab report is created either through Data Integration, electronic ingestion or the FHIR API. Target object Context object "id": labreport_id
"type": LabReport "patient":
"id": pt_id
LAB_REPORT_UPDATED Occurs when a lab report is updated. Target object Context object "id": labreport_id
"type": LabReport "patient":
"id": pt_id
Medications # MEDICATION_LIST_ITEM_CREATED Occurs when a medication is added for a patient. Target object Context object "id": medication_id
"type": Medication "patient":
"id": pt_id
MEDICATION_LIST_ITEM_UPDATED Occurs when a medication is updated for a patient. Target object Context object "id": medication_id
"type": Medication "patient":
"id": pt_id
PRESCRIPTION_UPDATED Occurs when a prescription is updated. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_CREATED Occurs when a prescription is created for a patient using the Prescribe command. Additional details for the prescription become available with subsequent PRESCRIPTION_UPDATED events. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
Prescription status events # The following events fire when a prescription’s status changes during the e-prescribing lifecycle. These events always fire alongside a PRESCRIPTION_CREATED or PRESCRIPTION_UPDATED event. For example, when a prescription is first created, both PRESCRIPTION_CREATED and PRESCRIPTION_OPENED will fire. When a prescription’s status is updated to “transmitted”, both PRESCRIPTION_UPDATED and PRESCRIPTION_TRANSMITTED will fire.
PRESCRIPTION_OPENED Occurs when a prescription's status is set to open. This is the default status when a prescription is first created. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_PENDING Occurs when a prescription's status changes to pending. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_ACCEPTED Occurs when a prescription has been ultimately accepted. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_ERRORED Occurs when an error occurs during prescription processing. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_CANCEL_REQUESTED Occurs when a cancellation has been requested for a prescription. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_CANCELED Occurs when a prescription has been successfully canceled. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_CANCEL_DENIED Occurs when a cancellation request for a prescription has been denied. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_RECEIVED Occurs when a prescription has been received by the e-prescribing network. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_SIGNED Occurs when a prescription has been signed. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_INQUEUE Occurs when a prescription is in queue for transmission. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_TRANSMITTED Occurs when a prescription has been transmitted to the pharmacy. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
PRESCRIPTION_DELIVERED Occurs when a prescription has been delivered to the pharmacy. Target object Context object "id": prescription_id
"type": Prescription "patient":
"id": pt_id
Surescripts # Surescripts response events fire when the platform receives a response from Surescripts after a corresponding request effect is executed. These events let plugins react to insurance eligibility checks and other Surescripts services.
SURESCRIPTS_ELIGIBILITY_RESPONSE Occurs when Surescripts returns an eligibility response after a SendSurescriptsEligibilityRequestEffect is executed. The response contains the patient's insurance plan information and coverage details. See Handling Eligibility Responses for the typed response data classes and an example handler. Target object Context object empty "correlation_id": str
"patient_id": str
"plans": list[dict]
"error": str or None
SURESCRIPTS_BENEFITS_RESPONSE Occurs when Surescripts returns a benefits response after a SendSurescriptsBenefitsRequestEffect is executed. The response contains formulary and coverage details for the requested medication, including copays, quantity limits, and therapeutic alternatives. See Handling Benefits Responses for the typed response data classes and an example handler. Target object Context object empty "correlation_id": str
"patient_id": str
"medication_ndc": str
"coverages": list[dict]
"error": str or None
Messaging # MESSAGE_CREATED Occurs when a message (patient/practitioner communication) is created. Target object Context object "id": message_id
"type": Message "patient":
"id": pt_id
MESSAGE_TEAM_ASSIGNED Occurs when a message is created with a team, and each time a message's team is assigned, changed, or cleared, including by the AssignMessageTeamteam set to null. A save that leaves the team unchanged does not emit it. team is null when the message was unassigned, and previous_team is null when it had no team before. Target object Context object "id": message_id
"type": Message "message": Message
"id": message_id
"sender": str, the id of the Patient or Staff who sent it
"recipient": str, the id of the Patient or Staff it was sent to
"read": datetime str | null
"team": Team | null
"id": team_id
"name": str
"previous_team": Team | null
"id": team_id
"name": str
"patient": Patient
"id": pt_id
"assigned_at": datetime str
MESSAGE_TRANSMISSION_CREATED Occurs when a message transmission record is created. Message transmissions track delivery attempts and status for messages sent through various channels (SMS, email, etc.). Target object Context object "id": message_transmission_id
"type": MessageTransmission empty
MESSAGE_TRANSMISSION_UPDATED Occurs when a message transmission record is updated (e.g., when delivery status changes). Target object Context object "id": message_transmission_id
"type": MessageTransmission empty
Notes # NOTE_STATE_CHANGE_EVENT_CREATED Occurs as a note traverses through its state machine. This event can be used when looking at any changes to the note state , including locking and unlocking. Target object Context object "id": nsce_id
"type": NoteStateChangeEvent "note_id": note_id,
"patient_id": pt_id,
"state": str
NOTE_STATE_CHANGE_EVENT_PRE_CREATE Occurs before a note state change event is created. This event allows protocols to perform validation and block the note state change if needed. If an EventValidationError Target object Context object "id": nsce_id
"type": NoteStateChangeEvent "note_id": note_id,
"patient_id": pt_id,
"state": str
NOTE_STATE_CHANGE_EVENT_UPDATED Occurs when a note state change event is updated. After a note is locked, or signed for note types that require a signature, Canvas generates an archived PDF of the note in the background and saves it on that lock or sign event. That fires this event twice : once when the note's snapshot is saved and once when the PDF is saved. Target object Context object "id": nsce_id
"type": NoteStateChangeEvent "note_id": note_id,
"patient_id": pt_id,
"state": str
NOTE_CREATED Occurs when a note is created. Target object Context object "id": note_id
"type": Note "patient":
"id": pt_id
NOTE_UPDATED Occurs when a note is updated, including changes to fields, commands, or body content. Target object Context object "id": note_id
"type": Note "patient":
"id": pt_id
"user":
"id": staff_key
NOTE_OPENED Fires when a provider expands a note in the patient chart. The context includes the note's ID. Target object Context object "id": patient_key
"type": Patient "note": {"id": note_uuid},
"user": {
"type": str,
"id": user_id
}
NOTE_CLOSED Fires when a provider collapses a note that was previously open. The context includes the note's ID. Target object Context object "id": patient_key
"type": Patient "note": {"id": note_uuid},
"user": {
"type": str,
"id": user_id
}
NOTE_SUPERVISING_PROVIDER_CHANGED Occurs when a note's supervising provider is changed. The context includes the previous supervising provider's Staff ID, or null if the note previously had no supervising provider. Target object Context object "id": note_id
"type": Note "previous": null | {
"id": staff_key
}
GET_NOTE_RESTRICTIONS Fires every time a note is opened or its restrictions are refetched. Plugins respond with a NoteRestrictionsEffect Target object Context object "id": note.id
"type": Note empty
Note Metadata # NOTE_METADATA_CREATED Occurs when a note's metadata is created. Target object Context object "id": notemetadata_id
"type": NoteMetadata empty
NOTE_METADATA_UPDATED Occurs when a note's metadata is updated. Target object Context object "id": notemetadata_id
"type": NoteMetadata empty
Letters # LETTER_CREATED Occurs when a letter is created. Target object Context object "id": letter_id
"type": Letter "patient":
"id": pt_id
LETTER_UPDATED Occurs when a letter is updated. Target object Context object "id": letter_id
"type": Letter "patient":
"id": pt_id
LETTER_ACTION_EVENT_CREATED Occurs when a letter is printed or faxed. For a fax, delivered_by_fax on the target is still None. Target object Context object "id": letter_action_event_id
"type": LetterActionEvent empty
LETTER_ACTION_EVENT_UPDATED Occurs when the faxing service reports whether a letter fax was delivered, and again if a later report changes the outcome or its message. See delivery status . Target object Context object "id": letter_action_event_id
"type": LetterActionEvent empty
Faxed Documents # Canvas records an action event each time a note, referral, imaging order, lab order, or integration task is faxed, including faxes a plugin sends with the Fax Note effect . Letters have their own letter action events .
The _CREATED event fires when the fax is submitted. delivered_by_fax on the target is still None. The _UPDATED event fires when the faxing service reports the outcome. Read delivered_by_fax and fax_result_msg on the target; see delivery status . A later report that changes the outcome or its message fires _UPDATED again, so a plugin that retries failed faxes should retry each action event only once.
NOTE_ACTION_EVENT_CREATED Occurs when a note is faxed. Target object Context object "id": note_action_event_id
"type": NoteActionEvent empty
NOTE_ACTION_EVENT_UPDATED Occurs when the faxing service reports whether a note fax was delivered. Target object Context object "id": note_action_event_id
"type": NoteActionEvent empty
REFERRAL_ACTION_EVENT_CREATED Occurs when a referral is faxed. Target object Context object "id": referral_action_event_id
"type": ReferralActionEvent empty
REFERRAL_ACTION_EVENT_UPDATED Occurs when the faxing service reports whether a referral fax was delivered. Target object Context object "id": referral_action_event_id
"type": ReferralActionEvent empty
IMAGING_ORDER_ACTION_EVENT_CREATED Occurs when an imaging order is faxed. Target object Context object "id": imaging_order_action_event_id
"type": ImagingOrderActionEvent empty
IMAGING_ORDER_ACTION_EVENT_UPDATED Occurs when the faxing service reports whether an imaging order fax was delivered. Target object Context object "id": imaging_order_action_event_id
"type": ImagingOrderActionEvent empty
LAB_ORDER_ACTION_EVENT_CREATED Occurs when a lab order is faxed. Target object Context object "id": lab_order_action_event_id
"type": LabOrderActionEvent empty
LAB_ORDER_ACTION_EVENT_UPDATED Occurs when the faxing service reports whether a lab order fax was delivered. Target object Context object "id": lab_order_action_event_id
"type": LabOrderActionEvent empty
INTEGRATION_TASK_ACTION_EVENT_CREATED Occurs when an integration task is faxed. Target object Context object "id": integration_task_action_event_id
"type": IntegrationTaskActionEvent empty
INTEGRATION_TASK_ACTION_EVENT_UPDATED Occurs when the faxing service reports whether an integration task fax was delivered. Target object Context object "id": integration_task_action_event_id
"type": IntegrationTaskActionEvent empty
Observations # OBSERVATION_CREATED Occurs when an observation is created. Target object Context object "id": observation_id
"type": Observation "patient":
"id": pt_id
OBSERVATION_UPDATED Occurs when an observation is updated. Target object Context object "id": observation_id
"type": Observation "patient":
"id": pt_id
Protocol Overrides # PROTOCOL_OVERRIDE_CREATED Target object Context object "id": protocoloverride_id
"type": ProtocolOverride "patient":
"id": pt_id
PROTOCOL_OVERRIDE_UPDATED Target object Context object "id": protocoloverride_id
"type": ProtocolOverride "patient":
"id": pt_id
PROTOCOL_OVERRIDE_DELETED Target object Context object "id": protocoloverride_id
"type": ProtocolOverride "patient":
"id": pt_id
Referral Reports # REFERRAL_REPORT_CREATED Occurs when a specialist consult report is created in Data Integration. Target object Context object "id": referralreport_id
"type": ReferralReport "patient":
"id": pt_id
REFERRAL_REPORT_UPDATED Occurs when a specialist consult report is updated. Target object Context object "id": referralreport_id
"type": ReferralReport "patient":
"id": pt_id
Tasks # TASK_CREATED Occurs when a task is created. Target object Context object "id": task_id
"type": Task "patient":
"id": pt_id
TASK_UPDATED Occurs when a task is updated. Target object Context object "id": task_id
"type": Task "patient":
"id": pt_id
TASK_COMMENT_CREATED Occurs when a comment is added to a task. Target object Context object "id": taskcomment_id
"type": TaskComment empty
TASK_COMMENT_UPDATED Occurs when a comment for a task is updated. Target object Context object "id": taskcomment_id
"type": TaskComment empty
TASK_COMMENT_DELETED Occurs when a comment for a task is removed. Target object Context object "id": taskcomment_id
"type": TaskComment empty
TASK_LABELS_ADJUSTED Occurs when a label is added to or removed from a task, including from the task panel. Note: unlike the other TASK_* events, the target of this event is the TaskLabel that changed — not the task. The affected task's ID is available in the context object as task.id (use that to load the task, e.g. Task.objects.get(id=self.event.context["task"]["id"])), and action tells you whether the label was added or removed. Target object Context object "id": task_label_id
"type": TaskLabel "patient":
"id": pt_id
"task":
"id": task_id
"action": literal["add", "remove"]
TASK_COMPLETED Occurs when a task is set to completed. Target object Context object "id": task_id
"type": Task "patient":
"id": pt_id
TASK_CLOSED Occurs when a task is set to closed. Target object Context object "id": task_id
"type": Task "patient":
"id": pt_id
Task Metadata # TASK_METADATA_CREATED Occurs when a task's metadata is created. Target object Context object "id": taskmetadata_id
"type": TaskMetadata empty
TASK_METADATA_UPDATED Occurs when a task's metadata is updated. Target object Context object "id": taskmetadata_id
"type": TaskMetadata empty
Staff # STAFF_CREATED Occurs when a staff is created. Target object Context object "id": staff_id
"type": Staff empty
STAFF_UPDATED Occurs when a staff is updated. Target object Context object "id": staff_id
"type": Staff empty
STAFF_ACTIVATED Occurs when a staff record is created with active=True, or a staff record's active field is updated from False to True. Target object Context object "id": staff_id
"type": Staff empty
STAFF_DEACTIVATED Occurs when a staff record's active field is updated from True to False. Target object Context object "id": staff_id
"type": Staff empty
Staff External Identifier # STAFF_EXTERNAL_IDENTIFIER_CREATED Occurs when an external identifier is created for a staff member. Target object Context object "id": staffexternalidentifier_id
"type": StaffExternalIdentifier "staff":
"id": staff_id
STAFF_EXTERNAL_IDENTIFIER_UPDATED Occurs when an external identifier for a staff member is updated. Target object Context object "id": staffexternalidentifier_id
"type": StaffExternalIdentifier "staff":
"id": staff_id
STAFF_EXTERNAL_IDENTIFIER_DELETED Occurs when an external identifier for a staff member is deleted. Target object Context object "id": staffexternalidentifier_id
"type": StaffExternalIdentifier "staff":
"id": staff_id
Staff Metadata # STAFF_METADATA_CREATED Occurs when a staff member's metadata is created. Target object Context object "id": staffmetadata_id
"type": StaffMetadata empty
STAFF_METADATA_UPDATED Occurs when a staff member's metadata is updated. Target object Context object "id": staffmetadata_id
"type": StaffMetadata empty
STAFF_METADATA_DELETED Occurs when a staff member's metadata is deleted. Target object Context object "id": staffmetadata_id
"type": StaffMetadata empty
Vital Signs # VITAL_SIGN_CREATED Occurs when a vitals entry is created for a patient using the vitals command. Additional details for the vitals become available with subsequent VITAL_SIGN_UPDATED events. Target object Context object "id": vitalsign_id
"type": None empty
VITAL_SIGN_UPDATED Occurs when a vitals entry is updated for a patient. Target object Context object "id": vitalsign_id
"type": None empty
Command lifecycle events # These events fire during the command lifecycle.
Generic events # Event Occurs when PRE_COMMAND_ORIGINATE Before any command is entered into a note. POST_COMMAND_ORIGINATE After any command is entered into a note. PRE_COMMAND_UPDATE Before the data in any command is updated. POST_COMMAND_UPDATE After the data in any command is updated. PRE_COMMAND_COMMIT Before any command is committed. POST_COMMAND_COMMIT After any command is committed. PRE_COMMAND_DELETE Before any command is deleted. POST_COMMAND_DELETE After any command is deleted. PRE_COMMAND_ENTER_IN_ERROR Before any command is marked as entered in error. POST_COMMAND_ENTER_IN_ERROR After any command is marked as entered in error. PRE_COMMAND_EXECUTE_ACTION Before an action is executed on any command. POST_COMMAND_EXECUTE_ACTION After an action is executed on any command. POST_COMMAND_INSERTED_INTO_NOTE After a user adds a command to a note in the Canvas UI. Commands added by a plugin effect or through the FHIR API do not fire this event. AVAILABLE_ACTIONS When a command is rendered in the UI, after any update to data, state, or other changes
Transaction Behavior # Pre-event handlers (PRE_COMMAND_ORIGINATE, PRE_COMMAND_COMMIT, PRE_COMMAND_UPDATE) run synchronously inside the same database transaction as the command operation. Your handler can perform validation or modify data, and if it raises an exception, both your changes and the command operation roll back together.
Post-event handlers (POST_COMMAND_ORIGINATE, POST_COMMAND_COMMIT, POST_COMMAND_UPDATE) use Django’s on_commit mechanism and execute only after the outermost transaction commits successfully. If you wrap a command operation inside a transaction.atomic() block, the post-event handlers won’t fire until that outer transaction commits.
This model lets you combine command operations with other database writes in a single atomic unit. You can originate a command and update related records together, knowing that either all operations succeed or none do.
See Transactions for more on using transaction.atomic() in your plugins.
Context Overview # Each command lifecycle event provides specific context to the handler, depending on the stage of the command lifecycle.
Base Context (All Events Except PRE_COMMAND_ORIGINATE) :
{
"note" : { "uuid" : "note-123" },
"patient" : { "id" : "patient-123" },
"fields" : { "key" : "value" }
}
note.uuid: The unique identifier of the note associated with the command.patient.id: The unique identifier of the patient associated with the note.fields: A dictionary containing command-specific details. See examples for each command.PRE_COMMAND_ORIGINATE ContextPRE_COMMAND_ORIGINATE event context only includes:
{
"fields" : { "key" : "value" }
}
fields: Contains details specific to the command being originated. Accessing structured plan / treatment plan data # If you want the structured contents of a finished note, such as a treatment plan or care plan, read its commands rather than parsing the rendered DocumentReference PDF. Use the command lifecycle events above with the Command data model: read a note’s commands with note.commands.all() and branch on each command’s type. Plan , Prescribe , Follow-up , Task , and Instruct commands carry most plan data.
Post-originate versus inserted-into-note events # The two event families catch different writes:
POST_ORIGINATEedit the command that triggered it.POST_INSERTED_INTO_NOTE*__POST_INSERTED_INTO_NOTE events and POST_COMMAND_INSERTED_INTO_NOTE) fires only when a user inserts a command into the note body in the Canvas UI. Use it to respond to a clinician’s action in the note, such as adding related commands next to the one they inserted. Avoiding recursion in post-update handlers # A handler that responds to a command's *__POST_UPDATE event and edits that same command can loop forever. The edit updates the command, which fires POST_UPDATE again, which edits it again.
Every POST_UPDATE handler that edits its own command needs a guard that returns no effects once the command already holds what you would set:
Compare before you edit. Read the field from the event’s fields context. If it already has the value you would write, return [].For values you compute from other inputs, cache what you used. Store the inputs under a key such as f"plan-update:{command_id}" with the cache . On each event, return [] if the cached inputs match the current event. Only when they differ, update the cache and return the edit.from canvas_sdk.commands import PlanCommand
from canvas_sdk.effects import Effect
from canvas_sdk.events import EventType
from canvas_sdk.handlers import BaseHandler
STANDARD_NARRATIVE = " Follow up in two weeks. "
class StandardizePlanNarrative ( BaseHandler ):
RESPONDS_TO = EventType . Name ( EventType . PLAN_COMMAND__POST_UPDATE )
def compute ( self ) -> list [ Effect ]:
narrative = self . context [ " fields " ]. get ( " narrative " )
# The guard: the edit below fires POST_UPDATE again, so stop once it is applied.
if not narrative or narrative == STANDARD_NARRATIVE :
return []
return [ PlanCommand ( command_uuid = self . target , narrative = STANDARD_NARRATIVE ). edit ()]
When the value comes from other data, cache the inputs instead. This handler writes a follow-up date into the plan, computed from the note’s date of service. Its own edit fires POST_UPDATE again, finds the same inputs in the cache, and stops. A clinician’s later edit to the narrative also leaves it alone, until the date of service changes:
from datetime import timedelta
from canvas_sdk.caching.plugins import get_cache
from canvas_sdk.commands import PlanCommand
from canvas_sdk.effects import Effect
from canvas_sdk.events import EventType
from canvas_sdk.handlers import BaseHandler
from canvas_sdk.v1.data import Command
class FollowUpDateInPlan ( BaseHandler ):
RESPONDS_TO = EventType . Name ( EventType . PLAN_COMMAND__POST_UPDATE )
def compute ( self ) -> list [ Effect ]:
note = Command . objects . get ( id = self . target ). note
inputs = note . datetime_of_service . isoformat ()
cache = get_cache ()
key = f " plan-update: { self . target } "
# The guard: stop when this command was already updated from these inputs.
if cache . get ( key ) == inputs :
return []
cache . set ( key , inputs )
follow_up = ( note . datetime_of_service + timedelta ( days = 14 )). date ()
narrative = f " Follow up on { follow_up . isoformat () } . "
return [ PlanCommand ( command_uuid = self . target , narrative = narrative ). edit ()]
Add Condition Command # ADD_CONDITION_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
ADD_CONDITION_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADD_CONDITION__CONDITION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ADD_CONDITION__CONDITION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[ConditionSearchResult ]
Adjust Prescription Command # ADJUST_PRESCRIPTION_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
ADJUST_PRESCRIPTION_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"change_medication_to": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ADJUST_PRESCRIPTION__INDICATIONS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ADJUST_PRESCRIPTION__INDICATIONS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ADJUST_PRESCRIPTION__PHARMACY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ADJUST_PRESCRIPTION__PHARMACY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ADJUST_PRESCRIPTION__PRESCRIBE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[MedicationSearchResult ]
ADJUST_PRESCRIPTION__PRESCRIBE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ADJUST_PRESCRIPTION__CHANGE_MEDICATION_TO__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[MedicationSearchResult ]
ADJUST_PRESCRIPTION__CHANGE_MEDICATION_TO__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ADJUST_PRESCRIPTION__SUPERVISING_PROVIDER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ADJUST_PRESCRIPTION__SUPERVISING_PROVIDER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ADJUST_PRESCRIPTION__PRESCRIBER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ADJUST_PRESCRIPTION__PRESCRIBER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Allergy Command # ALLERGY_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
ALLERGY_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"severity": str
"narrative": str
"approximate_date":
"input": str
"date": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ALLERGY__ALLERGY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[AllergySearchResult ]
ALLERGY__ALLERGY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Assess Command #
ASSESS_COMMAND__CONDITION_SELECTED Occurs when an Assess command's condition is set to a condition already on the patient's chart, either by a clinician picking it or by a plugin editing the command with condition_id. data.condition holds the condition's id and its codings. Setting the condition to an ICD-10 code sends ASSESS_COMMAND__ICD10_CODE_SELECTED Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"data":
"condition":
"id": condition_id
"codings":
"code": str
"system": str
"display": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__ICD10_CODE_SELECTED Occurs when an Assess command's condition is set to an ICD-10 code rather than a charted condition, either by a clinician picking a code the patient doesn't have charted or by a plugin editing the command with icd10_code. No condition is attached until commit, so data.codings holds the code. A plugin edit sends this event even when the patient already has a condition with that code; the clinician's search shows the charted condition in that case, so a clinician's pick sends ASSESS_COMMAND__CONDITION_SELECTEDicd10_code already set. Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"data":
"codings":
"code": str
"system": str
"display": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
ASSESS_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"approximate_date_of_onset":
"input": str
"date": str
"show_in_problem_list": bool
"background": str
"status": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS__CONDITION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ASSESS__CONDITION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[ConditionSearchResult ]
Cancel Prescription Command # CANCEL_PRESCRIPTION_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescription": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CANCEL_PRESCRIPTION__SELECTED_PRESCRIPTION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
CANCEL_PRESCRIPTION__SELECTED_PRESCRIPTION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
Change Medication Command # CHANGE_MEDICATION_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHANGE_MEDICATION__MEDICATION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[MedicationSearchResult ]
CHANGE_MEDICATION__MEDICATION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Chart Section Review Command # CHART_SECTION_REVIEW_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"section": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHART_SECTION_REVIEW_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"section": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHART_SECTION_REVIEW_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"section": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHART_SECTION_REVIEW_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"section": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHART_SECTION_REVIEW_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
CHART_SECTION_REVIEW_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"section": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHART_SECTION_REVIEW_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"section": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CHART_SECTION_REVIEW_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"section": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Clipboard Command # CLIPBOARD_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
CLIPBOARD_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLIPBOARD_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"text": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Clipboard Fields Context # The Clipboard Command provides the following fields in its context:
Field Type Description textstring The raw text content copied to the clipboard.
Refer to the base context documentation for additional details about the full context structure.
{
"note" : { "uuid" : "note-123" },
"patient" : { "id" : "patient-123" },
"fields" : {
"text" : "Patient complains of persistent headaches for the past two weeks."
}
}
Close Goal Command # CLOSE_GOAL_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
CLOSE_GOAL_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_id": dict
"achievement_status": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CLOSE_GOAL__GOAL_ID__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
CLOSE_GOAL__GOAL_ID__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Assess Coding Gap Command # ASSESS_CODING_GAP_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"details": str
"diagnose": list
"background": str
"approximate_date_of_onset": str
"todays_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
ASSESS_CODING_GAP__DIAGNOSE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_id
}
"results": list[ConditionSearchResult ]
ASSESS_CODING_GAP__DIAGNOSE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_id
}
Create Coding Gap Command # CREATE_CODING_GAP_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": list
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CREATE_CODING_GAP__DIAGNOSE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_id
}
"results": list[ConditionSearchResult ]
CREATE_CODING_GAP__DIAGNOSE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_id
}
Defer Coding Gap Command # DEFER_CODING_GAP_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DEFER_CODING_GAP_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Validate Coding Gap Command # VALIDATE_CODING_GAP_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VALIDATE_CODING_GAP_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"detected_issue": str
"status": str
"date": str
"details": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Custom Command # CUSTOM_COMMAND_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"content": str
"schema_key": str
"note":
"uuid": note_id
"patient":
"id": pt_id
CUSTOM_COMMAND_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": str
"user":
"staff": staff_id
Diagnose Command # DIAGNOSE_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
DIAGNOSE_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnose": dict
"background": str
"approximate_date_of_onset":
"input": str
"date": str
"today_assessment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
DIAGNOSE__DIAGNOSE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[ConditionSearchResult ]
DIAGNOSE__DIAGNOSE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Educational Material Command # EDUCATIONAL_MATERIAL_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
EDUCATIONAL_MATERIAL_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
EDUCATIONAL_MATERIAL__LANGUAGE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
EDUCATIONAL_MATERIAL__LANGUAGE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
EDUCATIONAL_MATERIAL__TITLE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
EDUCATIONAL_MATERIAL__TITLE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Family History Command # FAMILY_HISTORY_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
FAMILY_HISTORY_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"family_history": dict
"relative": dict
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FAMILY_HISTORY__FAMILY_HISTORY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
FAMILY_HISTORY__FAMILY_HISTORY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
FAMILY_HISTORY__RELATIVE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
FAMILY_HISTORY__RELATIVE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Follow Up Command # FOLLOW_UP_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
FOLLOW_UP_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"requested_date": dict
"note_type": dict
"coding": dict
"reason_for_visit": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
FOLLOW_UP__CODING__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
FOLLOW_UP__CODING__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
FOLLOW_UP__NOTE_TYPE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
FOLLOW_UP__NOTE_TYPE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Goal Command # GOAL_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
GOAL_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
GOAL_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": str
"start_date": str
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
History of Present Illness Command # HISTORY_OF_PRESENT_ILLNESS_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
HISTORY_OF_PRESENT_ILLNESS_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Imaging Order Command # IMAGING_ORDER_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
IMAGING_ORDER_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"image": dict
"indications": list[dict]
"priority": str
"additional_details": str
"imaging_center": dict
"comment": str
"ordering_provider": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_ORDER__IMAGE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMAGING_ORDER__IMAGE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
IMAGING_ORDER__IMAGING_CENTER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMAGING_ORDER__IMAGING_CENTER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
IMAGING_ORDER__INDICATIONS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMAGING_ORDER__INDICATIONS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
IMAGING_ORDER__ORDERING_PROVIDER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMAGING_ORDER__ORDERING_PROVIDER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Imaging Review Command # IMAGING_REVIEW_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMAGING_REVIEW__REPORT__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
IMAGING_REVIEW__REPORT__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMAGING_REVIEW__COMMUNICATION_METHOD__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
IMAGING_REVIEW__COMMUNICATION_METHOD__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
Immunization Statement Command # IMMUNIZATION_STATEMENT_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"statement": dict
"date":
"date": str
"input": str
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZATION_STATEMENT__STATEMENT__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMMUNIZATION_STATEMENT__STATEMENT__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
IMMUNIZATION_STATEMENT_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
Immunize Command # IMMUNIZE_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
IMMUNIZE_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"lot_number": dict
"manufacturer": str
"exp_date_original": str
"sig_original": str
"consent_given": bool
"given_by": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
IMMUNIZE__CODING__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMMUNIZE__CODING__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
IMMUNIZE__GIVEN_BY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMMUNIZE__GIVEN_BY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
IMMUNIZE__LOT_NUMBER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
IMMUNIZE__LOT_NUMBER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Instruct Command # INSTRUCT_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
INSTRUCT_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"instruct": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
INSTRUCT__INSTRUCT__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
INSTRUCT__INSTRUCT__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Lab Order Command # LAB_ORDER_COMMAND__POST_COMMIT is useful for automating tasks when a lab is ordered, for example creating a task for a medical assistant whenever any lab command is committed. The event context includes the command fields, so you can branch on the order’s details (for example, only create the task when fields["lab_partner"]["text"] is "Generic Lab"). The lab-order-automated-task extension is a reference implementation.
LAB_ORDER_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
LAB_ORDER_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER_COMMAND__PRE_SEND Fires from Canvas right before a lab order's FHIR RequestGroup is built and POSTed to Health Gorilla. Plugins may respond with one or more HealthGorillaLabOrderOverride effects to inject account numbers, bill-to, performer organization, sub-tenant, or location into the outbound payload. Target object Context object "id": laborder_id
"type": LabOrder "lab_order":
"id": laborder_id
"uuid": laborder_id
"lab_partner": str
"note":
"id": note_id
"uuid": note_id
"patient":
"id": pt_id
HEALTH_GORILLA_LAB_ORDER_PREPARED Fires from Canvas right after the outbound Health Gorilla FHIR RequestGroup dict is constructed and right before it is POSTed to Health Gorilla. Read-only — any effects returned by handlers are discarded. Complements LAB_ORDER_COMMAND__PRE_SEND, which fires before the build and accepts override effects. Target object Context object "id": laborder_id
"type": LabOrder "lab_order":
"id": laborder_id
"uuid": laborder_id
"lab_partner": str
"note":
"id": note_id
"uuid": note_id
"patient":
"id": pt_id
"request_group": dict
LAB_ORDER_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"lab_partner": dict
"tests": list[dict]
"ordering_provider": dict
"diagnosis": list[dict]
"fasting_status": bool
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_ORDER__DIAGNOSIS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
LAB_ORDER__DIAGNOSIS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
LAB_ORDER__LAB_PARTNER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
LAB_ORDER__LAB_PARTNER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
LAB_ORDER__ORDERING_PROVIDER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
LAB_ORDER__ORDERING_PROVIDER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
LAB_ORDER__TESTS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
LAB_ORDER__TESTS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Lab Review Command # LAB_REVIEW_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
LAB_REVIEW__REPORT__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
LAB_REVIEW__REPORT__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
LAB_REVIEW__COMMUNICATION_METHOD__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
LAB_REVIEW__COMMUNICATION_METHOD__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
Medical History Command # MEDICAL_HISTORY_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
MEDICAL_HISTORY_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"past_medical_history": dict
"approximate_start_date":
"date": str
"input": str
"approximate_end_date":
"date": str
"input": str
"show_on_condition_list": bool
"comments": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICAL_HISTORY__APPROXIMATE_END_DATE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
MEDICAL_HISTORY__APPROXIMATE_END_DATE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
MEDICAL_HISTORY__APPROXIMATE_START_DATE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
MEDICAL_HISTORY__APPROXIMATE_START_DATE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
MEDICAL_HISTORY__PAST_MEDICAL_HISTORY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[ConditionSearchResult ]
MEDICAL_HISTORY__PAST_MEDICAL_HISTORY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Medication Statement Command # MEDICATION_STATEMENT_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
MEDICATION_STATEMENT_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"sig": str
"note":
"uuid": note_id
"patient":
"id": pt_id
MEDICATION_STATEMENT__MEDICATION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[MedicationSearchResult ]
MEDICATION_STATEMENT__MEDICATION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Order DME Command # ORDER_DME_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
ORDER_DME_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"item": dict
"indications": list[dict]
"quantity": int
"length_of_need": str
"send_to": dict
"ordering_provider": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ORDER_DME__INDICATIONS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ORDER_DME__INDICATIONS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ORDER_DME__ITEM__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ORDER_DME__ITEM__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ORDER_DME__ORDERING_PROVIDER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ORDER_DME__ORDERING_PROVIDER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
ORDER_DME__SEND_TO__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ORDER_DME__SEND_TO__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Each pair of search events fires when a user searches in one of the command’s fields:
ORDER_DME__ITEM__*: the item field, which searches the DME formulary.ORDER_DME__INDICATIONS__*: the Indications field, which searches ICD-10 conditions.ORDER_DME__SEND_TO__*: the Send to field, which searches for a supplier.ORDER_DME__ORDERING_PROVIDER__*: the ordering provider field, which searches active staff who can prescribe.Reply to a PRE_SEARCH event with an AUTOCOMPLETE_SEARCH_RESULTSPOST_SEARCH event with the same effect to replace or annotate the results.
In POST_SEARCH events, each entry in results has text, value, disabled, description, annotations, and extra keys:
Item results: text is the product name, annotations holds the product’s code system and code (for example, HCPCS E0114), and extra holds dme_product_id, code, and code_system. code_system is HCPCS or INTERNAL. The value and extra.dme_product_id IDs are Canvas’s internal product IDs, not the external ID that the OrderDmeCommand dme_product_id parameter takes.
{
"text" : "Standard wheelchair" ,
"disabled" : false ,
"description" : null ,
"annotations" : [ "HCPCS K0001" ],
"extra" : {
"dme_product_id" : 12 ,
"code" : "K0001" ,
"code_system" : "HCPCS"
},
"value" : "12"
}
A product with no code has null in annotations.
Ordering provider results: text is the staff member’s name with credentials. value is Canvas’s internal staff ID, not the Staff id that the OrderDmeCommand ordering_provider_key parameter takes.
{
"text" : "Jane Smith MD" ,
"disabled" : false ,
"description" : null ,
"annotations" : null ,
"extra" : null ,
"value" : 42
}
Supplier results: text is the supplier’s name, description summarizes the supplier’s phone, fax, and address, and extra.contact holds the contact record. Canvas searches suppliers in any specialty, using the service-area ZIP codes of the user’s primary practice location.
{
"text" : "Pacific Mobility (Pacific Mobility Supply), Durable Medical Equipment" ,
"disabled" : false ,
"description" : "Phone: (415) 555-0142 Fax: (415) 555-0143 Address: 2037 Irving St, San Francisco, CA 94122" ,
"annotations" : null ,
"extra" : {
"contact" : {
"id" : 8703 ,
"firstName" : "Pacific" ,
"lastName" : "Mobility" ,
"practiceName" : "Pacific Mobility Supply" ,
"specialty" : "Durable Medical Equipment" ,
"businessPhone" : "4155550142" ,
"businessFax" : "4155550143" ,
"businessAddress" : "2037 Irving St, San Francisco, CA 94122" ,
"composeAddress" : "2037 Irving St, San Francisco, CA 94122" ,
"notes" : null ,
"score" : 0
}
},
"value" : "8703"
}
When the order is signed, Canvas saves the supplier from the selected result’s extra.contact.
Perform Command # PERFORM_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
PERFORM_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"perform": dict
"notes": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PERFORM__PERFORM__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
PERFORM__PERFORM__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Physical Exam Command # PHYSICAL_EXAM_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
PHYSICAL_EXAM_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
PHYSICAL_EXAM__QUESTIONNAIRE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
PHYSICAL_EXAM__QUESTIONNAIRE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Plan Command # PLAN_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
PLAN_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PLAN_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC Lab Test Command # POC Lab Test commands carry a test_values|<label> field per template field — those labels are determined dynamically by the selected template, so the fields block below shows the static shape only; dynamic per-field entries appear alongside.
POC_LAB_TEST_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str # one per template field
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
POC_LAB_TEST_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
POC_LAB_TEST_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"template": dict
"indications": list[dict]
"remarks": str
"test_values|<label>": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Prescribe Command # PRESCRIBE_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
PRESCRIBE_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
PRESCRIBE__INDICATIONS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
PRESCRIBE__INDICATIONS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
PRESCRIBE__PHARMACY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
PRESCRIBE__PHARMACY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
PRESCRIBE__PRESCRIBE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
PRESCRIBE__PRESCRIBE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
PRESCRIBE__SUPERVISING_PROVIDER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
PRESCRIBE__SUPERVISING_PROVIDER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
PRESCRIBE__PRESCRIBER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
PRESCRIBE__PRESCRIBER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Questionnaire Command # QUESTIONNAIRE_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
QUESTIONNAIRE_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"result": str
"note":
"uuid": note_id
"patient":
"id": pt_id
QUESTIONNAIRE__QUESTIONNAIRE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
QUESTIONNAIRE__QUESTIONNAIRE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Reason for Visit Command # REASON_FOR_VISIT_COMMAND__POST_COMMIT This event does not fire. Reason for Visit commands can't be committed. Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
REASON_FOR_VISIT_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__PRE_COMMIT This event does not fire. Reason for Visit commands can't be committed. Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"coding": dict
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REASON_FOR_VISIT__CODING__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REASON_FOR_VISIT__CODING__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Refer Command # REFER_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
REFER_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"refer_to": dict
"indications": list[dict]
"clinical_question": str
"priority": str
"notes_to_specialist": str
"include_visit_note": bool
"internal_comment": str
"documents_to_include": dict
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
REFER__REFER_TO__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER__REFER_TO__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFER__INDICATIONS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER__INDICATIONS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFER__DOCUMENTS_TO_INCLUDE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER__DOCUMENTS_TO_INCLUDE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFER__LINKED_ITEMS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER__LINKED_ITEMS_INCLUDE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Reference Command # REFERENCE_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
REFERENCE_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERENCE_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"diagnostic_view_id": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Referral Review Command # REFERRAL_REVIEW_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFERRAL_REVIEW__REPORT__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFERRAL_REVIEW__REPORT__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFERRAL_REVIEW__COMMUNICATION_METHOD__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFERRAL_REVIEW__COMMUNICATION_METHOD__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
Approve Refill Command # APPROVE_REFILL_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
APPROVE_REFILL_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
APPROVE_REFILL_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"refills": int
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
Deny Refill Command # DENY_REFILL_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
DENY_REFILL_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
DENY_REFILL_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"response_type": str
"reason_code": str
"note_to_pharmacist": str
"refill_request": int
"note":
"uuid": note_id
"patient":
"id": pt_id
Refill Prescription Command # REFILL_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
REFILL_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"prescribe": dict
"indications": list[dict]
"sig": str
"days_supply": int
"quantity_to_dispense": int
"type_to_dispense": dict
"refills": int
"substitutions": str
"pharmacy": dict
"prescriber": dict
"note_to_pharmacist": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REFILL__INDICATIONS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFILL__INDICATIONS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFILL__PHARMACY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFILL__PHARMACY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFILL__PRESCRIBE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[MedicationSearchResult ]
REFILL__PRESCRIBE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFILL__SUPERVISING_PROVIDER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFILL__SUPERVISING_PROVIDER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REFILL__PRESCRIBER__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFILL__PRESCRIBER__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Remove Allergy Command # REMOVE_ALLERGY_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
REMOVE_ALLERGY_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"allergy": dict
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_ALLERGY__ALLERGY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REMOVE_ALLERGY__ALLERGY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Remove Past Medical History Command # REMOVE_PAST_MEDICAL_HISTORY_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
REMOVE_PAST_MEDICAL_HISTORY__CONDITION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
REMOVE_PAST_MEDICAL_HISTORY__CONDITION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
Resolve Condition Command # RESOLVE_CONDITION_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
RESOLVE_CONDITION_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"show_in_condition_list": bool
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
RESOLVE_CONDITION__CONDITION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
RESOLVE_CONDITION__CONDITION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[ConditionSearchResult ]
Review of Systems Command # ROS_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
ROS_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
ROS__QUESTIONNAIRE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
ROS__QUESTIONNAIRE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Snooze Protocol Command # SNOOZE_PROTOCOL_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
SNOOZE_PROTOCOL_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"protocol_key": str
"snooze_until_date": str
"snooze_reason": str
"snooze_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SNOOZE_PROTOCOL__PROTOCOL__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
SNOOZE_PROTOCOL__PROTOCOL__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
Stop Medication Command # STOP_MEDICATION_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
STOP_MEDICATION_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"medication": dict
"rationale": str
"note":
"uuid": note_id
"patient":
"id": pt_id
STOP_MEDICATION__MEDICATION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[MedicationSearchResult ]
STOP_MEDICATION__MEDICATION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Structured Assessment Command # STRUCTURED_ASSESSMENT_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
STRUCTURED_ASSESSMENT_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"questionnaire": dict
"note":
"uuid": note_id
"patient":
"id": pt_id
STRUCTURED_ASSESSMENT__QUESTIONNAIRE__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
STRUCTURED_ASSESSMENT__QUESTIONNAIRE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Surgical History Command # SURGICAL_HISTORY_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
SURGICAL_HISTORY_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"past_surgical_history": dict
"approximate_date":
"input": str
"date": str
"comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
SURGICAL_HISTORY__PAST_SURGICAL_HISTORY__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
SURGICAL_HISTORY__PAST_SURGICAL_HISTORY__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Task Command # TASK_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
TASK_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": str
"priority": str
"comment": str
"labels": list[dict]
"linked_items": list[dict]
"note":
"uuid": note_id
"patient":
"id": pt_id
TASK__ASSIGN_TO__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
TASK__ASSIGN_TO__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
TASK__LABELS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
TASK__LABELS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Update Diagnosis Command # UPDATE_DIAGNOSIS_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
UPDATE_DIAGNOSIS_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"conditionId": str
"newConditionCode": str
"background": str
"narrative": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_DIAGNOSIS__CONDITION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
UPDATE_DIAGNOSIS__CONDITION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
UPDATE_DIAGNOSIS__NEW_CONDITION__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
UPDATE_DIAGNOSIS__NEW_CONDITION__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
Update Goal Command # UPDATE_GOAL_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
UPDATE_GOAL_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"goal_statement": dict
"due_date": str
"achievement_status": str
"priority": str
"progress": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UPDATE_GOAL__GOAL_STATEMENT__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
UPDATE_GOAL__GOAL_STATEMENT__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
Uncategorized Document Review Command # UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"report": str
"message_to_patient": str
"communication_method": str
"internal_comment": str
"note":
"uuid": note_id
"patient":
"id": pt_id
UNCATEGORIZED_DOCUMENT_REVIEW__REPORT__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
UNCATEGORIZED_DOCUMENT_REVIEW__REPORT__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
UNCATEGORIZED_DOCUMENT_REVIEW__COMMUNICATION_METHOD__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
UNCATEGORIZED_DOCUMENT_REVIEW__COMMUNICATION_METHOD__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
Visual Exam Finding # VISUAL_EXAM_FINDING_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
VISUAL_EXAM_FINDING_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VISUAL_EXAM_FINDING_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"narrative": str
"image": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Vitals Command # VITALS_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__POST_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__POST_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_id
VITALS_COMMAND__POST_VALIDATION Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__POST_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__POST_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__POST_INSERTED_INTO_NOTE Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__POST_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__PRE_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__PRE_DELETE Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__PRE_ENTER_IN_ERROR Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__PRE_EXECUTE_ACTION Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__PRE_ORIGINATE Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
VITALS_COMMAND__PRE_UPDATE Target object Context object "id": command_uuid
"type": Command "fields":
"height": str
"weight_lbs": str
"weight_oz": str
"waist_circumference": str
"body_temperature": str
"body_temperature_site": str
"blood_pressure_systole": int
"blood_pressure_diastole": str
"blood_pressure_position_and_site": str
"pulse": str
"pulse_rhythm": str
"respiration_rate": int
"oxygen saturation": str
"note": str
"note":
"uuid": note_id
"patient":
"id": pt_id
Patient Portal Events # PATIENT_PORTAL__APPOINTMENT_CANCELED Occurs after an appointment is canceled Target Target type Context object appt_id Appointment None
PATIENT_PORTAL__APPOINTMENT_RESCHEDULED Occurs after an appointment is rescheduled Target Target type Context object appt_id Appointment None
PATIENT_PORTAL__APPOINTMENT_CAN_BE_CANCELED Occurs when checking if an appointment can be canceled Target Target type Context object appt_id Appointment None
PATIENT_PORTAL__APPOINTMENT_CAN_BE_RESCHEDULED Occurs when checking if an appointment can be rescheduled Target Target type Context object appt_id Appointment None
PATIENT_PORTAL__APPOINTMENTS__SLOTS__POST_SEARCH Occurs after the appointment slots search has been done, allowing the values to be modified Target Target type Context object patient_id Patient "slots_by_provider": {provider: {date: [{"start", "end"}]}} (JSON string)
PATIENT_PORTAL__APPOINTMENTS__FORM_APPOINTMENT_TYPES__PRE_SEARCH Occurs before appointment types are resolved, allowing the internal values to be bypassed Target Target type Context object patient_id Patient None
PATIENT_PORTAL__APPOINTMENTS__FORM_APPOINTMENT_TYPES__POST_SEARCH Occurs after appointment types are resolved, allowing the internal values to be modified Target Target type Context object patient_id Patient "appointment_types": [{"id", "title"}]
PATIENT_PORTAL__APPOINTMENTS__FORM_LOCATIONS__PRE_SEARCH Occurs before appointment locations are resolved, allowing the internal values to be bypassed Target Target type Context object patient_id Patient None
PATIENT_PORTAL__APPOINTMENTS__FORM_LOCATIONS__POST_SEARCH Occurs after appointment locations are resolved, allowing the internal values to be modified Target Target type Context object patient_id Patient "locations": [{"id", "title"}]
PATIENT_PORTAL__APPOINTMENTS__FORM_PROVIDERS__PRE_SEARCH Occurs before appointment providers are resolved, allowing the internal values to be bypassed Target Target type Context object patient_id Patient None
PATIENT_PORTAL__APPOINTMENTS__FORM_PROVIDERS__POST_SEARCH Occurs after appointment providers are resolved, allowing the internal values to be modified Target Target type Context object patient_id Patient "providers": [{"id", "title"}]
PATIENT_PORTAL__GET_FORMS Occurs on every page load of the Patient Portal; It only accepts the PATIENT_PORTAL__FORM_RESULT Target Target type Context object patient_id Patient "requested_from": str["appointment" |
"labs" |
"login" |
"messaging" |
"my-health" |
"payment" |
"search-appointment"]
PATIENT_PORTAL__GET_FORMS is the built-in mechanism for presenting patient forms: respond to it with one or more PATIENT_PORTAL__FORM_RESULTFormResult) and the questionnaires are shown to the patient in a modal after they log in. If you need a different presentation, such as a standalone page where a patient picks from a list of forms to complete before an upcoming appointment, build a custom Application in the patient portal (a portal_menu_item-scoped Application that launches your own UI via LaunchModalEffect) rather than relying on the built-in forms modal.
PATIENT_PORTAL__DOCUMENT_DOWNLOADED Occurs when a patient downloads a clinical document from the Patient Portal. Use it to keep your own record of what a patient has received, such as an after-visit summary or a lab requisition. The event is queued asynchronously once the document is generated, so a handler can't delay or block the download. See Track Document Downloads for the documents that fire it and the context each one carries. Target Target type Context object patient_id Patient "document": str["after_visit_summary", "lab_requisition", "imaging_requisition"]
"note_id": str, the id of the Note (after_visit_summary only)
"order_id": str, the id of the LabOrder or ImagingOrder (lab_requisition and imaging_requisition only)
PATIENT_PORTAL__POST_LOGIN Occurs once, right after a patient logs in to the Patient Portal. Return a LaunchModalEffect with the DEFAULT_MODAL target to open a modal over the page the patient lands on. See Show a Modal After Login . Target Target type Context object patient_id Patient "login_method": str["credentials" |
"access_token" |
"registration"]
Action Buttons Events # For more information on handling these events, see Action Buttons .
Action button and application events include context about the user who triggered them, so you can tailor behavior to the current user (for example, only showing a button to a specific staff member):
{
" user " : {
" id " : " <either staff or patient id> " ,
" type " : " Staff " | " Patient "
}
}
This user context is available in an ActionButton’s visible() and handle() methods and in an Application’s on_open() method.
SHOW_NOTE_HEADER_BUTTON Occurs when patient notes are being loaded Target Context object patient_id
"note_id": str
"user":
"id": str
"type": Staff
SHOW_NOTE_FOOTER_BUTTON Occurs when patient notes are being loaded Target Context object patient_id
"note_id": str
"user":
"id": str
"type": Staff
SHOW_NOTE_BODY_BUTTON Occurs when patient notes are being loaded Target Context object patient_id
"note_id": str
"user":
"id": str
"type": Staff
SHOW_NOTE_BODY_AUTOMATION_BUTTON Occurs when patient notes are being loaded Target Context object patient_id
"note_id": str
"user":
"id": str
"type": Staff
SHOW_NOTE_HEADER_DROPDOWN_BUTTON Occurs when patient notes are being loaded Target Context object patient_id
"note_id": str
"user":
"id": str
"type": Staff
SHOW_CHART_PATIENT_HEADER_BUTTON Occurs when the patient header is being loaded, on both the chart and the profile page. This location sits outside any note, so note_id is null. Target Context object patient_id
"note_id": null
"user":
"id": str
"type": Staff
SHOW_CHART_SUMMARY_SOCIAL_DETERMINANTS_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for social determinants section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_GOALS_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for goals section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_CONDITIONS_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for conditions section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_MEDICATIONS_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for medications section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_ALLERGIES_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for allergies section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_CARE_TEAMS_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for care teams section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_VITALS_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for vitals section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_IMMUNIZATIONS_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for immunizations section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_SURGICAL_HISTORY_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for surgical history section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_FAMILY_HISTORY_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for family history section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
SHOW_CHART_SUMMARY_CODING_GAPS_SECTION_BUTTON Occurs when patient chart summary is being loaded, specifically for coding gaps section Target Target type Context object patient_id Patient
"user":
"id": str
"type": Staff | Patient
ACTION_BUTTON_CLICKED Occurs when an action button is clicked Target Context object patient_id
"key": action_button_key
"user":
"id": str
"type": Staff | Patient
Note Custom Content # NOTE__GET_CUSTOM_CONTENT Occurs when a note renders on an instance in the revamped note beta program . Plugins respond with custom content blocks to show above the note body or inside a note section. See the Note Custom Content effect for usage details. Target note_id
Note Footer Configuration # NOTE_FOOTER__GET_CONFIGURATION Occurs when a note's footer is loaded. Allows plugins to configure the footer — for example, to hide Canvas's default state-transition buttons so plugin-provided buttons replace them. See the Note Footer Configuration effect for usage details. Target Context object note_id empty
Phone Dial Configuration # PHONE_DIAL__GET_CONFIGURATION Occurs when a patient chart loads its phone numbers. Allows plugins to make those numbers clickable and choose whether the device or the plugin handles a click. See the Phone Dial Configuration effect for usage details. Target Context object patient_id empty
PHONE_NUMBER_CLICKED Occurs when a user clicks a clickable phone number in a patient chart. Fires under both device and plugin handling. The context includes at least the following: Target Context object phone_number
"phone_number": str
"source": str
"user":
"id": str
"type": Staff
Application Events # For more information on these events, see Applications .
APPLICATION__ON_GET Occurs when Canvas requests the available applications for a given scope. Handled automatically by Note Applications to return application metadata via the SHOW_APPLICATION effect. Target Context object scope
"scope": str
"patient":
"id": str
"user":
"id": str
"type": Staff | Patient
APPLICATION__ON_OPEN Occurs when a user clicks on an application icon to open it Target Context object application_id
"patient":
"id": str
"user":
"id": str
"type": Staff | Patient
Payment Processor Events # These events drive the custom Payment Processor handlers. They are dispatched as a user moves through a payment workflow, and the actor that initiated the workflow is set on each event (see Event Actor ). Every event other than REVENUE__PAYMENT_PROCESSOR__LIST includes the identifier of the processor it targets, so a handler only acts when the identifier matches its own.
The identifier is the unique id of the payment processor handler the event is intended for. Canvas derives it from the handler’s class (its module path and class name) and exposes it on the handler as self.identifier; it is the same value the handler advertises via the PaymentProcessorMetadataREVENUE__PAYMENT_PROCESSOR__LIST.
REVENUE__PAYMENT_PROCESSOR__LIST Occurs when Canvas gathers the list of available payment processors. A handler responds with a PaymentProcessorMetadata effect. Target Context object None "payment_type": str # optional, e.g. "card"
REVENUE__PAYMENT_PROCESSOR__SELECTED Occurs when a payment processor is selected. A handler responds with one or more PaymentProcessorForm effects. Target Context object None "identifier": str
"intent": str # optional, "pay" | "add_card"
"patient":
"id": str # optional
REVENUE__PAYMENT_PROCESSOR__CHARGE Occurs when a card is charged. A handler responds with a CardTransaction effect. Target Context object None "identifier": str
"amount": str
"token": str
"additional_context": str # optional
"patient":
"id": str # optional
REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__LIST Occurs when Canvas lists a patient's saved payment methods. A handler responds with one or more PaymentMethod effects. Target Context object None "identifier": str
"patient":
"id": str # optional
REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__ADD Occurs when a payment method is added for a patient. A handler responds with an AddPaymentMethodResponse effect. Target Context object None "identifier": str
"token": str
"additional_context": str # optional
"patient":
"id": str
REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__REMOVE Occurs when a payment method is removed for a patient. A handler responds with a RemovePaymentMethodResponse effect. Target Context object None "identifier": str
"token": str
"patient":
"id": str
Stored Card Charge Events # This event reports the outcome of a Charge Stored Card effect. Unlike the payment processor events above, it is not a request for a handler to respond to: the charge has already been attempted, and nothing a handler returns changes it. Handle it to reconcile the result, and correlate it with the charge that produced it using idempotency_key, which is echoed from the request.
Apart from success and error, every value arrives as a string or null, including the amount and the ids that were UUIDs on the request. The context is already parsed into a dictionary on self.event.context, and the actor is the one that emitted the originating effect.
REVENUE__STORED_CARD__CHARGE_RESPONSE Occurs when a ChargeStoredCard effect has finished processing, whether or not the card was charged. Carries no card data or PHI. Target object Context object "id": pt_id
"type": Patient "success": bool # whether the card was charged
"payment_intent_id": str # processor's payment id, null on failure
"error": # null on success
"code": str # see Error codes
"message": str
"idempotency_key": str # echoed, use this to correlate
"patient_id": str # echoed, a Patient id
"payment_card_id": str # echoed, a PaymentCard id under Stripe
"claim_id": str # echoed, a Claim id, null when none
"amount": str # echoed, the dollar amount submitted
Patient Portal Events # APPLICATION__ON_CONTEXT_CHANGE Occurs when a user navigates to a different URL while an application is open. Currently supported for revenue workflows. Target Context object application_id
"url": str
"patient":
"id": str
"user":
"id": str
"type": Staff | Patient
"claim": (optional)
"id": str
"claim_queue": (optional)
"dbid": str
APPLICATION__GET_NOTIFICATION_BADGE Occurs when Canvas loads applications and requests the current notification badge count. Respond by overriding compute_notification_badge() on your Application handler. Target Context object application_id
"staff":
"id": str
"type": Staff
"patient":
"id": str
"type": Patient
Patient Chart Configuration # PATIENT_CHART__CONDITIONS Occurs when the conditions are loaded on the patient chart. Target object Context object "id": patient_id
"type": Patient "conditions":
"id": condition id
"codings":
"code": str
"system": str
"display": str
PATIENT_CHART__MEDICATIONS Occurs when the medications are loaded on the patient chart. Target object Context object "id": patient_id
"type": Patient "medications":
"id": medication id
"codings":
"code": str
"system": str
"display": str
PATIENT_CHART__DETECTED_ISSUES Occurs when the detected issues are loaded on the patient chart. The context is a bare list rather than an object keyed by name, so iterate self.context directly. Each entry carries only an id; read anything else about the issue through DetectedIssue . Target object Context object "id": patient_id
"type": Patient list of:
"id": detected issue id
Patient Timeline Configuration # PATIENT_TIMELINE__GET_CONFIGURATION Occurs when a patient's chart is loaded. Allows plugins to configure which note types are visible on the timeline, and which the New Note button may offer. See the Patient Timeline effect for usage details. Target object Context object "id": patient_key
"type": Patient empty
Patient Group # PATIENT_GROUP_CREATED Occurs when a patient group is created Target object Context object "id": patient_group_id
"type": Patient Group empty
PATIENT_GROUP_UPDATED Occurs when a patient group is updated Target object Context object "id": patient_group_id
"type": Patient Group empty
PATIENT_GROUP_MEMBERSHIP_CREATED Occurs when a patient is added as a member of a group Target object Context object "id": patient_group_id
"type": Patient Group "patient":
"id": str
"group":
"id": str
PATIENT_GROUP_MEMBERSHIP_UPDATED Occurs when a patient’s group membership is updated Target object Context object "id": patient_group_id
"type": Patient Group "patient":
"id": str
"group":
"id": str
PATIENT_GROUP_MEMBERSHIP_DELETED Occurs when a patient member is removed from a patient group Target object Context object "id": patient_group_id
"type": Patient Group "patient":
"id": str
"group":
"id": str
SSO Events # For more information on these events, see SSO Capabilities .
Event Occurs when SSO__PROCESS_ADDITIONAL_REQUEST_DATA A user has just authenticated via SAML SSO. Read-only access to the SAML response. See SSO Capabilities . SSO__GET_POST_LOGIN_REDIRECT A user has just authenticated via SAML SSO and Canvas is deciding where to send them. Return a REDIRECT_CONTEXT effect to override the destination. See SSO Capabilities .
Other Events # Event Occurs when UNKNOWN Default event type unlikely to ever be emitted. CRON This event fires regularly and can be used for scheduled tasks. See CronTask . PATIENT_CHART_SUMMARY__SECTION_CONFIGURATION A patient chart's summary section is loading. This event fires very frequently — potentially tens of times per page load — so it should not be used to trigger database writes such as creating banner alerts or making API requests; doing so will slow page loads considerably. Create banner alerts at the time the underlying data is written (for example, on a patient external identifier event) rather than at display time. PATIENT_CHART_SUMMARY__GET_CUSTOM_SECTION Canvas is requesting the content for a custom patient chart summary section. See Patient Chart Summary Custom Section Handler . PANEL_SECTIONS_CONFIGURATION The panel section is loading. GET_PROVIDER_MENU_CONFIGURATION The provider (hamburger) menu is loading. See Provider Menu Configuration . PLUGIN_CREATED A plugin is uploaded for the first time. See ProtocolCards and BannerAlerts for examples of how to use this event. PLUGIN_UPDATED A plugin is enabled or when the plugin code has changed. See ProtocolCards and BannerAlerts for examples of how to use this event. PATIENT_PROFILE__ADD_PHARMACY__POST_SEARCH Adding a pharmacy for a patient in their profile. Reply with PATIENT_PROFILE__ADD_PHARMACY__POST_SEARCH_RESULTS to supply the results. FAX__RECIPIENT__PRE_SEARCH Searching for a fax recipient, before the search runs. Reply with AUTOCOMPLETE_SEARCH_RESULTS to supply the results; returning nothing runs the normal search. See Service Provider search results . "search_term": str
"source": "fax"
"results": list[dict]
"user":
"staff": str FAX__RECIPIENT__POST_SEARCH Searching for a fax recipient, after the search runs. Reply with AUTOCOMPLETE_SEARCH_RESULTS to replace or annotate the results. "search_term": str
"source": "fax"
"results": list[dict]
"user":
"staff": str PATIENT_PROFILE__EXTERNAL_CARE_TEAM__PRE_SEARCH Searching for a provider to add to a patient's external care team, before the search runs. Reply with AUTOCOMPLETE_SEARCH_RESULTS to supply the results; returning nothing runs the normal search. "search_term": str
"source": "care_team"
"results": list[dict]
"user":
"staff": str PATIENT_PROFILE__EXTERNAL_CARE_TEAM__POST_SEARCH Searching for a provider to add to a patient's external care team, after the search runs. Reply with AUTOCOMPLETE_SEARCH_RESULTS to replace or annotate the results. "search_term": str
"source": "care_team"
"results": list[dict]
"user":
"staff": str PATIENT_PORTAL__WIDGET_CONFIGURATION Patient Portal landing page is loading. See Tailoring Portal Landing Page for examples of how to use this event. PATIENT_METADATA__GET_ADDITIONAL_FIELDS Patient Profile is loading. See How to add patient profile additional fields for examples of how to use this event. "patient":
"id": str
"user":
"id": str
"type": Staff | Patient GET_HOMEPAGE_CONFIGURATION Homepage is loading. See Set default homepage for examples of how to use this event. COMMAND__FORM__GET_ADDITIONAL_FIELDS Command is originated. See Command metadata Create Form for how to use this event. "command_uuid": str Context object: "schema_key": str
"purpose": "form" | "print"
One-time backfill with PLUGIN_UPDATED # Event-driven plugins only react to changes that happen after they are installed, so existing records (for example, patients who already have a qualifying external identifier) will not trigger them. To apply an effect to existing records when a plugin is published, write a separate handler that responds to PLUGIN_UPDATED, queries for the records that need the effect, and returns the effects for any that do not already have it. For example, a backfill handler can find every patient with a matching external identifier and no existing Banner Alert , and return an AddBannerAlert effect for each. Because the handler checks for the alert before creating it (keyed by the banner’s key), it is idempotent — you can upload it once, remove it, or re-upload it later without creating duplicates.
Search Result Data Structures # Many event payloads include search results. This section documents the common structures within them.
MedicationSearchResult # Medication search events (such as MEDICATION_STATEMENT__MEDICATION__POST_SEARCH, PRESCRIBE__PRESCRIBE__POST_SEARCH, etc.) return results that follow this structure:
{
"text" : "acetaminophen 500 mg tablet" ,
"disabled" : false ,
"description" : null ,
"annotations" : null ,
"extra" : {
"coding" : [
{
"code" : 206813 ,
"display" : "acetaminophen 500 mg tablet" ,
"system" : "http://www.fdbhealth.com/"
},
{
"code" : "198440" ,
"display" : "acetaminophen 500 mg tablet" ,
"system" : "http://www.nlm.nih.gov/research/umls/rxnorm"
}
],
"clinical_quantities" : [
{
"erx_quantity" : "1.0000000" ,
"representative_ndc" : "57896021910" ,
"clinical_quantity_description" : "tablet" ,
"erx_ncpdp_script_quantity_qualifier_code" : "C48542" ,
"erx_ncpdp_script_quantity_qualifier_description" : "Tablet"
}
]
},
"value" : 206813
}
For detailed information about medication data structures, see Medication .
For examples of working with medication search results, see the Customize Search Results guide.
ConditionSearchResult # Condition/diagnosis search events (such as DIAGNOSE__DIAGNOSE__POST_SEARCH, MEDICAL_HISTORY__PAST_MEDICAL_HISTORY__POST_SEARCH, etc.) return results that follow this structure:
{
"text" : "Broken internal left hip prosthesis, subsequent encounter" ,
"disabled" : false ,
"description" : null ,
"annotations" : [ "T84.011D" ],
"extra" : {
"coding" : [
{
"code" : "T84011D" ,
"display" : "Broken internal left hip prosthesis, subsequent encounter" ,
"system" : "ICD-10"
},
{
"code" : 404684003 ,
"display" : "Broken internal left hip prosthesis, subsequent encounter" ,
"system" : "http://snomed.info/sct"
}
]
},
"value" : "T84011D"
}
The Assess command’s condition search lists the patient’s charted conditions before new ICD-10 codes. A plugin handling ASSESS__CONDITION__PRE_SEARCH or ASSESS__CONDITION__POST_SEARCH can receive both kinds of result:
Charted conditions come first, active ones before the rest. A resolved condition is left out when an active condition has the same ICD-10 code. Picking it would make it a second active condition. An empty search term returns only charted conditions. A search term matches a charted condition when its ICD-10 code contains the term. It also matches when every word of the term appears in the condition’s name, in any order. A charted condition’s value is the condition’s id rather than an ICD-10 code, and its extra has no coding. Its annotations hold the ICD-10 code followed by the condition’s clinical status, such as Active or Resolved.ICD-10 codes from the terminology search follow, in the structure shown above. A code the patient already has charted is listed as the charted condition instead, so picking it doesn’t record a duplicate.{
"text" : "Unilateral primary osteoarthritis, right knee" ,
"annotations" : [ "M17.11" , "Active" ],
"value" : 4217
}
For detailed information about condition data structures, see Condition .
AllergySearchResult # Allergy search events (such as ALLERGY__ALLERGY__POST_SEARCH, REMOVE_ALLERGY__ALLERGY__POST_SEARCH, etc.) return results that follow this structure:
{
"text" : "Penicillins (allergy group)" ,
"disabled" : false ,
"description" : null ,
"annotations" : null ,
"extra" : {
"coding" : [
{
"code" : 476 ,
"display" : "Penicillins" ,
"system" : "http://www.fdbhealth.com/"
}
],
"category_id" : 1 ,
"category" : "allergy group"
},
"value" : 476
}
For detailed information about allergy data structures, see Allergy Intolerance .
Questions? Create an issue.