Command

Introduction #

The Command model represents a command in a note.

Basic usage #

To get a command by identifier, use the get method on the Command model manager:

from canvas_sdk.v1.data.command import Command

command = Command.objects.get(id="b80b1cdc-2e6a-4aca-90cc-ebc02e683f35")

Filtering #

Commands can be filtered by any attribute that exists on the model.

Filtering for commands is done with the filter method on the Command model manager.

By attribute #

Specify an attribute with filter to filter by that attribute:

from canvas_sdk.v1.data.command import Command

commands = Command.objects.filter(state="committed")

Attributes #

Command #

Field NameType
idUUID
dbidInteger
createdDateTime
modifiedDateTime
originatorCanvasUser
committerCanvasUser
entered_in_errorCanvasUser
stateString
patientPatient
note_idInteger
schema_keyString
dataJSON
origination_sourceString