Events Last updated: 24 Feb 2026
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 .
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. It should be available for events that are directly initiated or triggered by a user — for example, SimpleAPI events, command pre- and post-search events, action button events. For side-effect events or automated events where the action cannot be attributed to a specific user, the actor may be absent.
from 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.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
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. Target object Context object "id": patientfacilityaddress_id
"type": PatientFacilityAddress "patient":
"id": pt_id
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 # 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_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 Metadata # APPOINTMENT_METADATA_CREATED Occurs when an appointment's metadata is created. Target object Context object "id": appointmentmetadata_id
"type": AppointmentMetadata empty
APPOINTMENT_METADATA_UPDATED Occurs when an appointment's metadata is updated. Target object Context object "id": appointmentmetadata_id
"type": AppointmentMetadata empty
Claims # CLAIM_CREATED Occurs when a claim is created. Target object Context object "id": claim_id
"type": Claim "patient":
"id": pt_id
"note":
"uuid": note_id
CLAIM_UPDATED Occurs when a claim is updated. Target object Context object "id": claim_id
"type": Claim "patient":
"id": pt_id
"note":
"uuid": note_id
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
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. 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
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 # 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": Medication "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": Medication "patient":
"id": pt_id
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_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 if a note state change event is updated. Locking and unlocking both trigger an update event, and there is an *additional* update event when an archived PDF copy of the note finishes generating; this is done asynchronously. Target object Context object "id": nsce_id
"type": NoteStateChangeEvent "note_id": note_id,
"patient_id": pt_id,
"state": str
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 action event is created. Target object Context object "id": letter_action_event_id
"type": LetterActionEvent empty LETTER_ACTION_EVENT_UPDATED Occurs when a letter action event is updated. Target object Context object "id": letter_action_event_id
"type": LetterActionEvent empty
#### ObservationsOBSERVATION_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 OverridesPROTOCOL_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 ReportsREFERRAL_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
#### TasksTASK_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 task's labels are changed. 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
#### StaffSTAFF_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
#### Vital SignsVITAL_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 eventsThese events fire during the command lifecycle.#### Generic eventsEvent 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 command is added to a note in the UI. AVAILABLE_ACTIONS When a command is rendered in the UI, after any update to data, state, or other changes
##### Context OverviewEach 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`)**:```json { "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` Context**: Since the command is not yet connected to a note, the `PRE_COMMAND_ORIGINATE` event context only includes:```json { "fields": { "key": "value" } } ```- `fields`: Contains details specific to the command being originated.---#### Adjust Prescription CommandADJUST_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_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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
#### Allergy CommandALLERGY_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_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
}
"results": list[dict]
#### Assess CommandASSESS_COMMAND__CONDITION_SELECTED Target object Context object "id": command_uuid
"type": Command "fields":
"condition": dict
"background": str
"status": str
"narrative": 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
"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
"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
"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
"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
"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
"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
"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
"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
"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
"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
"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
"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
"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
}
"results": list[ConditionSearchResult ]
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 CommandEvent Description CANCEL_PRESCRIPTION_COMMAND__PRE_ORIGINATE CANCEL_PRESCRIPTION_COMMAND__POST_ORIGINATE CANCEL_PRESCRIPTION_COMMAND__PRE_UPDATE CANCEL_PRESCRIPTION_COMMAND__POST_UPDATE CANCEL_PRESCRIPTION_COMMAND__PRE_COMMIT CANCEL_PRESCRIPTION_COMMAND__POST_COMMIT CANCEL_PRESCRIPTION_COMMAND__PRE_DELETE CANCEL_PRESCRIPTION_COMMAND__POST_DELETE CANCEL_PRESCRIPTION_COMMAND__PRE_ENTER_IN_ERROR CANCEL_PRESCRIPTION_COMMAND__POST_ENTER_IN_ERROR CANCEL_PRESCRIPTION_COMMAND__AVAILABLE_ACTIONS CANCEL_PRESCRIPTION_COMMAND__POST_VALIDATION CANCEL_PRESCRIPTION_COMMAND__PRE_EXECUTE_ACTION CANCEL_PRESCRIPTION_COMMAND__POST_EXECUTE_ACTION CANCEL_PRESCRIPTION__SELECTED_PRESCRIPTION__PRE_SEARCH CANCEL_PRESCRIPTION__SELECTED_PRESCRIPTION__POST_SEARCH
#### Change Medication CommandCHANGE_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__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_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_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
}
"results": list[dict]
#### Clipboard CommandCLIPBOARD_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 ContextThe Clipboard Command provides the following fields in its context:| Field | Type | Description | | ------ | -------- | --------------------------------------------- | | `text` | _string_ | The raw text content copied to the clipboard. |Refer to the [base context documentation](#context-overview) for additional details about the full context structure.```json { "note": { "uuid": "note-123" }, "patient": { "id": "patient-123" }, "fields": { "text": "Patient complains of persistent headaches for the past two weeks." } } ```---#### Close Goal CommandCLOSE_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_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
}
"results": list[dict]
#### Diagnose CommandDIAGNOSE_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_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
}
"results": list[dict]
#### Educational Material CommandEDUCATIONAL_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_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
}
"results": list[dict]
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
}
"results": list[dict]
#### Family History CommandFAMILY_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_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
}
"results": list[dict]
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
}
"results": list[dict]
#### Follow Up CommandFOLLOW_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_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
}
"results": list[dict]
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
}
"results": list[dict]
#### Goal CommandGOAL_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_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 CommandHISTORY_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_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 CommandIMAGING_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_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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
#### Imaging Review CommandIMAGING_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
}
"results": list[dict]
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
}
"results": list[dict]
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 CommandIMMUNIZATION_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_COMMAND__AVAILABLE_ACTIONS Target object Context object "id": command_uuid
"type": Command "actions":
"name": string
"user":
"staff": staff_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_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
}
"results": list[dict]
#### Immunize CommandIMMUNIZE_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_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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
#### Instruct CommandINSTRUCT_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_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
}
"results": list[dict]
#### Lab Order CommandLAB_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_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_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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
#### Lab Review CommandLAB_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
}
"results": list[dict]
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
}
"results": list[dict]
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 CommandMEDICAL_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_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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
#### Medication Statement CommandMEDICATION_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_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
}
"results": list[MedicationSearchResult ]
#### Perform CommandPERFORM_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_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
}
"results": list[dict]
#### Physical Exam CommandPHYSICAL_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_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
}
"results": list[dict]
#### Plan CommandPLAN_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_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
#### Prescribe CommandPRESCRIBE_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_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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[MedicationSearchResult ]
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
}
"results": list[dict]
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
}
"results": list[dict]
#### Questionnaire CommandQUESTIONNAIRE_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_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
}
"results": list[dict]
#### Reason for Visit CommandREASON_FOR_VISIT_COMMAND__POST_COMMIT 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 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
}
"results": list[dict]
#### Refer CommandREFER_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_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_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_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_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_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_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_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_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_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_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_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_COMMAND__REFER_TO__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER_COMMAND__REFER_TO__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER_COMMAND__INDICATIONS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER_COMMAND__INDICATIONS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER_COMMAND__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_COMMAND__DOCUMENTS_TO_INCLUDE__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER_COMMAND__LINKED_ITEMS__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
REFER_COMMAND__LINKED_ITEMS__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
#### Referral Review CommandREFERRAL_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
}
"results": list[dict]
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
}
"results": list[dict]
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]
#### Refill Prescription CommandREFILL_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_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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
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
}
"results": list[dict]
#### Remove Allergy CommandREMOVE_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_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
}
"results": list[dict]
#### Resolve Condition CommandRESOLVE_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_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
}
"results": list[dict]
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 CommandROS_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_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
}
"results": list[dict]
#### Snooze Protocol CommandEvent Description SNOOZE_PROTOCOL_COMMAND__PRE_ORIGINATE SNOOZE_PROTOCOL_COMMAND__POST_ORIGINATE SNOOZE_PROTOCOL_COMMAND__PRE_UPDATE SNOOZE_PROTOCOL_COMMAND__POST_UPDATE SNOOZE_PROTOCOL_COMMAND__PRE_COMMIT SNOOZE_PROTOCOL_COMMAND__POST_COMMIT SNOOZE_PROTOCOL_COMMAND__PRE_DELETE SNOOZE_PROTOCOL_COMMAND__POST_DELETE SNOOZE_PROTOCOL_COMMAND__PRE_ENTER_IN_ERROR SNOOZE_PROTOCOL_COMMAND__POST_ENTER_IN_ERROR SNOOZE_PROTOCOL_COMMAND__AVAILABLE_ACTIONS SNOOZE_PROTOCOL_COMMAND__POST_VALIDATION SNOOZE_PROTOCOL_COMMAND__PRE_EXECUTE_ACTION SNOOZE_PROTOCOL_COMMAND__POST_EXECUTE_ACTION SNOOZE_PROTOCOL__PROTOCOL__PRE_SEARCH SNOOZE_PROTOCOL__PROTOCOL__POST_SEARCH
#### Stop Medication CommandSTOP_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_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
}
"results": list[dict]
#### Structured Assessment CommandSTRUCTURED_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_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
}
"results": list[dict]
#### Surgical History CommandSURGICAL_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_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
}
"results": list[dict]
#### Task CommandTASK_COMMAND__POST_COMMIT Target object Context object "id": command_uuid
"type": Command "fields":
"title": str
"assign_to": dict
"due_date": 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
"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
"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
"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
"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
"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
"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
"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
"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
"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
"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
"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
"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
}
"results": list[dict]
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
}
"results": list[dict]
#### Update Diagnosis CommandEvent Description UPDATE_DIAGNOSIS_COMMAND__PRE_ORIGINATE UPDATE_DIAGNOSIS_COMMAND__POST_ORIGINATE UPDATE_DIAGNOSIS_COMMAND__PRE_UPDATE UPDATE_DIAGNOSIS_COMMAND__POST_UPDATE UPDATE_DIAGNOSIS_COMMAND__PRE_COMMIT UPDATE_DIAGNOSIS_COMMAND__POST_COMMIT UPDATE_DIAGNOSIS_COMMAND__PRE_DELETE UPDATE_DIAGNOSIS_COMMAND__POST_DELETE UPDATE_DIAGNOSIS_COMMAND__PRE_ENTER_IN_ERROR UPDATE_DIAGNOSIS_COMMAND__POST_ENTER_IN_ERROR UPDATE_DIAGNOSIS_COMMAND__AVAILABLE_ACTIONS UPDATE_DIAGNOSIS_COMMAND__POST_VALIDATION UPDATE_DIAGNOSIS_COMMAND__PRE_EXECUTE_ACTION UPDATE_DIAGNOSIS_COMMAND__POST_EXECUTE_ACTION UPDATE_DIAGNOSIS__CONDITION__PRE_SEARCH UPDATE_DIAGNOSIS__CONDITION__POST_SEARCH UPDATE_DIAGNOSIS__NEW_CONDITION__PRE_SEARCH UPDATE_DIAGNOSIS__NEW_CONDITION__POST_SEARCH
#### Update Goal CommandUPDATE_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_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
}
"results": list[dict]
#### Uncategorized Document Review CommandUNCATEGORIZED_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_COMMAND__REPORT__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__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_COMMAND__COMMUNICATION_METHOD__PRE_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND__COMMUNICATION_METHOD__POST_SEARCH Target object Context object "id": command_uuid
"type": Command "search_term": str
"user": {
"staff": staff_key
}
"results": list[dict]
#### Vitals CommandVITALS_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_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 lifecycle eventsThe following events are emitted during the lifecycle of a patient portal session.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 None None "slots_by_provider": dict
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 None None 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 None None "appointment_types": list[dict]
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 None None 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 None None "locations": list[dict]
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 None None 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 None None "providers": list[dict]
### Action Buttons EventsFor more information on handling these events, see Action Buttons .SHOW_NOTE_HEADER_BUTTON Occurs when patient notes are being loaded Target Context object patient_id
"note_id": str
"user":
"id": str
"type": Staff | Patient
SHOW_NOTE_FOOTER_BUTTON Occurs when patient notes are being loaded Target Context object patient_id
"note_id": str
"user":
"id": str
"type": Staff | Patient
SHOW_NOTE_BODY_BUTTON Occurs when patient notes are being loaded Target Context object patient_id
"note_id": str
"user":
"id": str
"type": Staff | Patient
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
### Application EventsFor more information on these events, see Applications .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
### Patient Portal EventsPATIENT_PORTAL__GET_FORMS Occurs on every page load of the Patient Portal; It only accepts the `PATIENT_PORTAL__FORM_RESULT` effect as a return value Target Target type Context object patient_id Patient "requested_from": str["appointment" |
"labs" |
"login" |
"messaging" |
"my-health" |
"payment" |
"search-appointment"]
### Patient Chart ConfigurationPATIENT_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 Timeline ConfigurationPATIENT_TIMELINE__GET_CONFIGURATION Occurs when a patient's timeline is loaded. Allows plugins to configure which note types are visible on the timeline. See the Patient Timeline effect for usage details. Target object Context object "id": patient_key
"type": Patient empty
### Other EventsEvent 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 . CLAIM__CONDITIONS The conditions are loaded within the claim summary. PATIENT_CHART_SUMMARY__SECTION_CONFIGURATION A patient chart's summary section is loading. PANEL_SECTIONS_CONFIGURATION The panel section is loading. 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_RESULTS Adding a pharmacy for a patient in their profile. 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.
### Search Result Data StructuresMany event payloads include search results. This section documents the common structures within them.#### MedicationSearchResultMedication search events (such as `MEDICATION_STATEMENT__MEDICATION__POST_SEARCH`, `PRESCRIBE__PRESCRIBE__POST_SEARCH`, etc.) return results that follow this structure:```json { "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](/sdk/data-medication/).For examples of working with medication search results, see the [Customize Search Results](/guides/customize-search-results/) guide.#### ConditionSearchResultCondition/diagnosis search events (such as `DIAGNOSE__DIAGNOSE__POST_SEARCH`, `MEDICAL_HISTORY__PAST_MEDICAL_HISTORY__POST_SEARCH`, etc.) return results that follow this structure:```json { "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" } ```For detailed information about condition data structures, see [Condition](/sdk/data-condition/).#### AllergySearchResultAllergy search events (such as `ALLERGY__ALLERGY__POST_SEARCH`, `REMOVE_ALLERGY__ALLERGY__POST_SEARCH`, etc.) return results that follow this structure:```json { "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](/sdk/data-allergy-intolerance/).
Questions? Create an issue.