c1package

National API with C1 Package
Parameters
AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

Retrieve a list of appointments Retrieve a list of appointment types Retrieve the current EMR capabilities Retrieve a list of consultants Add a new consultant Update a specific consultant Retrieve a specific consultant Remove a specific consultant Retrieve a list of encounters Retrieve a specific encounter Add a new richtext encounter Add a new encounter Retrieve a list of facilities Retrieve a specific facility Retrieve a list of patients Retrieve a specific patient Retrieve a specific patient with specific detail level Update a patient's demographics Patch a patient's demographics Retrieve a list of linked documents Add a new linked document Retrieve a specific linked document Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve a list of providers Retrieve a specific provider by ID Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of schedule appointments Create an appointment Update an appointment Patch an appointment Retrieve a list of schedulables Retrieve a list of schedule summaries Add a schedule summary Update a schedule summary Remove a schedule summary Retrieve a list of tutorials Retrieve a list of tutorials Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an Encounter Summary Aggregate (Content 1 Package)
InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

Retrieve a list of appointments Retrieve a list of appointment types Retrieve the current EMR capabilities Retrieve a list of consultants Add a new consultant Update a specific consultant Retrieve a specific consultant Remove a specific consultant Retrieve a list of encounters Retrieve a specific encounter Add a new richtext encounter Add a new encounter Retrieve a list of facilities Retrieve a specific facility Retrieve a list of patients Retrieve a specific patient Retrieve a specific patient with specific detail level Update a patient's demographics Patch a patient's demographics Retrieve a list of linked documents Add a new linked document Retrieve a specific linked document Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve a list of providers Retrieve a specific provider by ID Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of schedule appointments Create an appointment Update an appointment Patch an appointment Retrieve a list of schedulables Retrieve a list of schedule summaries Add a schedule summary Update a schedule summary Remove a schedule summary Retrieve a list of tutorials Retrieve a list of tutorials Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an Encounter Summary Aggregate (Content 1 Package)
UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

InstanceToken
string optional

This token is obtained by registering an EMR instance. This token is used to authenticate EMR instances making use of the Administration Services.

Logout EMR session
IncludeDeleted
boolean optional

If true it will make sure deleted items are also returned

Headers
If-Modified-Since
string date optional

If modified since date filter, defined by RFC 7232 Section 3.3. Date must be HTTP-Date format defined by RFC 7231 Section 7.1.1

Authorization
string required

Admin Services Token (AST) as "Bearer <token>"

Pattern:Bearer <token>
Example:
Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6Ik1hcmlrYSIsInR5cCI6IkpXVCJ9.eyJFbXJUeXBlIjoiTWVkZXN5bmMiLCJFbXJJbn...
Responses
404 404

Not found

EncounterSummaryAggregateResponse

Encounter Summary Aggregate Response

Operations
appointments

Operations for appointments

GET /{EmrType}/{InstanceId}/appointments
Retrieve a list of appointments
GET /{EmrType}/{InstanceId}/appointments

Search for appointments. If the AppointmentId is provided then all other parameters will be ignored.

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

AppointmentId
string optional

Search for a specific appointment by ID. All other parameters ignored

ProviderId
string optional

The User ID in the source EMR Instance of the appointment provider to filter on

PatientId
string optional

ID of patient’s encounters to search for

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

SearchBackwards
boolean optional

Search direction when dates are supplied. This affects how paging works - if searching backwards then by default only the 20 most recent appointments before the end date are returned.

IncludeDeleted
boolean optional

If true it will make sure deleted items are also returned

Type
string optional

Appointment type (All, Scheduled, Arrived, Cancelled, Data) - Not used for now

Request headers

If-Modified-Since
string date optional

If modified since date filter, defined by RFC 7232 Section 3.3. Date must be HTTP-Date format defined by RFC 7231 Section 7.1.1

Responses

200 OK

Returns the appointments.

appointmenttypes

Operations for appointment types

GET /{EmrType}/{InstanceId}/appointmenttypes
Retrieve a list of appointment types
GET /{EmrType}/{InstanceId}/appointmenttypes

Search for appointment types. If the AppointmentTypeId is provided then all other parameters will be ignored.

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

AppointmentTypeId
string optional

Search for a specific appointment type by ID. All other parameters ignored

Request headers

If-Modified-Since
string date optional

If modified since date filter, defined by RFC 7232 Section 3.3. Date must be HTTP-Date format defined by RFC 7231 Section 7.1.1

Responses

200 OK

Returns the appointment types.

capabilities

Operations for capabilities

GET /{EmrType}/{InstanceId}/capabilities
Retrieve the current EMR capabilities
GET /{EmrType}/{InstanceId}/capabilities

Returns the current capabilities of the EMR

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

Responses

200 OK

Returns the capabilities of the EMR.

consultants

Operations for consultants

GET /{EmrType}/{InstanceId}/consultants
POST /{EmrType}/{InstanceId}/consultants
PUT /{EmrType}/{InstanceId}/consultants
GET /{EmrType}/{InstanceId}/consultants/{ConsultantId}
DELETE /{EmrType}/{InstanceId}/consultants/{ConsultantId}
Retrieve a list of consultants
GET /{EmrType}/{InstanceId}/consultants

Returns the list of consultants

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

ConsultantId
string optional

Specific consultant to search for, all other parameters ignored

SearchString
string optional

String to use for searching

Responses

200 OK

Returns the consultants.

Add a new consultant
POST /{EmrType}/{InstanceId}/consultants

Add a new consultant

Supported by:

  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

Responses

200 OK

Returns the consultants.

Update a specific consultant
PUT /{EmrType}/{InstanceId}/consultants

Update a specific consultant

Supported by:

  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

Responses

200 OK

Returns the consultants.

Retrieve a specific consultant
GET /{EmrType}/{InstanceId}/consultants/{ConsultantId}

Returns the list of consultants

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ConsultantId
string required

Specific consultant to search for, all other parameters ignored

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

Responses

200 OK

Returns the consultants.

Remove a specific consultant
DELETE /{EmrType}/{InstanceId}/consultants/{ConsultantId}

Remove a consultant by ID

Supported by:

  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ConsultantId
string required

ID of the consultant to remove

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Responses

200 OK

Returns the consultants.

encounters

Operations for encounters

GET /{EmrType}/{InstanceId}/encounters
GET /{EmrType}/{InstanceId}/encounters/{EncounterId}
POST /{EmrType}/{InstanceId}/patients/{PatientId}/encounters/richtext
POST /{EmrType}/{InstanceId}/patients/{PatientId}/encounters
Retrieve a list of encounters
GET /{EmrType}/{InstanceId}/encounters

Returns the list of encounters

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

EncounterId
string optional

ID of the encounter

PatientId
string optional

ID of the patient

DetailLevel
string optional

Detail level of the encounter

Request headers

If-Modified-Since
string date optional

If modified since date filter, defined by RFC 7232 Section 3.3. Date must be HTTP-Date format defined by RFC 7231 Section 7.1.1

Responses

200 OK

Returns encounters

Retrieve a specific encounter
GET /{EmrType}/{InstanceId}/encounters/{EncounterId}

Returns the list of encounters

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
EncounterId
string required

ID of the encounter

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

PatientId
string optional

ID of the patient

DetailLevel
string optional

Detail level of the encounter

Responses

200 OK

Returns encounters

Add a new richtext encounter
POST /{EmrType}/{InstanceId}/patients/{PatientId}/encounters/richtext

Adds a new encounter with richtext. Sent as multipart/form-data with an Encounter part (application/json for EncounterCreateRequest) and an Html part (text/html, HTML formatted richtext)

The HTML that is sent can only contain whitelisted tags:

  • <b>
  • <blockquote>
  • <br>
  • <dd>
  • <dt>
  • <dl>
  • <del>
  • <em>
  • <font>
  • <h1>
  • <h2>
  • <h3>
  • <h4>
  • <h5>
  • <h6>
  • <hr>
  • <i>
  • <kbd>
  • <li>
  • <ol>
  • <p>
  • <pre>
  • <s>
  • <sub>
  • <sup>
  • <strong>
  • <strike>
  • <u>
  • <ul>

PSS only supports certain tags and others will be ignored. Supported:

  • <b>
  • <br>
  • <font>
    • Only uses 'color' attribute and must be in the form of 'red', 'rgb(255,255,255)' or '#FFFFFF'
    • Supported color names are those of the Java Color
  • <i>
  • <s>
  • <u>

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Patient ID to add encounter to

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Request body

multipart/form-data
Object
html
string

HTML formatted richtext. Send as text/html

encounter
string

Send as an application/json with an EncounterCreateRequest

Responses

200 OK

Return the encounter ID of the created encounter

Add a new encounter
POST /{EmrType}/{InstanceId}/patients/{PatientId}/encounters

Adds a new encounter

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Patient ID to add encounter to

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Request body

Responses

200 OK

Return the encounter ID of the created encounter

facilities

Operations for facilities

GET /{EmrType}/{InstanceId}/facilities
GET /{EmrType}/{InstanceId}/facilities/{FacilityId}
Retrieve a list of facilities
GET /{EmrType}/{InstanceId}/facilities

Returns the list of facilities

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

FacilityId
string optional

ID of the facility

SearchString
string optional

String to use for searching

Responses

200 OK

Return facilities

Retrieve a specific facility
GET /{EmrType}/{InstanceId}/facilities/{FacilityId}

Returns the list of facilities

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
FacilityId
string required

ID of the facility

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

Responses

200 OK

Return facilities

patients

Operations for patients

GET /{EmrType}/{InstanceId}/patients
GET /{EmrType}/{InstanceId}/patients/{PatientId}
GET /{EmrType}/{InstanceId}/patients/{PatientId}/{DetailLevel}
PUT /{EmrType}/{InstanceId}/patients/demographics/{PatientId}
PATCH /{EmrType}/{InstanceId}/patients/demographics/{PatientId}
Retrieve a list of patients
GET /{EmrType}/{InstanceId}/patients

Returns the list of patients

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

PatientId
string optional
SearchString
string optional

String to use for searching

DetailLevel
string optional
IncludingHistory
boolean optional

Responses

200 OK

Return patients

Retrieve a specific patient
GET /{EmrType}/{InstanceId}/patients/{PatientId}

Returns the specific patient

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

DetailLevel
string optional
IncludingHistory
boolean optional

Responses

200 OK

Return patient

Retrieve a specific patient with specific detail level
GET /{EmrType}/{InstanceId}/patients/{PatientId}/{DetailLevel}

Returns the specific patient with specific detail level

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required
DetailLevel
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

IncludingHistory
boolean optional

Responses

200 OK

Return patient

Update a patient's demographics
PUT /{EmrType}/{InstanceId}/patients/demographics/{PatientId}

Update an existing patient's demographics

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Patient ID

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Request body

Responses

200 OK

Return the patient ID of the updated patient

Patch a patient's demographics
PATCH /{EmrType}/{InstanceId}/patients/demographics/{PatientId}

Update an existing patient's demographics using a patch

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Patient ID

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Responses

200 OK

Return the patient ID of the patched patient

linked documents

Operations for linked documents

GET /{EmrType}/{InstanceId}/linkeddocuments
POST /{EmrType}/{InstanceId}/linkeddocuments
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}/content
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}/image
GET /{EmrType}/{InstanceId}/linkeddocuments/{PatientId}/{EncounterId}/{LinkedDocumentId}/content
GET /{EmrType}/{InstanceId}/linkeddocuments/{PatientId}/{EncounterId}/{LinkedDocumentId}/image
Retrieve a list of linked documents
GET /{EmrType}/{InstanceId}/linkeddocuments

Returns the list of linked documents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

LinkedDocumentId
string optional
ProviderId
string optional
PatientId
string optional
SearchString
string optional

String to use for searching

Responses

200 OK

Return linked documents

Add a new linked document
POST /{EmrType}/{InstanceId}/linkeddocuments

Add a new linked document

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

Responses

200 OK

Successful upload of linked document

Retrieve a specific linked document
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}

Returns the specific linked document

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
LinkedDocumentId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

ProviderId
string optional
PatientId
string optional
SearchString
string optional

String to use for searching

Responses

200 OK

Return linked document

Retrieve the linked document contents
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}/content

Returns the linked document contents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
LinkedDocumentId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

PatientId
string optional
EncounterId
string optional
Thumbnail
boolean optional

Responses

200 OK

Return linked documents

Retrieve the linked document contents
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}/image

Returns the linked document contents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
LinkedDocumentId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

PatientId
string optional
EncounterId
string optional
Thumbnail
boolean optional

Responses

200 OK

Return linked documents

Retrieve the linked document contents
GET /{EmrType}/{InstanceId}/linkeddocuments/{PatientId}/{EncounterId}/{LinkedDocumentId}/content

Returns the linked document contents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required
EncounterId
string required
LinkedDocumentId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Thumbnail
boolean optional

Responses

200 OK

Return linked documents

Retrieve the linked document contents
GET /{EmrType}/{InstanceId}/linkeddocuments/{PatientId}/{EncounterId}/{LinkedDocumentId}/image

Returns the linked document contents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required
EncounterId
string required
LinkedDocumentId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Thumbnail
boolean optional

Responses

200 OK

Return linked documents

providers

Operations for providers

GET /{EmrType}/{InstanceId}/providers
GET /{EmrType}/{InstanceId}/providers/{ProviderId}
Retrieve a list of providers
GET /{EmrType}/{InstanceId}/providers

Returns the list of providers

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

SearchString
string optional

String to use for searching

Responses

200 OK

Return providers

Retrieve a specific provider by ID
GET /{EmrType}/{InstanceId}/providers/{ProviderId}

Returns the specific provider

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ProviderId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Responses

200 OK

Return provider

schedules

Operations for schedules

GET /{EmrType}/{InstanceId}/schedules
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments
POST /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments
PUT /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments/{AppointmentId}
PATCH /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments/{AppointmentId}
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/schedulable
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary
POST /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary
PUT /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary
DELETE /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary
Retrieve a list of schedules
GET /{EmrType}/{InstanceId}/schedules

Returns the list of schedules

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

Responses

200 OK

Return schedules

Retrieve a list of schedules
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}

Returns the list of schedules

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Responses

200 OK

Return schedules

404 404

Not found

Retrieve a list of schedule appointments
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments

Returns the list of schedules

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

IncludeDeleted
boolean optional

If true it will make sure deleted items are also returned

Request headers

If-Modified-Since
string date optional

If modified since date filter, defined by RFC 7232 Section 3.3. Date must be HTTP-Date format defined by RFC 7231 Section 7.1.1

Responses

200 OK

Return schedule appointments

Create an appointment
POST /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments

Create a new appointment

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Responses

200 OK

Return the appointment ID of the created appointment

Update an appointment
PUT /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments/{AppointmentId}

Update an existing appointment

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

AppointmentId
string required

Appointment ID

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Responses

200 OK

Return the appointment ID of the updated appointment

Patch an appointment
PATCH /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments/{AppointmentId}

Update an existing appointment using a patch

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

AppointmentId
string required

Appointment ID

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Responses

200 OK

Return the appointment ID of the updated appointment

Retrieve a list of schedulables
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/schedulable

Returns the list of schedulables

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Date
string date optional

Responses

200 OK

Return schedulables

Retrieve a list of schedule summaries
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary

Returns the list of schedules summaries

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Date
string date optional

Responses

200 OK

Return schedule summaries

Add a schedule summary
POST /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary

Add a schedule summary

Currently not supported

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

Request body

Responses

200 OK

Successful add

Update a schedule summary
PUT /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary

Update a schedule summary

Currently not supported

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

Request body

Responses

200 OK

Successful update

Remove a schedule summary
DELETE /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary

Remove a scheudle summary

Currently not supported

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Date
string date optional

Responses

200 OK

Return schedule summaries

tutorials

Operations for tutorials

GET /{EmrType}/{InstanceId}/tutorials
GET /{EmrType}/{InstanceId}/tutorials/{Name}
Retrieve a list of tutorials
GET /{EmrType}/{InstanceId}/tutorials

Return the list of tutorials

Used for mobile

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

Name
string optional
DeviceScreenHeightPortrait
number float optional
DeviceScreenWidthPortrait
number float optional
ModelName
string optional

Responses

200 OK

Return tutorials

Retrieve a list of tutorials
GET /{EmrType}/{InstanceId}/tutorials/{Name}

Return the list of tutorials

Used for mobile

Path variables

EmrType
string required
InstanceId
string required
Name
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

DeviceScreenHeightPortrait
number float optional
DeviceScreenWidthPortrait
number float optional
ModelName
string optional

Responses

200 OK

Return tutorials

administration

Administration operations

POST /applog
POST /emrsessions
PUT /emrsessions
DELETE /emrsessions
Add app log
POST /applog

Add app log

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string optional

The EMR Type of the EMR instance to which the user belongs

InstanceId
string optional

The EMR Instance Id of the EMR instance to which the user belongs

UserId
string optional
SourceId
string optional
IsInternal
boolean optional
HardwareIdentifier
string optional
Carrier
string optional

Request body

Array of AppActivity

Responses

200 OK

all good

Login with EMR session
POST /emrsessions

Login with EMR session

Responses

200 OK

Logged in

Renew EMR session
PUT /emrsessions

Renew the EMR session

Request body

Responses

200 OK

Renewed

Logout EMR session
DELETE /emrsessions

Logout of EMR session

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

InstanceToken
string optional

This token is obtained by registering an EMR instance. This token is used to authenticate EMR instances making use of the Administration Services.

EmrType
string optional

The EMR Type of the EMR instance to which the user belongs

InstanceId
string optional

The EMR Instance Id of the EMR instance to which the user belongs

Responses

200 OK

Logged out of EMR session

Retrieve the current version
GET /version

Return the current version

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

Responses

200 OK

Return current version

aggregate

Aggregate operations

GET /{EmrType}/{InstanceId}/aggregate/addressbookentries
GET /{EmrType}/{InstanceId}/aggregate/contactlistentries
GET /{EmrType}/{InstanceId}/aggregate/patientsummary/{PatientId}
GET /{EmrType}/{InstanceId}/aggregate/schedulesummary/{ProviderId}
GET /{EmrType}/{InstanceId}/aggregate/encountersummaries/{PatientId}/{EncounterSummaryId}
Retrieve an aggregate list of address book entries
GET /{EmrType}/{InstanceId}/aggregate/addressbookentries

Return an aggregate list of address book entries

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

Responses

200 OK

Return an aggregate list of address book entries

400 400

Argument exception

Retrieve an aggregate list of contact list entries
GET /{EmrType}/{InstanceId}/aggregate/contactlistentries

Return an aggregate list of contact list entries

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

0-based index of the first record to return from the set of all potential matches. Default is 0, which is the first page

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

IncludeTypes
string optional
Enumeration:
Facility
Consultant
Person
SecurityGroup
SameClinic
boolean optional
SameLocation
boolean optional

Responses

200 OK

Return an aggregate list of contact list entries

400 400

Argument exception

Retrieve an aggregate list of patient summaries
GET /{EmrType}/{InstanceId}/aggregate/patientsummary/{PatientId}

Return an aggregate list of patient summaries

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

CurrentAppointmentId
string optional
CurrentDate
string date optional
Feature
string optional

Responses

200 OK

Return an aggregate list of patient summaries

400 400

Argument exception

Retrieve an aggregate list of patient summaries
GET /{EmrType}/{InstanceId}/aggregate/schedulesummary/{ProviderId}

Return an aggregate list of patient summaries

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ProviderId
string required

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

Date
string date optional

Responses

200 OK

Return an aggregate list of patient summaries

400 400

Argument exception

Retrieve an Encounter Summary Aggregate (Content 1 Package)
GET /{EmrType}/{InstanceId}/aggregate/encountersummaries/{PatientId}/{EncounterSummaryId}

Path variables

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

PatientId
string required

Patient Id

EncounterSummaryId
string required

Encounter Summary Id. May be a composition Id (e.g. patient_id^enc_date)

Request parameters

AppToken
string required

Demonstrates that the requesting application is a permitted client of the Mobile Web Services. It is effectively an API key for future access.

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

The EMR Type of the EMR instance to which the user belongs

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

The EMR Instance Id of the EMR instance to which the user belongs

UserToken
string required

Uniquely identifies a device registered to a specific user. This is intended to be stored on a device once the device is paired, and removed from a device if a user has chosen to unpair the device or remove the Telus Mobile application from their device. This token fulfills the role of the “something you have” aspect of two-factor authentication.

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client holding the token will be permitted to access EMR Services. This session token must be renewed before expiry.

PatientId
string required

Patient Id

EncounterSummaryId
string required

Encounter Summary Id

Request headers

Authorization
string required

Admin Services Token (AST) as "Bearer <token>"

Pattern:Bearer <token>
Example:
Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6Ik1hcmlrYSIsInR5cCI6IkpXVCJ9.eyJFbXJUeXBlIjoiTWVkZXN5bmMiLCJFbXJJbn...

Responses

200 OK

Encounter Summary Aggregate Response

encounter summaries
Type Definitions
AppointmentPagedResult
All of
Object
Entities
Array of Appointment
Appointment
All of
Object
Provider
Patient
Reason
string
Problem
string
SignedOut
boolean
StartDate
string date
EndDate
string date
Notes
string
Status
string
ScheduleLocation
BookingHistory
Cancelled
boolean
AppointmentType
Deleted
boolean
BookingHistory
Object
BookedDate
string date
BookedBy
string
ChangedDate
string date
ChangedBy
string
Types: Appointment
AppointmentTypePagedServiceResponse
AppointmentTypePagedResult
All of
Object
Entities
Array of AppointmentType
AppointmentType
All of
Object
BackgroundColour
string

Background colour represented with hex

ForegroundColour
string

Foreground colour represented with hex

DefaultText
string
DefaultDurationInMinutes
integer

Default duration in minutes

CapabilityPagedServiceResponse
CapabilityPagedResult
All of
Object
Entities
Array of Capability
Capability
All of
Object
IsSupportingKeywordsForPhoto
boolean
IsSupportingEncounters
boolean
IsSupportingTutorial
boolean
IsSupportingScheduleSelection
boolean
TutorialCapabilites
CapabilityType
string
Enumeration:
KeywordsForPhoto
GetLabList
GetDocumentList
GetEncountedList
IsSupportingTutorial
GetCalendarList
SupportedDate
string date
TutorialCapability
All of
Object
CalendarSelectorEnabled
boolean
EncounterEnabled
boolean
EncounterDetailEnabled
boolean
LinkedDocumentImageEnabled
boolean
Types: Capability
ConsultantsPagedResult
All of
Object
Entities
Array of Consultant
Consultant
All of
Object
Credentials
string
Specialty
RegistrationNumber
string

Registration number

Identifiers
Array of Identifier

List of identifiers [Added with C1] - replaces the RegistrationNumberAssingingAuthority field

Note: the RegistrationNumber shall also be included in this list

Department
string
Notes
string
BuildingName
string
BuildingType
SortDescriptor
string
ConsultantUpdateResponse
All of
Object
ConsultantId
string

The ID of the consultant

ConsultantUpdateRequest
All of
EncountersPagedServiceResponse
EncountersPagedResult
All of
Object
Entities
Array of EncounterNote
EncounterNote
All of
Object
ResponsibleProvider
ShortSummary
string
LongSummary
string
NoteItems
ReviewedBy
AttachmentReferences
Array of ReferenceObject
EncounterNoteItem
Object
Order
integer
Name
string
Value
string
Visible
string
Attachments
AttachmentReferences
Array of ReferenceObject
LinkedDocumentContents
All of
Object
FileContents
Name
string
FileType
string
Appointment
Provider
Keywords
Array of string
DocumentType
DocDate
string date
Note
string
NotesForPatient
string
EncounterCreateRequest
All of
Object
EventDate
string date
ResponsibleProvider
string
LongSummary
string
EncounterCreateResponse
All of
Object
EncounterId
string
FacilityPagedServiceResponse
FacilityPagedResult
All of
Object
Entities
Array of Facility
Facility
All of
Object
Name
string
BuildingType
ContactInfo
PatientsPagedResult
All of
Object
Entities
Array of Patient
Patient
All of
Object
MaidenName
string
RestrictedAccess
boolean
Demographics
MedicalSummary
JournalItems
Array of JournalItem
CareTeam
OtherInfo
Active
boolean

Whether this patient's record is in active use [Added with C1]

PreferredContact
Object
PreferredMethodOfContact
boolean
ContactAddress
All of
Object
AddressLine1
string
AddressLine2
string
AddressLine3
string
City
string
Province
string
PostalCode
string
Country
string
Primary
boolean
Name
string
ContactFax
All of
Object
FaxNumber
string
FormattedFaxNumber
string
Primary
boolean
ContactPhone
All of
Object
PhoneNumber
string
FormattedPhoneNumber
string
Extension
string
Primary
boolean
ContactEmail
All of
Object
EmailAddress
string
Primary
boolean
ContactInformation
Object
Emails
Array of ContactEmail
PhoneNumbers
Array of ContactPhone
FaxNumbers
Array of ContactFax
Addresses
Array of ContactAddress
OtherInfo
Object
BillingProvince
string
Enumeration:
AB
BC
MB
NB
NL
NT
NS
NU
ON
PE
QC
SK
YT
Notes
string
ChartId
string
Rostered
boolean

Indicates if this patient's record is "rostered" to the CareTeam.PrimaryProvider or not (Ontario Requirement) [Added with C1]

RosteredDate

Indicates when this patient's record was "rostered" to the CareTeam.PrimaryProvider [Added with C1]

CareTeam
Object
CareTeamProvider
PrimaryProvider
AlternateProvider
Pharmacy
FamilyMD
Location
Types: Patient
JournalItem
All of
Object
NewEventDate
EventDate
string date
CreatedDate
string date
CreatedBy
LastModifiedDate
string date
LastModifiedBy
Personal
All of
Object
Trait
string
Details
string
HarmfulSubstances

A HarmfullSubstances is a risk factor such as "SMOKING" or "ALCOHOL". A Patient Payload with a MedicalSummary or an All detail level contains a list of HarmfulSubstances.

All of
Object
Type
string

Type of the harmful substance

Displayed as "risk title" in the mobile app

TypeCode
Array of Coding

Coding system(s) of the type [Added with C1]

TELUS EMR Code Table: harmful-substances-code

For reference, FHIR uses the LOINC coding system for observation codes (http://www.hl7.org/FHIR/valueset-observation-codes.html)

Details
string

Details of the harmful substance

Displayed as "risk subtitle" in the mobile app

EffectiveStartDateTime

The date or estimated date that the condition started [Added with C1]

EffectiveEndDateTime

The date or estimated date that the condition ended [Added with C1]

Notes
string

Additional text not captured in other fields [Added with C1]

LastUpdatedDate
string date-time

Last Updated date & time - Can be null

Vaccination
All of
Object
Name
string

Brand name of the administered product

Code
Array of Coding

Vaccine that was administered or was to be administered [Added with C1]

TELUS EMR Code Table: vaccine-code

For reference, FHIR uses CVX codes (http://www.hl7.org/FHIR/valueset-vaccine-code.html)

Date
string date

Date of the administration or of the administration refusal [Superseded by DateFD]

DateFD

Date of the administration or of the administration refusal [Added with C1]

DateDescription
string
Reaction
string

Details of a reaction that follows immunization

Vaccine Type [Added with C1]

TELUS EMR Code Table: vaccine-type

Usually, a vaccine type is: “live” or “inactivated”, but this is not aligned with the values documented for the C1 package (HA, FLU, DT…)

Dose
number

Quantity of administered dose (decimal value) [Added with C1]

Anatomical site of administration [Added with C1]

TELUS EMR Code Table: vaccine-site

For reference, FHIR uses HL7 v3 codes (https://www.hl7.org/fhir/v3/ActSite/cs.html)

Route of administration [Added with C1]

TELUS EMR Code Table: vaccine-route

For reference, FHIR uses HL7 v2 codes (https://www.hl7.org/fhir/v2/0162/index.html)

Manufacturer
string

Name of the vaccine manufacturer [Added with C1]

LotNumber
string

Product lot number [Added with C1]

ExpiryDate

Product expiry date [Added with C1]

NotGiven
boolean

Flag for whether immunization was given [Added with C1]

Notes
string

Vaccination notes [Added with C1]

LastUpdatedDate
string date-time

Last Updated date & time - Can be null

FamilyHistory
All of
Object
Problem
string
RelationName
string
DateNoted
string date
Procedure
All of
Object
Category

Classification / Type of the procedure [Added with C1]

TELUS EMR Code Table: procedure-category

For reference, FHIR uses the SNOMED CT coding system (https://www.hl7.org/fhir/valueset-procedure-category.html)

Name
string

Name of the procedure

Code
Array of Coding

Identification of the procedure [Added with C1]

TELUS EMR Code Table: procedure-code

For reference, FHIR uses the SNOMED CT coding system(https://www.hl7.org/fhir/valueset-procedure-code.html)

Date
string date

Date of the procedure [Superseded by DateFD]

DateFD

Date of the procedure [Added with C1]

DateDescription
string
Practitioner
string

Name of the practitioner

Notes
string

Additional information about the procedure / Comments [Added with C1]

LastUpdatedDate
string date-time

Last Updated date & time - Can be null

Problem
All of
Object
Name
string

Name of the problem

Code
Array of Coding

Identification of the problem [Added with C1]

TELUS EMR Code Table: problem-code

For reference, FHIR uses the SNOMED CT coding system (http://www.hl7.org/FHIR/valueset-condition-code.html)

Category

Category / Type of the problem [Added with C1]

TELUS EMR Code Table: problem-category

For reference, FHIR defines the following codes. The concept we want to define here is more aligned with a FHIR Observation category code (social-history, vital-signs, imaging, laboratory, procedure, survey, exam, therapy; http://www.hl7.org/FHIR/valueset-observation-category.html) than with a FHIR Condition category code (problem-list-item, encounter-diagnosis).

ClinicalStatus

[Added with C1]

TELUS EMR Code Table: problem-clinical-status

For reference, FHIR defines the following codes: active | recurrence | inactive | remission | resolved (http://www.hl7.org/FHIR/valueset-condition-clinical.html)

ConfirmationStatus

[Added with C1]

TELUS EMR Code Table: problem-confirmation-status

For reference, FHIR defines the following codes for a verification status: provisional | differential | confirmed | refuted | entered-in-error | unknown (http://www.hl7.org/FHIR/valueset-condition-ver-status.html)

PersistenceStatus

[Added with C1]

E.g. chronic | controlled | episodic | remission

TELUS EMR Code Table: problem-persistence-status

Severity

[Added with C1]

E.g. mild | moderate | severe | unknown

TELUS EMR Code Table: problem-severity

For reference, FHIR uses the SNOMED CT coding system (http://www.hl7.org/FHIR/valueset-condition-severity.html)

Date
string date

Date of the problem [Superseded by DateFD]

DateFD

Date of the problem [Added with C1]

DateDescription
string
Notes
string

Additional information about the problem or diagnosis

DateOfOnset
string

Estimated or actual date or date-time the condition began, in the opinion of the clinician (no format specified) [Superseded by DateOfOnsetFD]

DateOfOnsetFD

Same as DateOfOnset, as a FuzzyDate [Added with C1]

DateOfAbatement

The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" – Conditions are never really resolved, but they can abate. [Added with C1]

Outcome
string

Description of outcome when the problem ended [Added with C1]

LastUpdatedDate
string date-time

Last Updated date & time - Can be null

Allergy
All of
Object
Category

Category of the allergy [Added with C1]

TELUS EMR Code Table: allergy-category

For reference, FHIR defines the following codes: food | medication | environment | biologic

Substance
string

Specific substance or pharmaceutical product considered to be responsible for event (description)

SubstanceCode
Array of Coding

Specific substance or pharmaceutical product considered to be responsible for event [Added with C1]

TELUS EMR Code Table: allergy-substance

For reference, FHIR uses the SNOMED CT coding system (http://www.hl7.org/FHIR/valueset-substance-code.html)

Reaction
string

Reaction description

ReactionType

Clinical symptoms/signs associated with the reaction [Added with C1]

TELUS EMR Code Table: allergy-reaction-type

For reference, FHIR uses the SNOMED CT coding system (http://www.hl7.org/FHIR/valueset-clinical-findings.html)

Certainty
string

Severity of the reaction [Not included in previous documentation - Coded values added with C1]

Enumeration:
mild
moderate
severe
Date
string date

When allergy was identified [not included in previous documentation - Superseded by DateFD]

DateFD

When allergy was identified [Added with C1]

ClinicalStatus

[Added with C1]

TELUS EMR Code Table: allergy-clinical-status

For reference, FHIR defines the following codes: active | inactive | resolved (http://www.hl7.org/FHIR/valueset-allergy-clinical-status.html)

VerificationStatus

[Added with C1]

TELUS EMR Code Table: allergy-verification-status

For reference, FHIR defines the following codes: unconfirmed | confirmed | refuted | entered-in-error (http://www.hl7.org/FHIR/valueset-allergy-verification-status.html)

Notes
string

Additional text not captured in other fields [Added with C1]

LastUpdatedDate
string date-time

Last Updated date & time - Can be null

Medication

Record of a medication being taken by a patient or that a medication has been given to a patient, where the record is the result of a report from the patient or another clinician

All of
Object
Name
string

Drug name

GenericName
string

Drug generic name [Added with C1]

Code
Array of Coding

[Added with C1]

TELUS EMR Code Table: medication-code

[Added with C1]

TELUS EMR Code Table: medication-form

For reference, FHIR uses the SNOMED CT coding system (https://www.hl7.org/fhir/valueset-medication-form-codes.html)

StrengthValue
number

Potency value of the drug (decimal value) [Added with C1]

StrengthValueString
string

Potency of the drug (string) - use only if StrengthValue cannot be populated with a decimal value [Added with C1]

StrengthUnit

Potency unit of the drug [Added with C1]

For reference, FHIR recommends using the UCUM coding system (https://www.hl7.org/fhir/valueset-ucum-units.html)

Details
string

Compound description or additional details [Added with C1]

Indication
string

[Added with C1]

PrescribedBy

Provider that prescribed the drug [Added with C1]

Reference to a Consultant At least the following data shall be populated:

  • Id
  • LastName
  • FirstName
  • RegistrationNumber
  • RegistrationNumberAssigningAuthority
PrescribedDate
string date

Date the medication was prescribed [Superseded by PrescribedDateFD]

PrescribedDateFD

Date the medication was prescribed, as a FuzzyData [Added with C1]

EffectiveDate

Date the medication was taken (start date) [Added with C1]

CompletedDate

Date the medication was completed (end date) [Added with C1]

[Added with C1]

TELUS EMR Code Table: medication-status

For reference, FHIR defines the following codes: active | completed | entered-in-error | intended | stopped | on-hold (http://www.hl7.org/FHIR/valueset-medication-statement-status.html)

StopReason

[Added with C1]

TELUS EMR Code Table: medication-stop-reason

TreatmentType

[Added with C1]

TELUS EMR Code Table: medication-treatment-type

Dosage
string

Description of the dosage (summary)

DosageInstruction

How the medication should be taken [Added with C1]

PatientInstruction
string

Patient or consumer oriented instructions [Added with C1]

(note: in the HL7 FHIR standard, this is defined per medication dosage)

Quantity
number

Quantity of drug prescribed (decimal value) [Added with C1]

(note: in the HL7 FHIR standard, this is defined per medication dosage)

QuantityString
string

Quantity of drug prescribed (string) - use only if Quantity cannot be populated with a decimal value [Added with C1]

QuantityUnit

[Added with C1]

For reference, FHIR recommends using the UCUM coding system (https://www.hl7.org/fhir/valueset-ucum-units.html)

[Added with C1]

TELUS EMR Code Table: medication-route

For reference, FHIR uses the SNOMED CT coding system (http://www.hl7.org/FHIR/valueset-route-codes.html)

(note: in the HL7 FHIR standard, this is defined per medication dosage)

RateRatioAmount
number

Amount of medication per unit of time [Added with C1]

(note: in the HL7 FHIR standard, this is defined per medication dosage)

RateRatioTime
number

[Added with C1]

RateRatioTimeUnit

[Added with C1]

For reference, FHIR recommends using UCUM unit of time codes: s | min | h | d | wk | mo | a

NumberOfRepeatsAllowed
integer

Number of refills authorized [Added with C1]

Min:0
SubstitutionsAllowed
boolean

Whether substitution is allowed or not [Added with C1]

LastDispenseInClinic

Last time the drug was dispensed in clinic. If this value is populated, it means the drug is dispensed in clinic. [Added with C1]

LastUpdatedDate
string date-time

Last Updated date & time - Can be null

MedicalSummary
Object
CurrentMedications
Array of Medication
CurrentAllergies
Array of Allergy
CurrentProblems
Array of Problem
Procedures
Array of Procedure
FamilyHistory
Array of FamilyHistory
Vaccinations
Array of Vaccination
HarmfulSubstances
Personal
Array of Personal
PreviousMedications
Array of Medication
InactiveAllergies
Array of Allergy
InactiveProblems
Array of Problem
Types: Patient
Demographics
Object
BirthDate
string date
Gender
string
Enumeration:
M

Male

F

Female

O

Other

U

Unknown

PHN
string
PHNVersionCode
string

Health Number Version Code [Added with C1]

DeceasedDate

Indicates if and when the patient is deceased [Added with C1]

Person
All of
Object
Title
string
FirstName
string
GoesByName
string
MiddleName
string
LastName
string
Language
string
Initials
string
ContactInfo
PatientCreateRequest
All of
Object
Title
string
FirstName
string
GoesByName
string
MiddleName
string
LastName
string
PatientLanguage
string
Initials
string
ContactInfo
MaidenName
string
OtherInfo
Demographics
RestrictedAccess
boolean
PatientCreateResponse
All of
Object
PatientId
string
LinkedDocumentsPagedResult
All of
Object
Entities
Array of LinkedDocument
LinkedDocument
All of
Object
Name
string
FileType
string
Appointment
Provider
Keywords
Array of string
DocumentType
DocDate
string date
Note
string
NotesForPatient
string
LinkedDocumentUploadRequest
All of
Object
PatientId
string
AppointmentId
string
ProviderId
string
FileName
string
DocumentType
string
Keyword1
string
Keyword2
string
Keyword3
string
Notes
string
LinkedDocumentUploadResponse
All of
Object
LinkedDocumentId
string
DocumentSize
string
ProvidersPagedResult
All of
Object
Entities
Array of Provider
Provider
All of
Object
DailySchedules
Array of DailySchedule
ScheduleId
string
DailySchedule
Object
StartTime
string date
EndTime
string date
Scheduleable
boolean
SchedulesPagedServiceResponse
SchedulesPagedResult
All of
Object
Entities
Array of Schedule
Schedule
All of
Object
Name
string
PayloadServiceResponse(DailySchedule)
All of
Object
Payload
Array of DailySchedule
ScheduleSummaryRequest
All of
Object
ScheduleId
string
Date
string date
ProviderScheduleStatistics
Object
ScheduledPatientCount
string
OtherBookingCount
string
UnscheduledDuration
string
ScheduledAppointmentCreateRequest
All of
Object
ScheduleId
string
StartDate
string date
EndDate
string date
PatientId
string
SignedOut
boolean
Reason
string
Problem
string
Notes
string
Cancelled
boolean
ScheduleLocation
Status
string
AppointmentType
ScheduledAppointmentCreateResponse
All of
Object
AppointmentId
string
User
All of
Object
ProviderId
string
TutorialsPagedServiceResponse
TutorialsPagedResult
All of
Object
Entities
Array of Tutorial
Tutorial
All of
Object
DisplayScreenShots
boolean
TutorialScreens
Array of Screens
Screens
Object
Title
string
Text
string
SpecificationPortrait
SpecificationLandscape
Types: Tutorial
Specification
Object
IsPositionTextAtTop
boolean
SpotlightPositionArea
string
SpotlightCenterPositionX
integer
SpotlightCenterPositionY