Skip to main content
Version: 3.1

Token

Definition

A token in Care is a numbered place in a queue. Care gives a token to a patient so that staff call the patient in order.

A token belongs to one token queue. The queue holds the tokens for one resource on one date. The resource is a practitioner, a location, or a healthcare service.

Key Attributes

ComponentsWhat it captures
Token NumberThe number of the token in its queue.
PatientThe patient that holds the token.
Token QueueThe queue that the token belongs to.
Token CategoryThe category of the token. This is required.
Sub QueueThe service point that serves the token. This is optional.
StatusThe state of the token.
NoteFree text about the token. This is optional.
BookingThe appointment that the token belongs to, when staff generate the token from an appointment.

Status values

StatusWhat it means
CreatedCare created the token, and the patient waits.
In ProgressStaff are serving the patient.
FulfilledStaff finished serving the patient.
UnfulfilledStaff did not serve the patient.
CancelledStaff cancelled the token.
Entered in ErrorStaff recorded the token by mistake.

Token queues

A token queue holds the tokens for one resource on one date. A queue has a name, and one queue for a resource is the primary queue. Care creates some queues automatically.

Sub queues

A sub queue is a service point inside a queue. Use sub queues when more than one place serves the same queue, for example more than one room for vaccination. A sub queue is active or inactive, and it records the token that it serves now.

Token categories

A token category groups tokens, for example by the kind of visit. Each category has a name and a shorthand. An administrator sets one category as the default for the facility.

Permissions

PermissionWhat it allows
Can Create on TokenCreate tokens and change them.
Can list token on ObjectSee tokens and queues.
Can Create on Token CategoryCreate and change token categories.
Can list token category on FacilitySee the token categories of the facility.