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.

Retrieve a list of appointments Retrieve a list of appointment types Retrieve the current EMR capabilities Retrieve a list of consultants 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 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 Remove a schedule summary Retrieve a list of tutorials Retrieve a list of tutorials Add app log Logout EMR session Retrieve the current version 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 aggregate for Content 1 Package (with Encounter Summary Id) Retrieve a specific encounter summary
Language
string optional

Preferred language

Retrieve a list of appointments Retrieve a list of appointment types Retrieve the current EMR capabilities Retrieve a list of consultants 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 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 Remove a schedule summary Retrieve a list of tutorials Retrieve a list of tutorials Add app log Logout EMR session Retrieve the current version 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 aggregate for Content 1 Package (with Encounter Summary Id) Retrieve a specific encounter summary
Version
string optional

Version of API to use

Retrieve a list of appointments Retrieve a list of appointment types Retrieve the current EMR capabilities Retrieve a list of consultants 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 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 Remove a schedule summary Retrieve a list of tutorials Retrieve a list of tutorials Add app log Logout EMR session Retrieve the current version 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 aggregate for Content 1 Package (with Encounter Summary Id) Retrieve a specific encounter summary
TutorialData
boolean optional

Used to request tutorial data

Retrieve a list of appointments Retrieve a list of appointment types Retrieve the current EMR capabilities Retrieve a list of consultants 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 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 Remove a schedule summary Retrieve a list of tutorials Retrieve a list of tutorials Add app log Logout EMR session Retrieve the current version 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 aggregate for Content 1 Package (with Encounter Summary Id) Retrieve a specific encounter summary
ActivityId
string optional

Used for logging

Retrieve a list of appointments Retrieve a list of appointment types Retrieve the current EMR capabilities Retrieve a list of consultants 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 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 Remove a schedule summary Retrieve a list of tutorials Retrieve a list of tutorials Add app log Logout EMR session Retrieve the current version 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 aggregate for Content 1 Package (with Encounter Summary Id) Retrieve a specific encounter summary
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 aggregate for Content 1 Package (with Encounter Summary Id) Retrieve a specific encounter summary
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 aggregate for Content 1 Package (with Encounter Summary Id) Retrieve a specific encounter summary
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

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/c1/{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 aggregate for Content 1 Package (with Encounter Summary Id)
GET /{EmrType}/{InstanceId}/aggregate/c1/{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. CID^patient_id^start_dtm^end_dtm)

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

Return C1Package

encounter summaries
GET /{EmrType}/{InstanceId}/patients/{PatientId}/encountersummaries/{EncounterSummaryId}
Retrieve a specific encounter summary
GET /{EmrType}/{InstanceId}/patients/{PatientId}/encountersummaries/{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. CID^patient_id^start_dtm^end_dtm)

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. May be a composition Id (e.g. CID^patient_id^start_dtm^end_dtm)

Request headers

Authorization
string required

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

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

Responses

Type Definitions
AppointmentPagedServiceResponse object

Properties

AppointmentPagedResult object
extends PagedResult

Properties

Entities
Array of Appointment
Appointment object
extends DomainObject

Properties

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

Properties

BookedDate
string date
BookedBy
string
ChangedDate
string date
ChangedBy
string
Types: Appointment
AppointmentTypePagedServiceResponse object

Properties

AppointmentTypePagedResult object
extends PagedResult

Properties

Entities
Array of AppointmentType
AppointmentType object
extends DomainObject

Properties

BackgroundColour
string

Background colour represented with hex

ForegroundColour
string

Foreground colour represented with hex

DefaultText
string
DefaultDurationInMinutes
integer

Default duration in minutes

CapabilityPagedServiceResponse object

Properties

CapabilityPagedResult object
extends PagedResult

Properties

Entities
Array of Capability
Capability object
extends DomainObject

Properties

IsSupportingKeywordsForPhoto
boolean
IsSupportingEncounters
boolean
IsSupportingTutorial
boolean
IsSupportingScheduleSelection
boolean
TutorialCapabilites
CapabilityType
string
Enumeration:
KeywordsForPhoto
GetLabList
GetDocumentList
GetEncountedList
IsSupportingTutorial
GetCalendarList
SupportedDate
string date
TutorialCapability object
extends DomainObject

Properties

CalendarSelectorEnabled
boolean
EncounterEnabled
boolean
EncounterDetailEnabled
boolean
LinkedDocumentImageEnabled
boolean
Types: Capability
ConsultantsPagedResult object
extends PagedResult

Properties

Entities
Array of Consultant
Consultant object
extends Person

Properties

Credentials
string
Specialty
RegistrationNumber
string

Registration number

RegistrationNumberAssigningAuthority

Assigning authority of the registration number [Added with C1]

Department
string
Notes
string
BuildingName
string
BuildingType
SortDescriptor
string
ConsultantUpdateResponse object

Properties

ConsultantId
string

The ID of the consultant

ConsultantUpdateRequest object

Properties

Consultant
EncountersPagedServiceResponse object

Properties

EncountersPagedResult object
extends PagedResult

Properties

Entities
Array of EncounterNote
EncounterNote object
extends JournalItem

Properties

ResponsibleProvider
ShortSummary
string
LongSummary
string
NoteItems
ReviewedBy
AttachmentReferences
Array of ReferenceObject
EncounterNoteItem object

Properties

Order
integer
Name
string
Value
string
Visible
string
Attachments
AttachmentReferences
Array of ReferenceObject
LinkedDocumentContents object
extends DomainObject

Properties

FileContents
Name
string
FileType
string
Appointment
Provider
Keywords
Array of string
DocumentType
DocDate
string date
Note
string
NotesForPatient
string
EncounterCreateRequest object

Properties

EventDate
string date
ResponsibleProvider
string
LongSummary
string
EncounterCreateResponse object

Properties

EncounterId
string
FacilityPagedServiceResponse object

Properties

FacilityPagedResult object
extends PagedResult

Properties

Entities
Array of Facility
Facility object
extends DomainObject

Properties

Name
string
BuildingType
ContactInfo
PatientsPagedResult object
extends PagedResult

Properties

Entities
Array of Patient
Patient object
extends Person

Properties

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

Properties

PreferredMethodOfContact
boolean
ContactAddress object

Properties

AddressLine1
string
AddressLine2
string
AddressLine3
string
City
string
Province
string
PostalCode
string
Country
string
Primary
boolean
Name
string
ContactFax object

Properties

FaxNumber
string
FormattedFaxNumber
string
Primary
boolean
ContactPhone object

Properties

PhoneNumber
string
FormattedPhoneNumber
string
Extension
string
Primary
boolean
ContactEmail object

Properties

EmailAddress
string
Primary
boolean
ContactInformation object

Properties

Emails
Array of ContactEmail
PhoneNumbers
Array of ContactPhone
FaxNumbers
Array of ContactFax
Addresses
Array of ContactAddress
OtherInfo object

Properties

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

Properties

CareTeamProvider
PrimaryProvider
AlternateProvider
Pharmacy
FamilyMD
Location
Types: Patient
JournalItem object
extends DomainObject

Properties

NewEventDate
EventDate
string date
CreatedDate
string date
CreatedBy
LastModifiedDate
string date
LastModifiedBy
Personal object
extends DomainObject

Properties

Trait
string
Details
string
HarmfulSubstances object
extends DomainObject

Properties

Type
string
Details
string
Vaccination object
extends DomainObject

Properties

Name
string

Brand name of the administered product

Date
string date

Date of the administration or of the administration refusal

DateDescription
string
Reaction
string

Details of a reaction that follows immunization

Code

Vaccine that was administered or was to be administered - Expected coding system: Canada Health DIN Quantity of administered dose [Added with C1]

Type
string

Vaccine Type [Added with C1]

Enumeration:
live
inactivated
Dose
number

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

Anatomical site of administration - Expected coding system: HL7 v3 ActSite [Added with C1]

Route of administration - Expected coding system: HL7 v2 Table 0162 [Added with C1]

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]

FamilyHistory object
extends DomainObject

Properties

Problem
string
RelationName
string
DateNoted
string date
Procedure object
extends DomainObject

Properties

Name
string

Name of the procedure

Date
string date

Date of the procedure

DateDescription
string
Practitioner
string

Name of the practitioner

Category

Classification / Type of the procedure - Expected coding system: SNOMED CT [Added with C1]

Code

Identification of the procedure - Expected coding system: SNOMED CT [Added with C1]

Notes
string

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

Problem object
extends DomainObject

Properties

Name
string

Name of the problem

Date
string date

Date of the problem

DateDescription
string
Notes
string

Additional information about the problem or diagnosis

DateOfOnset
string date

Estimated or actual date or date-time the condition began, in the opinion of the clinician

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)

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]

DateOfOnsetFD

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

Allergy object
extends DomainObject

Properties

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]

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]

Medication object
extends DomainObject

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

Properties

Name
string

Drug name

Dosage
string

Description of the dosage (summary)

PrescribedDate

Date the medication was prescribed [Modified from DateTime? To FuzzyDate with C1]

GenericName
string

Drug generic name

Code

Expected coding system: Canada Health DIN

Expected coding system: SNOMED CT

StrenghtValue
number

Potency value of the drug

StrenghtUnit
string

Potency unit of the drug - Coding system: UCUM

Details
string

Compound description or additional details

Indication
string
PrescribedBy

Provider that prescribed the drug - Points to a Consultant

EffectiveDate

Date the medication was taken (start date)

CompletedDate

Date the medication was completed (end date)

Status
string
Enumeration:
active
completed
entered-in-error
intended
stopped
on-hold
StopReason
TreatmentType
DosageInstruction

How the medication should be taken

PatientInstruction
string

Patient or consumer oriented instructions (note: in the HL7 FHIR standard, this is defined per medication dosage)

Quantity
number

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

QuantityUnit
string

Coding system: UCUM

Expected coding system: SNOMED CT (note: in the HL7 FHIR standard, this is defined per medication dosage)

RateRatioAmount
number

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

RateRatioTime
number
RateRatioTimeUnit
string
Enumeration:
s

second

min

minute

h

hour

d

day

wk

week

mo

month

a

year

NumberOfRepeatsAllowed
integer

Number of refills authorized

Min:0
SubstitutionsAllowed
boolean

Whether substitution is allowed or not

LastDispenseInClinic

Last time the drug was dispensed in clinic. If this value is populated, it means the drug is dispensed in clinic.

MedicalSummary object

Properties

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

Properties

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 object
extends DomainObject

Properties

Title
string
FirstName
string
GoesByName
string
MiddleName
string
LastName
string
Language
string
Initials
string
ContactInfo
PatientCreateRequest object

Properties

Title
string
FirstName
string
GoesByName
string
MiddleName
string
LastName
string
PatientLanguage
string
Initials
string
ContactInfo
MaidenName
string
OtherInfo
Demographics
RestrictedAccess
boolean
PatientCreateResponse object

Properties

PatientId
string
LinkedDocumentsPagedServiceResponse object

Properties

LinkedDocumentsPagedResult object
extends PagedResult

Properties

Entities
Array of LinkedDocument
LinkedDocument object
extends DomainObject

Properties

Name
string
FileType
string
Appointment
Provider
Keywords
Array of string
DocumentType
DocDate
string date
Note
string
NotesForPatient
string
LinkedDocumentUploadRequest object

Properties

PatientId
string
AppointmentId
string
ProviderId
string
FileName
string
DocumentType
string
Keyword1
string
Keyword2
string
Keyword3
string
Notes
string
LinkedDocumentUploadResponse object

Properties

LinkedDocumentId
string
DocumentSize
string
ProvidersPagedServiceResponse object

Properties

ProvidersPagedResult object
extends PagedResult

Properties

Entities
Array of Provider
Provider object
extends Consultant

Properties

DailySchedules
Array of DailySchedule
ScheduleId
string
DailySchedule object

Properties

StartTime
string date
EndTime
string date
Scheduleable
boolean
SchedulesPagedServiceResponse object

Properties

SchedulesPagedResult object
extends PagedResult

Properties

Entities
Array of Schedule
Schedule object
extends DomainObject

Properties

Name
string
PayloadServiceResponse(DailySchedule) object

Properties

Payload
Array of DailySchedule
ScheduleSummaryRequest object

Properties

ScheduleId
string
Date
string date
ProviderScheduleStatistics object

Properties

ScheduledPatientCount
string
OtherBookingCount
string
UnscheduledDuration
string
ScheduledAppointmentCreateRequest object

Properties

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 object

Properties

AppointmentId
string
User object
extends DomainObject

Properties

ProviderId
string
TutorialsPagedServiceResponse object

Properties

TutorialsPagedResult object
extends PagedResult

Properties

Entities
Array of Tutorial
Tutorial object
extends DomainObject

Properties

DisplayScreenShots
boolean
TutorialScreens
Array of Screens
Screens object

Properties

Title
string
Text
string
SpecificationPortrait
SpecificationLandscape
Types: Tutorial
Specification object

Properties

IsPositionTextAtTop
boolean
SpotlightPositionArea
string
SpotlightCenterPositionX
integer
SpotlightCenterPositionY
integer
TutorialAreaHeight
number float
SpotlightDiameter
integer
Types: Screens
AddressBookEntriesPagedResult object
extends PagedResult

Properties

Entities
AddressBookEntry object
extends DomainObject

Properties

Name
string
Title
string
LastName
string
FirstName
string
SortDescriptor
string
Specialty
BuildingType
RegistrationNumber
string
Department
string
ContactInfo
Notes
string
PatientSummaryResponse object

Properties

PatientSummary
PatientSummary object
extends DomainObject

Properties

Patient
PreviousAppointments
CurrentAppointment
ScheduleSummaryResponse object

Properties

ScheduleSummary
InstanceRequestBase object

Properties

EmrType
string
InstanceId
string
ServiceRequestBase object

Properties

AppToken
string
Language
string
Version
string
TutorialData
boolean
ActivityId
string
ResponseStatus object

Properties

ErrorCode
string
Message
string
StackTrace
string
Errors
Array of ResponseError
ResponseError object

Properties

ErrorCode
string
FieldName
string
Message
string
Dictionary object
Metadata object

Properties

Type
string
Path
string
Types: DomainObject
IDictionary object
Object object
DomainObject object

Properties

Id
string

Logical id of this artifact, unique within the scope of the resource that contains it

Descriptor
string

Text summary of the resource, for human interpretation

Metadata

Metadata about the resource

Assigner
string

Explicit source of the Id [Added with C1]

Pattern:urn:telus:emr:{emr_type}:{instance_id}
FuzzyDate object

Properties

Date
string date
Precision
string
Enumeration:
Year
Month
Day
Time
JsonPatch object

Properties

patch
JsonPatchElement object

Properties

op
string
Enumeration:
add
remove
replace
copy
move
test
path
string
value
string
from
string
Types: JsonPatch
AppActivity object

Properties

Id
string
ParentId
string
HierarchyId
string
Source
string
SourceCategory
string
StartedAt
string date
HasAnyError
boolean
IsSystemError
boolean
ErrorCode
string
detail
string
TotalTime
number double
NetworkLatency
number double
ServerProcessingTime
number double
AppVersion
string
Methods: Add app log
CreateEmrSessionRequest object

Properties

UserToken
string
AuthenticatedSessionToken
string
ClientType
string
ClientIpAddress
string
CreateEmrSessionResponse object

Properties

EmrSession
User