c1package
by jngoumain

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.

Operations: Add a new encounter Add a new richtext encounter Add app log Create an appointment Logout EMR session Patch a patient's demographics Patch an appointment Remove a schedule summary Remove a specific consultant Retreive an encounter summary aggregate linked document Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of consultants Retrieve a list of encounters Retrieve a list of facilities Retrieve a list of linked documents Retrieve a list of patients Retrieve a list of providers Retrieve a list of schedulables Retrieve a list of schedule appointments Retrieve a list of schedule summaries Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of tutorials Retrieve a list of tutorials Retrieve a specific consultant Retrieve a specific encounter Retrieve a specific facility Retrieve a specific linked document Retrieve a specific patient Retrieve a specific patient with specific detail level Retrieve a specific provider by ID Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an encounter summary aggregate (Content 1 Package) Retrieve the current EMR capabilities Retrieve the current version Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Update a patient's demographics Update an appointment
Language
string optional

Preferred language

Operations: Add a new encounter Add a new richtext encounter Add app log Create an appointment Logout EMR session Patch a patient's demographics Patch an appointment Remove a schedule summary Remove a specific consultant Retreive an encounter summary aggregate linked document Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of consultants Retrieve a list of encounters Retrieve a list of facilities Retrieve a list of linked documents Retrieve a list of patients Retrieve a list of providers Retrieve a list of schedulables Retrieve a list of schedule appointments Retrieve a list of schedule summaries Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of tutorials Retrieve a list of tutorials Retrieve a specific consultant Retrieve a specific encounter Retrieve a specific facility Retrieve a specific linked document Retrieve a specific patient Retrieve a specific patient with specific detail level Retrieve a specific provider by ID Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an encounter summary aggregate (Content 1 Package) Retrieve the current EMR capabilities Retrieve the current version Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Update a patient's demographics Update an appointment
Version
string optional

Version of API to use

Operations: Add a new encounter Add a new richtext encounter Add app log Create an appointment Logout EMR session Patch a patient's demographics Patch an appointment Remove a schedule summary Remove a specific consultant Retreive an encounter summary aggregate linked document Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of consultants Retrieve a list of encounters Retrieve a list of facilities Retrieve a list of linked documents Retrieve a list of patients Retrieve a list of providers Retrieve a list of schedulables Retrieve a list of schedule appointments Retrieve a list of schedule summaries Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of tutorials Retrieve a list of tutorials Retrieve a specific consultant Retrieve a specific encounter Retrieve a specific facility Retrieve a specific linked document Retrieve a specific patient Retrieve a specific patient with specific detail level Retrieve a specific provider by ID Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an encounter summary aggregate (Content 1 Package) Retrieve the current EMR capabilities Retrieve the current version Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Update a patient's demographics Update an appointment
TutorialData
boolean optional

Used to request tutorial data

Operations: Add a new encounter Add a new richtext encounter Add app log Create an appointment Logout EMR session Patch a patient's demographics Patch an appointment Remove a schedule summary Remove a specific consultant Retreive an encounter summary aggregate linked document Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of consultants Retrieve a list of encounters Retrieve a list of facilities Retrieve a list of linked documents Retrieve a list of patients Retrieve a list of providers Retrieve a list of schedulables Retrieve a list of schedule appointments Retrieve a list of schedule summaries Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of tutorials Retrieve a list of tutorials Retrieve a specific consultant Retrieve a specific encounter Retrieve a specific facility Retrieve a specific linked document Retrieve a specific patient Retrieve a specific patient with specific detail level Retrieve a specific provider by ID Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an encounter summary aggregate (Content 1 Package) Retrieve the current EMR capabilities Retrieve the current version Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Update a patient's demographics Update an appointment
ActivityId
string optional

Used for logging

Operations: Add a new encounter Add a new richtext encounter Add app log Create an appointment Logout EMR session Patch a patient's demographics Patch an appointment Remove a schedule summary Remove a specific consultant Retreive an encounter summary aggregate linked document Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of consultants Retrieve a list of encounters Retrieve a list of facilities Retrieve a list of linked documents Retrieve a list of patients Retrieve a list of providers Retrieve a list of schedulables Retrieve a list of schedule appointments Retrieve a list of schedule summaries Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of tutorials Retrieve a list of tutorials Retrieve a specific consultant Retrieve a specific encounter Retrieve a specific facility Retrieve a specific linked document Retrieve a specific patient Retrieve a specific patient with specific detail level Retrieve a specific provider by ID Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an encounter summary aggregate (Content 1 Package) Retrieve the current EMR capabilities Retrieve the current version Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Update a patient's demographics Update an appointment
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

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

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

Operations: Add a new consultant Add a new encounter Add a new linked document Add a new richtext encounter Add a schedule summary Create an appointment Patch a patient's demographics Patch an appointment Remove a schedule summary Remove a specific consultant Retreive an encounter summary aggregate linked document Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of consultants Retrieve a list of encounters Retrieve a list of facilities Retrieve a list of linked documents Retrieve a list of patients Retrieve a list of providers Retrieve a list of schedulables Retrieve a list of schedule appointments Retrieve a list of schedule summaries Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of tutorials Retrieve a list of tutorials Retrieve a specific consultant Retrieve a specific encounter Retrieve a specific facility Retrieve a specific linked document Retrieve a specific patient Retrieve a specific patient with specific detail level Retrieve a specific provider by ID Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an encounter summary aggregate (Content 1 Package) Retrieve the current EMR capabilities Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Update a patient's demographics Update a schedule summary Update a specific consultant Update an appointment
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.

Operations: Add a new encounter Add a new richtext encounter Create an appointment Logout EMR session Patch a patient's demographics Patch an appointment Remove a schedule summary Remove a specific consultant Retreive an encounter summary aggregate linked document Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of consultants Retrieve a list of encounters Retrieve a list of facilities Retrieve a list of linked documents Retrieve a list of patients Retrieve a list of providers Retrieve a list of schedulables Retrieve a list of schedule appointments Retrieve a list of schedule summaries Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of tutorials Retrieve a list of tutorials Retrieve a specific consultant Retrieve a specific encounter Retrieve a specific facility Retrieve a specific linked document Retrieve a specific patient Retrieve a specific patient with specific detail level Retrieve a specific provider by ID Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an encounter summary aggregate (Content 1 Package) Retrieve the current EMR capabilities Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Update a patient's demographics Update an appointment
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.

Operations: Add a new encounter Add a new richtext encounter Create an appointment Logout EMR session Patch a patient's demographics Patch an appointment Remove a schedule summary Remove a specific consultant Retreive an encounter summary aggregate linked document Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of consultants Retrieve a list of encounters Retrieve a list of facilities Retrieve a list of linked documents Retrieve a list of patients Retrieve a list of providers Retrieve a list of schedulables Retrieve a list of schedule appointments Retrieve a list of schedule summaries Retrieve a list of schedules Retrieve a list of schedules Retrieve a list of tutorials Retrieve a list of tutorials Retrieve a specific consultant Retrieve a specific encounter Retrieve a specific facility Retrieve a specific linked document Retrieve a specific patient Retrieve a specific patient with specific detail level Retrieve a specific provider by ID Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries Retrieve an aggregate list of patient summaries Retrieve an aggregate list of patient summaries Retrieve an encounter summary aggregate (Content 1 Package) Retrieve the current EMR capabilities Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Update a patient's demographics Update an appointment
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.

Operations: Logout EMR session
IncludeDeleted
boolean optional

If true it will make sure deleted items are also returned

Operations: Retrieve a list of appointments Retrieve a list of schedule appointments
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

Operations: Retrieve a list of appointment types Retrieve a list of appointments Retrieve a list of encounters Retrieve a list of schedule appointments
Authorization
string required

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

Pattern: Bearer &lt;token>
Example:
Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6Ik1hcmlrYSIsInR5cCI6IkpXVCJ9.eyJFbXJUeXBlIjoiTWVkZXN5bmMiLCJFbXJJbn...
Operations: Retreive an encounter summary aggregate linked document Retrieve an encounter summary aggregate (Content 1 Package)
Responses
404 404

Not found

Operations: Retrieve a list of schedules
400 400

Argument exception

Operations: 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
EncounterSummaryAggregateResponse

Encounter summary aggregate response

All of
PayloadServiceResponse
Object
Payload
EncounterSummaryAggregate
Methods: Retrieve an encounter summary aggregate (Content 1 Package)
Operations
appointments

Operations for appointments

Retrieve a list of 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.

Body
AppointmentPagedServiceResponse
appointmenttypes

Operations for appointment types

Retrieve a list of 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.

Body
AppointmentTypePagedServiceResponse
capabilities

Operations for capabilities

Retrieve the current EMR 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.

Body
CapabilityPagedServiceResponse
consultants

Operations for consultants

Retrieve a list of consultants
GET /{EmrType}/{InstanceId}/consultants
Add a new consultant
POST /{EmrType}/{InstanceId}/consultants
Update a specific consultant
PUT /{EmrType}/{InstanceId}/consultants
Retrieve a specific consultant
GET /{EmrType}/{InstanceId}/consultants/{ConsultantId}
Remove a specific consultant
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.

Body
ConsultantsPagedServiceResponse
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

Request body

ConsultantUpdateRequest

Responses

200 OK

Returns the consultants.

Body
ConsultantUpdateResponse
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

Request body

ConsultantUpdateRequest

Responses

200 OK

Returns the consultants.

Body
ConsultantUpdateResponse
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.

Body
ConsultantsPagedServiceResponse
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.

Body
ConsultantsPagedServiceResponse
encounters

Operations for encounters

Retrieve a list of encounters
GET /{EmrType}/{InstanceId}/encounters
Retrieve a specific encounter
GET /{EmrType}/{InstanceId}/encounters/{EncounterId}
Add a new richtext encounter
POST /{EmrType}/{InstanceId}/patients/{PatientId}/encounters/richtext
Add a new encounter
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

Body
EncountersPagedServiceResponse
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

Body
EncountersPagedServiceResponse
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

Body
EncounterCreateResponse
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

EncounterCreateRequest

Responses

200 OK

Return the encounter ID of the created encounter

Body
EncounterCreateResponse
facilities

Operations for facilities

Retrieve a list of facilities
GET /{EmrType}/{InstanceId}/facilities
Retrieve a specific facility
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

Body
FacilityPagedServiceResponse
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

Body
FacilityPagedServiceResponse
patients

Operations for patients

Retrieve a list of patients
GET /{EmrType}/{InstanceId}/patients
Retrieve a specific patient
GET /{EmrType}/{InstanceId}/patients/{PatientId}
Retrieve a specific patient with specific detail level
GET /{EmrType}/{InstanceId}/patients/{PatientId}/{DetailLevel}
Update a patient's demographics
PUT /{EmrType}/{InstanceId}/patients/demographics/{PatientId}
Patch a patient's demographics
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

Body
PatientsPagedServiceResponse
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

Body
PatientsPagedServiceResponse
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

Body
PatientsPagedServiceResponse
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

PatientUpdateRequest

Responses

200 OK

Return the patient ID of the updated patient

Body
PatientCreateResponse
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

Body
PatientCreateResponse
linked documents

Operations for linked documents

Retrieve a list of linked documents
GET /{EmrType}/{InstanceId}/linkeddocuments
Add a new linked document
POST /{EmrType}/{InstanceId}/linkeddocuments
Retrieve a specific linked document
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}
Retrieve the linked document contents
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}/content
Retrieve the linked document contents
GET /{EmrType}/{InstanceId}/linkeddocuments/{LinkedDocumentId}/image
Retrieve the linked document contents
GET /{EmrType}/{InstanceId}/linkeddocuments/{PatientId}/{EncounterId}/{LinkedDocumentId}/content
Retrieve the linked document contents
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

Body
LinkedDocumentsPagedServiceResponse
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

Request body

LinkedDocumentUploadRequest

Responses

200 OK

Successful upload of linked document

Body
LinkedDocumentUploadResponse
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

Body
LinkedDocumentsPagedServiceResponse
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

Body
LinkedDocumentContentResponse
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

Body
LinkedDocumentContentResponse
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

Body
LinkedDocumentContentResponse
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

Body
LinkedDocumentContentResponse
providers

Operations for providers

Retrieve a list of providers
GET /{EmrType}/{InstanceId}/providers
Retrieve a specific provider by ID
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

Body
ProvidersPagedServiceResponse
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

Body
ProvidersPagedServiceResponse
schedules

Operations for schedules

Retrieve a list of schedules
GET /{EmrType}/{InstanceId}/schedules
Retrieve a list of schedules
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}
Retrieve a list of schedule appointments
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments
Create an appointment
POST /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments
Update an appointment
PUT /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments/{AppointmentId}
Patch an appointment
PATCH /{EmrType}/{InstanceId}/schedules/{ScheduleId}/appointments/{AppointmentId}
Retrieve a list of schedulables
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/schedulable
Retrieve a list of schedule summaries
GET /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary
Add a schedule summary
POST /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary
Update a schedule summary
PUT /{EmrType}/{InstanceId}/schedules/{ScheduleId}/summary
Remove a schedule 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

Body
SchedulesPagedServiceResponse
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

Body
SchedulesPagedServiceResponse
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

Body
AppointmentPagedServiceResponse
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.

Request body

ScheduledAppointmentCreateRequest

Responses

200 OK

Return the appointment ID of the created appointment

Body
ScheduledAppointmentCreateResponse
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.

Request body

ScheduledAppointmentCreateRequest

Responses

200 OK

Return the appointment ID of the updated appointment

Body
ScheduledAppointmentCreateResponse
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

Body
ScheduledAppointmentCreateResponse
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

Body
PayloadServiceResponse(DailySchedule)
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

Body
PayloadServiceResponse(ScheduleSummary)
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

ScheduleSummaryRequest

Responses

200 OK

Successful add

Body
PayloadServiceResponse(ScheduleSummary)
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

ScheduleSummaryRequest

Responses

200 OK

Successful update

Body
PayloadServiceResponse(ScheduleSummary)
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

Body
PayloadServiceResponse(ScheduleSummary)
tutorials

Operations for tutorials

Retrieve a list of tutorials
GET /{EmrType}/{InstanceId}/tutorials
Retrieve a list of 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

Body
TutorialsPagedServiceResponse
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

Body
TutorialsPagedServiceResponse
administration

Administration operations

Add app log
POST /applog
Login with EMR session
POST /emrsessions
Renew EMR session
PUT /emrsessions
Logout EMR session
DELETE /emrsessions
Retrieve the current version
GET /version
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

Request body

CreateEmrSessionRequest

Responses

200 OK

Logged in

Body
CreateEmrSessionResponse
Renew EMR session
PUT /emrsessions

Renew the EMR session

Request body

RenewEmrSessionRequest

Responses

200 OK

Renewed

Body
EmrSessionResponse
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

Body
ServiceResponseBase
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

Body
VersionResponse
aggregate

Aggregate operations

Retrieve an aggregate list of address book entries
GET /{EmrType}/{InstanceId}/aggregate/addressbookentries
Retrieve an aggregate list of contact list entries
GET /{EmrType}/{InstanceId}/aggregate/contactlistentries
Retrieve an aggregate list of patient summaries
GET /{EmrType}/{InstanceId}/aggregate/patientsummary/{PatientId}
Retrieve an aggregate list of patient summaries
GET /{EmrType}/{InstanceId}/aggregate/schedulesummary/{ProviderId}
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

Body
AddressBookEntriesPagedServiceResponse
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

Body
AddressBookEntriesPagedServiceResponse
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

Body
PatientSummaryResponse
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

Body
ScheduleSummaryResponse
400 400

Argument exception

encounter summary aggregate
Retrieve an encounter summary aggregate (Content 1 Package)
GET /{EmrType}/{InstanceId}/aggregate/encountersummaries/{PatientId}/{EncounterSummaryId}
Retreive an encounter summary aggregate linked document
GET /{EmrType}/{InstanceId}/aggregate/encountersummaries/{PatientId}/{EncounterSummaryId}/linkeddocument
Retrieve an encounter summary aggregate (Content 1 Package)
GET /{EmrType}/{InstanceId}/aggregate/encountersummaries/{PatientId}/{EncounterSummaryId}

Path variables

EmrType
string required

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

InstanceId
string required

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

PatientId
string required

Patient Id

EncounterSummaryId
string required

Encounter summary Id

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 &lt;token>
Example:
Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6Ik1hcmlrYSIsInR5cCI6IkpXVCJ9.eyJFbXJUeXBlIjoiTWVkZXN5bmMiLCJFbXJJbn...

Responses

200 OK

Encounter summary aggregate

Body
EncounterSummaryAggregateResponse
404 Not Found (E78001)

Encounter summary aggregate not found

Body
ServiceResponseBase
Retreive an encounter summary aggregate linked document
GET /{EmrType}/{InstanceId}/aggregate/encountersummaries/{PatientId}/{EncounterSummaryId}/linkeddocument

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

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 &lt;token>
Example:
Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6Ik1hcmlrYSIsInR5cCI6IkpXVCJ9.eyJFbXJUeXBlIjoiTWVkZXN5bmMiLCJFbXJJbn...

Responses

200 OK

Linked document content (binary stream)

Body
application/octet-stream
LinkedDocumentContentResponse
404 Not Found (E78003)

Linked document not found (error message)

Body
ServiceResponseBase
Type Definitions
AppointmentPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
AppointmentPagedResult
Methods: Retrieve a list of appointments Retrieve a list of schedule appointments
AppointmentPagedResult
All of
PagedResult
Object
Entities
Array of Appointment
Types: AppointmentPagedServiceResponse PatientSummary ScheduleSummary
Appointment
All of
DomainObject
Object
Provider
ReferenceObject
Patient
Patient
Reason
string
Problem
string
SignedOut
boolean
StartDate
string date
EndDate
string date
Notes
string
Status
string
ScheduleLocation
ReferenceObject
BookingHistory
BookingHistory
Cancelled
boolean
AppointmentType
AppointmentType
Deleted
boolean
Types: AppointmentPagedResult EncounterSummaryAggregate PatientSummary
BookingHistory
Object
BookedDate
string date
BookedBy
string
ChangedDate
string date
ChangedBy
string
Types: Appointment
AppointmentTypePagedServiceResponse
All of
PagedServiceResponse
Object
Payload
AppointmentTypePagedResult
Methods: Retrieve a list of appointment types
AppointmentTypePagedResult
All of
PagedResult
Object
Entities
Array of AppointmentType
Types: AppointmentTypePagedServiceResponse
AppointmentType
All of
DomainObject
Object
BackgroundColour
string

Background colour represented with hex

ForegroundColour
string

Foreground colour represented with hex

DefaultText
string
DefaultDurationInMinutes
integer

Default duration in minutes

Types: Appointment AppointmentTypePagedResult ScheduledAppointmentCreateRequest
CapabilityPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
CapabilityPagedResult
Methods: Retrieve the current EMR capabilities
CapabilityPagedResult
All of
PagedResult
Object
Entities
Array of Capability
Types: CapabilityPagedServiceResponse
Capability
All of
DomainObject
Object
IsSupportingKeywordsForPhoto
boolean
IsSupportingEncounters
boolean
IsSupportingTutorial
boolean
IsSupportingScheduleSelection
boolean
TutorialCapabilites
TutorialCapability
CapabilityType
string
Enumeration:
KeywordsForPhoto
GetLabList
GetDocumentList
GetEncountedList
IsSupportingTutorial
GetCalendarList
SupportedDate
string date
Types: CapabilityPagedResult
TutorialCapability
All of
DomainObject
Object
CalendarSelectorEnabled
boolean
EncounterEnabled
boolean
EncounterDetailEnabled
boolean
LinkedDocumentImageEnabled
boolean
Types: Capability
ConsultantsPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
ConsultantsPagedResult
Methods: Remove a specific consultant Retrieve a list of consultants Retrieve a specific consultant
ConsultantsPagedResult
All of
PagedResult
Object
Entities
Array of Consultant
Types: ConsultantsPagedServiceResponse
Consultant
All of
Person
Object
Credentials
string
Specialty
ReferenceObject
RegistrationNumber
string

Registration number

Identifiers
Array of Identifier

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

Note: the RegistrationNumber shall also be included in this list

Department
string
Notes
string
BuildingName
string
BuildingType
ReferenceObject
SortDescriptor
string
Types: ConsultantsPagedResult ConsultantUpdateRequest EncounterSummaryAggregate Provider
ConsultantUpdateResponse
All of
ServiceResponseBase
Object
ConsultantId
string

The ID of the consultant

Methods: Add a new consultant Update a specific consultant
ConsultantUpdateRequest
All of
AuthenticatedServiceRequest
Object
Consultant
Consultant
Methods: Add a new consultant Update a specific consultant
EncountersPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
EncountersPagedResult
Methods: Retrieve a list of encounters Retrieve a specific encounter
EncountersPagedResult
All of
PagedResult
Object
Entities
Array of EncounterNote
Types: EncountersPagedServiceResponse
EncounterNote
All of
JournalItem
Object
ResponsibleProvider
Person
Patient
ReferenceObject
ShortSummary
string
LongSummary
string
NoteItems
Array of EncounterNoteItem
ReviewedBy
ReferenceObject
AttachmentReferences
Array of ReferenceObject
Types: EncountersPagedResult
EncounterNoteItem
Object
Order
integer
Name
string
Value
string
Visible
string
Attachments
Array of LinkedDocumentContents
AttachmentReferences
Array of ReferenceObject
Types: EncounterNote
LinkedDocumentContents
All of
DomainObject
Object
FileContents
Object
Name
string
FileType
string
Patient
ReferenceObject
Appointment
ReferenceObject
Provider
ReferenceObject
Keywords
Array of string
DocumentType
ReferenceObject
DocDate
string date
Note
string
NotesForPatient
string
Types: EncounterNoteItem
EncounterCreateRequest
All of
AuthenticatedServiceRequest
Object
EventDate
string date
ResponsibleProvider
string
LongSummary
string
Methods: Add a new encounter
EncounterCreateResponse
All of
ServiceResponseBase
Object
EncounterId
string
Methods: Add a new encounter Add a new richtext encounter
FacilityPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
FacilityPagedResult
Methods: Retrieve a list of facilities Retrieve a specific facility
FacilityPagedResult
All of
PagedResult
Object
Entities
Array of Facility
Types: FacilityPagedServiceResponse
Facility
All of
DomainObject
Object
Name
string
BuildingType
ReferenceObject
ContactInfo
ContactInformation
Types: FacilityPagedResult
PatientsPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
PatientsPagedResult
Methods: Retrieve a list of patients Retrieve a specific patient Retrieve a specific patient with specific detail level
PatientsPagedResult
All of
PagedResult
Object
Entities
Array of Patient
Types: PatientsPagedServiceResponse
Patient
All of
Person
Object
MaidenName
string
RestrictedAccess
boolean
Demographics
Demographics
MedicalSummary
MedicalSummary
JournalItems
Array of JournalItem
CareTeam
CareTeam
OtherInfo
OtherInfo
Active
boolean

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

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

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

RosteredDate
FuzzyDate

Indicates when this patient’s record was “rostered” to the CareTeam.PrimaryProvider [Added with C1]

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

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

All of
DomainObject
Object
Type
string

Type of the harmful substance

Displayed as “risk title” in the mobile app

TypeCode
Array of Coding

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

TELUS EMR Code Table: harmful-substances-code

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

Details
string

Details of the harmful substance

Displayed as “risk subtitle” in the mobile app

EffectiveStartDateTime
FuzzyDate

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

EffectiveEndDateTime
FuzzyDate

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

AgeAtOnsetString
string

Text field giving an indication of the age of the patient when de condition started – should only be populated if EffectiveStartDateTime cannot be provided [Added with C1]

LifeStageAtOnset
CodeableConcept

Indicates the life stage of the patient when the condition started – should only be populated if neither EffectiveStartDateTime or AgeAtOnset can be provided [Added with C1]

Notes
string

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

LastUpdatedDate
string date-time

Last Updated date & time - Can be null [Added with C1]

Types: MedicalSummary
Vaccination
All of
DomainObject
Object
Name
string

Brand name of the administered product

Code
Array of Coding

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

TELUS EMR Code Table: vaccine-code

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

Date
string date

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

DateFD
FuzzyDate

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

DateDescription
string
Reaction
string

Details of a reaction that follows immunization

Type
CodeableConcept

Vaccine Type [Added with C1]

TELUS EMR Code Table: vaccine-type

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

Dose
Quantity

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

Site
CodeableConcept

Anatomical site of administration [Added with C1]

TELUS EMR Code Table: vaccine-site

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

Route
CodeableConcept

Route of administration [Added with C1]

TELUS EMR Code Table: vaccine-route

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

Manufacturer
string

Name of the vaccine manufacturer [Added with C1]

LotNumber
string

Product lot number [Added with C1]

ExpiryDate
FuzzyDate

Product expiry date [Added with C1]

NotGiven
boolean

Flag for whether immunization was given [Added with C1]

Notes
string

Vaccination notes [Added with C1]

LastUpdatedDate
string date-time

Last Updated date & time - Can be null [Added with C1]

Types: MedicalSummary
FamilyHistory
All of
DomainObject
Object
Problem
string
RelationName
string
DateNoted
string date
Types: MedicalSummary
Procedure
All of
DomainObject
Object
Category
CodeableConcept

Classification / Type of the procedure [Added with C1]

TELUS EMR Code Table: procedure-category

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

Name
string

Name of the procedure

Code
Array of Coding

Identification of the procedure [Added with C1]

TELUS EMR Code Table: procedure-code

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

Date
string date

Date of the procedure [Superseded by DateFD]

DateFD
FuzzyDate

Date of the procedure [Added with C1]

DateDescription
string
Practitioner
string

Name of the practitioner

Notes
string

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

LastUpdatedDate
string date-time

Last Updated date & time - Can be null [Added with C1]

Types: MedicalSummary
Problem
All of
DomainObject
Object
Name
string

Name of the problem

Code
Array of Coding

Identification of the problem [Added with C1]

TELUS EMR Code Table: problem-code

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

Category
CodeableConcept

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
CodeableConcept

[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
CodeableConcept

[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
CodeableConcept

[Added with C1]

E.g. chronic | controlled | episodic | remission

TELUS EMR Code Table: problem-persistence-status

Severity
CodeableConcept

[Added with C1]

E.g. mild | moderate | severe | unknown

TELUS EMR Code Table: problem-severity

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

Date
string date

Date of the problem [Superseded by DateFD]

DateFD
FuzzyDate

Date of the problem [Added with C1]

DateDescription
string
Notes
string

Additional information about the problem or diagnosis

DateOfOnset
string

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

DateOfOnsetFD
FuzzyDate

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

DateOfAbatement
FuzzyDate

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

Outcome
string

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

LastUpdatedDate
string date-time

Last Updated date & time - Can be null [Added with C1]

Types: MedicalSummary
Allergy
All of
DomainObject
Object
Category
CodeableConcept

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
CodeableConcept

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

TELUS EMR Code Table: allergy-reaction-type

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

Certainty
string

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

Enumeration:
mild
moderate
severe
Date
string date

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

DateFD
FuzzyDate

When allergy was identified [Added with C1]

ClinicalStatus
CodeableConcept

[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
CodeableConcept

[Added with C1]

TELUS EMR Code Table: allergy-verification-status

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

Notes
string

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

LastUpdatedDate
string date-time

Last Updated date & time - Can be null [Added with C1]

Types: MedicalSummary
Medication

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

All of
DomainObject
Object
Name
string

Drug name

GenericName
string

Drug generic name [Added with C1]

Code
Array of Coding

[Added with C1]

TELUS EMR Code Table: medication-code

Form
CodeableConcept

[Added with C1]

TELUS EMR Code Table: medication-form

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

Strength
Quantity

Potency value of the drug [Added with C1]

Details
string

Compound description or additional details [Added with C1]

Indication
string

[Added with C1]

PrescribedBy
ReferenceObject

Provider that prescribed the drug [Added with C1]

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

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

Date the medication was prescribed [Superseded by PrescribedDateFD]

PrescribedDateFD
FuzzyDate

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

EffectiveDate
FuzzyDate

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

CompletedDate
FuzzyDate

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

Status
CodeableConcept

[Added with C1]

TELUS EMR Code Table: medication-status

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

StopReason
CodeableConcept

[Added with C1]

TELUS EMR Code Table: medication-stop-reason

TreatmentType
CodeableConcept

[Added with C1]

TELUS EMR Code Table: medication-treatment-type

Dosage
string

Description of the dosage (summary)

DosageInstruction
Array of MedicationDosage

How the medication should be taken [Added with C1]

PatientInstruction
string

Patient or consumer oriented instructions [Added with C1]

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

Quantity
Quantity

Quantity of drug prescribed [Added with C1]

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

Route
CodeableConcept

[Added with C1]

TELUS EMR Code Table: medication-route

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

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

RateRatioAmount
Quantity

Amount of medication per time reference (e.g. 100 ml per 30 min) [Added with C1]

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

RateRatioTime
Quantity

Time reference for a rate ratio (e.g. 100 ml per 30 min) [Added with C1]

NumberOfRepeatsAllowed
integer

Number of refills authorized [Added with C1]

SubstitutionsAllowed
boolean

Whether substitution is allowed or not [Added with C1]

LastDispenseInClinic
FuzzyDate

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

LastUpdatedDate
string date-time

Last Updated date & time - Can be null [Added with C1]

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

Male

F

Female

O

Other

U

Unknown

PHN
string
PHNVersionCode
string

Health Number Version Code [Added with C1]

DeceasedDate
FuzzyDate

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

Types: Patient PatientCreateRequest
Person
All of
DomainObject
Object
Title
string
FirstName
string
GoesByName
string
MiddleName
string
LastName
string
Language
string
Initials
string
ContactInfo
ContactInformation
Types: ClinicStaff Consultant EncounterNote Patient
PatientCreateRequest
All of
AuthenticatedServiceRequest
Object
Title
string
FirstName
string
GoesByName
string
MiddleName
string
LastName
string
PatientLanguage
string
Initials
string
ContactInfo
ContactInformation
MaidenName
string
OtherInfo
OtherInfo
Demographics
Demographics
RestrictedAccess
boolean
Types: PatientUpdateRequest
PatientCreateResponse
All of
ServiceResponseBase
Object
PatientId
string
Methods: Patch a patient's demographics Update a patient's demographics
LinkedDocumentsPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
LinkedDocumentsPagedResult
Methods: Retrieve a list of linked documents Retrieve a specific linked document
LinkedDocumentsPagedResult
All of
PagedResult
Object
Entities
Array of LinkedDocument
Types: LinkedDocumentsPagedServiceResponse
LinkedDocument
All of
DomainObject
Object
Name
string
FileType
string
Patient
ReferenceObject
Appointment
ReferenceObject
Provider
ReferenceObject
Keywords
Array of string
DocumentType
ReferenceObject
DocDate
string date
Note
string
NotesForPatient
string
Types: LinkedDocumentsPagedResult
LinkedDocumentContentResponse
Object
Options
IDictionary
Methods: Retreive an encounter summary aggregate linked document Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents Retrieve the linked document contents
LinkedDocumentUploadRequest
All of
AuthenticatedServiceRequest
Object
PatientId
string
AppointmentId
string
ProviderId
string
FileName
string
DocumentType
string
Keyword1
string
Keyword2
string
Keyword3
string
Notes
string
Methods: Add a new linked document
LinkedDocumentUploadResponse
All of
ServiceResponseBase
Object
LinkedDocumentId
string
DocumentSize
string
Methods: Add a new linked document
ProvidersPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
ProvidersPagedResult
Methods: Retrieve a list of providers Retrieve a specific provider by ID
ProvidersPagedResult
All of
PagedResult
Object
Entities
Array of Provider
Types: ProvidersPagedServiceResponse
Provider
All of
Consultant
Object
DailySchedules
Array of DailySchedule
ScheduleId
string
Types: EncounterSummaryAggregate ProvidersPagedResult ScheduleSummary
DailySchedule
Object
StartTime
string date
EndTime
string date
Scheduleable
boolean
Types: PayloadServiceResponse(DailySchedule) Provider
SchedulesPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
SchedulesPagedResult
Methods: Retrieve a list of schedules Retrieve a list of schedules
SchedulesPagedResult
All of
PagedResult
Object
Entities
Array of Schedule
Types: SchedulesPagedServiceResponse
Schedule
All of
DomainObject
Object
Name
string
Types: EncounterSummaryAggregate SchedulesPagedResult
PayloadServiceResponse(DailySchedule)
All of
PayloadServiceResponse
Object
Payload
Array of DailySchedule
Methods: Retrieve a list of schedulables
PayloadServiceResponse(ScheduleSummary)
All of
PayloadServiceResponse
Object
Payload
ScheduleSummary
Methods: Add a schedule summary Remove a schedule summary Retrieve a list of schedule summaries Update a schedule summary
ScheduleSummaryRequest
All of
AuthenticatedServiceRequest
Object
ScheduleId
string
Date
string date
Methods: Add a schedule summary Update a schedule summary
ScheduleSummary
Object
Header
ProviderScheduleStatistics
Appointments
AppointmentPagedResult
Provider
Provider
Types: PayloadServiceResponse(ScheduleSummary) ScheduleSummaryResponse
ProviderScheduleStatistics
Object
ScheduledPatientCount
string
OtherBookingCount
string
UnscheduledDuration
string
Types: ScheduleSummary
ScheduledAppointmentCreateRequest
All of
AuthenticatedServiceRequest
Object
ScheduleId
string
StartDate
string date
EndDate
string date
PatientId
string
SignedOut
boolean
Reason
string
Problem
string
Notes
string
Cancelled
boolean
ScheduleLocation
ReferenceObject
Status
string
AppointmentType
AppointmentType
Methods: Create an appointment Update an appointment
ScheduledAppointmentCreateResponse
All of
ServiceResponseBase
Object
AppointmentId
string
Methods: Create an appointment Patch an appointment Update an appointment
User
All of
DomainObject
Object
ProviderId
string
Types: CreateEmrSessionResponse
TutorialsPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
TutorialsPagedResult
Methods: Retrieve a list of tutorials Retrieve a list of tutorials
TutorialsPagedResult
All of
PagedResult
Object
Entities
Array of Tutorial
Types: TutorialsPagedServiceResponse
Tutorial
All of
DomainObject
Object
DisplayScreenShots
boolean
TutorialScreens
Array of Screens
Types: TutorialsPagedResult
Screens
Object
Title
string
Text
string
SpecificationPortrait
Specification
SpecificationLandscape
Specification
Types: Tutorial
Specification
Object
IsPositionTextAtTop
boolean
SpotlightPositionArea
string
SpotlightCenterPositionX
integer
SpotlightCenterPositionY
integer
TutorialAreaHeight
number float
SpotlightDiameter
integer
Types: Screens
AddressBookEntriesPagedServiceResponse
All of
PagedServiceResponse
Object
Payload
AddressBookEntriesPagedResult
Methods: Retrieve an aggregate list of address book entries Retrieve an aggregate list of contact list entries
AddressBookEntriesPagedResult
All of
PagedResult
Object
Entities
Array of AddressBookEntry
Types: AddressBookEntriesPagedServiceResponse
AddressBookEntry
All of
DomainObject
Object
Name
string
Title
string
LastName
string
FirstName
string
SortDescriptor
string
Specialty
ReferenceObject
BuildingType
ReferenceObject
RegistrationNumber
string
Department
string
ContactInfo
ContactInformation
Notes
string
Types: AddressBookEntriesPagedResult
PatientSummaryResponse
All of
ServiceResponseBase
Object
PatientSummary
PatientSummary
Methods: Retrieve an aggregate list of patient summaries
PatientSummary
All of
DomainObject
Object
Patient
Patient
PreviousAppointments
AppointmentPagedResult
CurrentAppointment
Appointment
Types: PatientSummaryResponse
ScheduleSummaryResponse
All of
ServiceResponseBase
Object
ScheduleSummary
ScheduleSummary
Methods: Retrieve an aggregate list of patient summaries
AuthenticatedServiceRequest
All of
InstanceRequestBase
Object
UserToken
string
EmrSessionToken
string
Types: ConsultantUpdateRequest EncounterCreateRequest LinkedDocumentUploadRequest PatientCreateRequest ScheduledAppointmentCreateRequest ScheduleSummaryRequest
InstanceRequestBase
All of
ServiceRequestBase
Object
EmrType
string
InstanceId
string
Types: AuthenticatedServiceRequest CreateEmrSessionRequest RenewEmrSessionRequest
ServiceRequestBase
Object
AppToken
string
Language
string
Version
string
TutorialData
boolean
ActivityId
string
Types: InstanceRequestBase
PagedServiceResponse
All of
ServiceResponseBase
Object
ResourceType
string
Types: AddressBookEntriesPagedServiceResponse AppointmentPagedServiceResponse AppointmentTypePagedServiceResponse CapabilityPagedServiceResponse ConsultantsPagedServiceResponse EncountersPagedServiceResponse FacilityPagedServiceResponse LinkedDocumentsPagedServiceResponse PatientsPagedServiceResponse ProvidersPagedServiceResponse SchedulesPagedServiceResponse TutorialsPagedServiceResponse
PagedResult
Object
MoreRecords
boolean
TotalRecordCount
integer
Types: AddressBookEntriesPagedResult AppointmentPagedResult AppointmentTypePagedResult CapabilityPagedResult ConsultantsPagedResult EncountersPagedResult FacilityPagedResult LinkedDocumentsPagedResult PatientsPagedResult ProvidersPagedResult SchedulesPagedResult TutorialsPagedResult
PayloadServiceResponse
All of
ServiceResponseBase
Object
Types: EncounterSummaryAggregateResponse PayloadServiceResponse(DailySchedule) PayloadServiceResponse(ScheduleSummary)
ResponseStatus
Object
ErrorCode
string
Message
string
StackTrace
string
Errors
Array of ResponseError
Meta
Dictionary
Types: ServiceResponseBase
ResponseError
Object
ErrorCode
string
FieldName
string
Message
string
Meta
Dictionary
Types: ResponseStatus
Dictionary
Object
Types: ResponseError ResponseStatus
ServiceResponseBase
Object
ProcessingTimeMilliseconds
integer
ResponseStatus
ResponseStatus
Methods: Logout EMR session Retreive an encounter summary aggregate linked document Retrieve an encounter summary aggregate (Content 1 Package)
Types: ConsultantUpdateResponse CreateEmrSessionResponse EmrSessionResponse EncounterCreateResponse LinkedDocumentUploadResponse PagedServiceResponse PatientCreateResponse PatientSummaryResponse PayloadServiceResponse ScheduledAppointmentCreateResponse ScheduleSummaryResponse VersionResponse
Metadata
Object
Type
string
Path
string
Types: DomainObject
ReferenceObject
All of
DomainObject
Object
ReferenceType
string
Types: AddressBookEntry Appointment CareTeam Consultant ContactAddress ContactEmail ContactFax ContactInformation ContactPhone EncounterNote EncounterNoteItem EncounterSummary Facility JournalItem LinkedDocument LinkedDocumentContents Medication ScheduledAppointmentCreateRequest
IDictionary
Object
Types: LinkedDocumentContentResponse
Object
Object
Types: LinkedDocumentContents
DomainObject
Object
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

Metadata about the resource

Assigner
string

Explicit source of the Id [Added with C1]

Pattern: urn:telus:emr:{emr_type}:{instance_id}
Types: AddressBookEntry Allergy Appointment AppointmentType Capability EmrSession EncounterSummary EncounterSummaryAggregate Facility FamilyHistory HarmfulSubstances JournalItem LinkedDocument LinkedDocumentContents Medication Observation PatientSummary Person Personal Problem Procedure ReferenceObject ReferralRequest Schedule Tutorial TutorialCapability User Vaccination
FuzzyDate
Object
Date
string date
Precision
string
Enumeration:
Year
Month
Day
Time
Types: Allergy Demographics EncounterSummary HarmfulSubstances Identifier JournalItem Medication Observation OtherInfo Problem Procedure ReferralRequest Vaccination
JsonPatch

Defined by JSON Patch RFC 6902

Object
patch
Array of JsonPatchElement
JsonPatchElement
Object
op
string
Enumeration:
add
remove
replace
copy
move
test
path
string
value
string
from
string
Types: JsonPatch
AppActivity
Object
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
All of
InstanceRequestBase
Object
UserToken
string
AuthenticatedSessionToken
string
ClientType
string
ClientIpAddress
string
Methods: Login with EMR session
CreateEmrSessionResponse
All of
ServiceResponseBase
Object
EmrSession
EmrSession
User
User
Methods: Login with EMR session
RenewEmrSessionRequest
All of
InstanceRequestBase
Object
UserToken
string
EmrSessionToken
string
Methods: Renew EMR session
EmrSessionResponse
All of
ServiceResponseBase
Object
EmrSession
EmrSession
Methods: Renew EMR session
EmrSession
All of
DomainObject
Object
EmrSessionToken
string
ExpiryDate
string
Instance
EmrInstanceReference
User
EmrUserReference
UserDevice
UserDeviceReference
Types: CreateEmrSessionResponse EmrSessionResponse
EmrInstanceReference
Object
EmrType
string
EmrInstanceId
string
EmrInstanceName
string
Types: EmrSession
EmrUserReference
Object
EmrUserId
string
EmrUserName
string
Types: EmrSession
UserDeviceReference
Object
DeviceIdentifier
string
DeviceName
string
Descriptor
string
Types: EmrSession
VersionResponse
All of
ServiceResponseBase
Object
ServiceVersion
string
Methods: Retrieve the current version
Coding

A Coding is a representation of a defined concept using a symbol from a defined code system

URI Source Comment
http://snomed.info/sct SNOMED CT Typical use case: problems, imaging, body structure
http://loinc.org LOINC Typical use case: lab results
http://hl7.org/fhir/v2/[X] HL7 v2 [X] is the 4 digit identifier for a table; e.g. http://hl7.org/fhir/v2/0203 Version 2 codes are case sensitive.
http://hl7.org/fhir/v3/[X] HL7 v3 [X] is the code system name; e.g. http://hl7.org/fhir/v3/GenderStatus. HL7 v3 code systems are case sensitive.
urn:iso:std:iso:3166 ISO 2 letter country codes urn:iso:std:iso:3166-2:ca for Canadian provinces or territories
http://hl7.org/fhir/sid/icd-9-cm ICD-9-CM International Classification of Diseases, 9th Revision, Clinical Modification
http://hl7.org/fhir/sid/icd-10 ICD-10 International Classification of Diseases, 10th Revision, and variants
http://hl7.org/fhir/sid/icd-10-[x] ICD-10 variant
http://unitsofmeasure.org UCUM Unified Code for Units of Measure (UCUM)
http://hl7.org/fhir/sid/ca-hc-din Health Canada Drug Identification Number A computer-generated eight digit number assigned by Health Canada to a drug product prior to being marketed in Canada.
urn:telus:emr:{emr_type}:{instance_id} TELUS EMR See below for more details

For EMR defined codes (that are not defined by an external authority), we’ll use the following system definition urn:telus:emr:{emr_type}:{instance_id}:codetable:{code_table} where:

  • emr_type is pss, ma, wolf, kin, medesync, or * for any
  • instance_id is * or a specific EMR instance Id (only if the emr_type value is not *)
  • code_table is a code table name
    • referral-type
    • referral-service-requested
    • observation-category
    • observation-code
    • observation-status
    • allergy-category
    • allergy-substance
    • allergy-reaction-type
    • allergy-clinical-status
    • allergy-verification-status
    • problem-code
    • problem-category
    • problem-clinical-status
    • problem-confirmation-status
    • problem-persistence-status
    • problem-severity
    • procedure-category
    • procedure-code
    • vaccine-code
    • vaccine-type
    • vaccine-site
    • vaccine-route
    • medication-code
    • medication-form
    • medication-status
    • medication-stop-reason
    • medication-treatment-type
    • medication-route
    • medication-frequency
Object
System
string

Identity of the terminology system

Code
string

Code defined by a terminology system

Display
string

Representation defined by the system

Types: Allergy CodeableConcept HarmfulSubstances Medication Problem Procedure Vaccination
Example 1
{
    "System": "<uri>",
    "Code": "<code>",
    "Display": "<string>"
}
CodeableConcept

A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text.

Object
Coding
Array of Coding

Code defined by a terminology system

Text
string

Plain text representation of the concept

Types: Allergy EncounterSummary HarmfulSubstances Identifier Medication MedicationDosage Observation Problem Procedure Quantity ReferralRequest Vaccination
Example 1
{
    "Coding": [
        {
            "System": "<uri>",
            "Code": "<code>",
            "Display": "<string>"
        }
    ],
    "Text": "<string>"
}
ReferralRequest

Details about a request for referral service or transfer of a patient to the care of another provider or provider organization. [Added with C1]

All of
DomainObject
Object
Type
CodeableConcept

Type of the referral

TELUS EMR Code Table: referral-type

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

Description
string

A textual description of the referral

ServiceRequested
CodeableConcept

Actions requested as part of the referral

TELUS EMR Code Table: referral-service-requested

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

Recipient
string

Receiver of referral / transfer of care request

OccurrenceDateTime
FuzzyDate

When the service requested in the referral should occur

Types: EncounterSummary
EncounterSummary

Contains information about the encounter itself, its provider, related appointment, main diagnosis, all the observations performed during the encounter, and (optionally) the referral it was related to. [Added with C1]

All of
DomainObject
Object
Provider
ReferenceObject

Encounter Provider - Points to a Provider resource

Location
CodeableConcept

Encounter Location

  • Coding[?].System = urn:telus:emr:{emr_type}:{instance_id}:codetable:location
  • Coding[?].Code = Location Id
  • Coding[?].Display = Location Name

Note that the sending EMR is provided by the Assigner field or in a parent EncouterSummaryAggregate

Schedule
ReferenceObject

Schedule of the Appointment related to the visit - Points to a Schedule resource

Appointment
ReferenceObject

Appointment related to the visit - Points to an Appointment resource

Start
FuzzyDate

Encounter Start date and time (UTC)

End
FuzzyDate

Encounter End date and time (UTC)

Reason
CodeableConcept

Reason the encounter takes place

Diagnosis
Array of CodeableConcept

List of diagnosis relevant to this encounter - The first one is the main one - Expected coding systems = ICD9, ICD10

Type
CodeableConcept

Specific type of encounter

AccountType
CodeableConcept

Billing Payment Type

ClinicalAssessment
string

Represents the Provider’s professional opinion of the most relevant clinical findings related to the Client’s encounter. The most relevant clinical findings for the encounter can include diagnoses and symptoms

Observations
Array of Observation

Observations

ReferralRequests
Array of ReferralRequest

Array of referral requests (not pointers)

Status
string

Encounter Summary status - Assumed as “active” if not provided

Enumeration:
active

Active

deleted

Deleted

Types: EncounterSummaryAggregate
Observation

Measurements and simple assertions made about a patient. [Added with C1]

All of
DomainObject
Object
Category
CodeableConcept

Classification of type of observation

TELUS EMR Code Table: observation-category

For reference, FHIR uses the following codes: social-history | vital-signs | imaging | laboratory | procedure | survey | exam | therapy (http://www.hl7.org/FHIR/codesystem-observation-category.html)

Code
CodeableConcept

TELUS EMR Code Table: observation-code

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

GroupName
string

Group name (optional). Can be used to specify an observation context.

ValueString
string

A value can either be a String or a Quantity

ValueQuantity
Quantity

A value can either be a String or a Quantity

EffectiveDateTime
FuzzyDate

Clinically relevant time/time-period for observation

ReferenceRange
string

Provides guide for interpretation

ReferenceRangeLow
Quantity

Provides guide for interpretation - Low Range, if relevant

ReferenceRangeHigh
Quantity

Provides guide for interpretation - High Range, if relevant

Interpretation
CodeableConcept

For reference, FHIR uses HL7 v2 codes: A |AA | LL | L | N | H | HH (http://www.hl7.org/FHIR/v2/0078/index.html)

Status
CodeableConcept

Status of the observation

TELUS EMR Code Table: observation-status

For reference, FHIR defines the following code: registered | preliminary | final | amended | corrected | cancelled | entered-in-error | unknown (http://www.hl7.org/FHIR/valueset-observation-status.html)

IsRequest
boolean

Indicates that this observation is a request

LastUpdatedDate
string date-time

Last Updated date & time - Can be null

Types: EncounterSummary
MedicationDosage

The MedicationDosage structure defines general dosage instruction information [Added with C1]

Object
Sequence
integer nullable

Order of the dosage instructions (optional)

Text
string

Free text dosage instructions e.g. SIG

DoseRangeLow
Quantity

Amount of medication per dose (low) - Use this for single/normal dosage prescriptions

DoseRangeHigh
Quantity

Amount of medication per dose (high) - For variable dosages only

DoseUnits
CodeableConcept

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

Frequency
CodeableConcept

e.g. BID | TID | QID | AM | PM | QD | QOD | Q4H

TELUS EMR Code Table: medication-frequency

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

Duration
Quantity

Duration

AsNeeded
boolean

Take “as needed” (PRN)

Types: Medication
EncounterSummaryAggregate

The Encounter Summary Aggregate contains:

  • sending EMR information
  • a Patient, including a CareTeam and a MedicalSummary
  • an EncounterSummary
  • any referenced Consultant, Provider, Schedule or Appointment
All of
DomainObject
Object
EmrType
string

Sending EMR Type

EmrInstanceId
string

Sending EMR Instance Id

EmrInstanceName
string

Sending EMR Instance Name

Patient
Patient

Patient resource, including a CareTeam and a MedicalSummary

EncounterSummary
EncounterSummary

EncounterSummary resource

Consultants
Array of Consultant

List of all the referenced Consultant resources

Providers
Array of Provider

List of all the referenced Provider resources

Schedules
Array of Schedule

List of all the referenced Schedule resources

Appointments
Array of Appointment

List of all the referenced Appointment resources

Types: EncounterSummaryAggregateResponse
ClinicStaff
All of
Person
Object
LocationId
integer nullable
LocationName
integer nullable
PatientUpdateRequest
All of
PatientCreateRequest
Object
PatientId
string
Methods: Update a patient's demographics
Identifier

A numeric or alphanumeric string that is associated with a single object or entity within a given system.

This data type is related to HL7 FHIR’s https://www.hl7.org/fhir/datatypes.html#identifier.

Code review is pending

Object
Value
string

The value that is unique

AssigningAuthority
CodeableConcept

Organization / System that issued the identifier (as an initial implementation, may be just a text, if no coded value can be established)

Sample coded values:

  • Canadian provinces and territories:

  • System: “urn:iso:std:iso:3166-2:ca”

  • Code / Display: - AB / Alberta - BC / British Columbia - MB / Manitoba - NB / New Brunswick - NL / Newfoundland and Labrador - NS / Nova Scotia - ON / Ontario - PE / Prince Edward Island - QC / Quebec - SK / Saskatchewan - NT / Northwest Territories - NU / Nunavut - YT / Yukon

  • Specific OID, as defined in the HL7 Object Identifier (OID) Registry (http://www.hl7.org/Oid/index.cfm):

    • System: “urn:oid”
    • Code / Display:
      • 2.16.840.1.113883.4.347 / College of Physicians and Surgeons of Ontario (CPSO)
      • 2.16.840.1.113883.4.752 / College of Physicians and Surgeons of Alberta
Type
CodeableConcept

Description of identifier

For “urn:telus:emr:*:*:codetable:identifier-type”, we want to support the following codes:

  • “CPSID” = College of Physicians and Surgeons Identification
  • “PractitionerID” = Practitioner Identification
  • “BillingID” = Billing Identification
Use
string

Identifier use:

  • “usual” = The identifier recommended for display and use in real-world interactions
  • “official” = The identifier considered to be most trusted for the identification of this item
  • “temp” = A temporary identifier
  • “secondary” = An identifier that was assigned in secondary use - it serves to identify the object in a relative context, but cannot be consistently assigned to the same object again in a different context
  • null = unknown

See https://www.hl7.org/fhir/valueset-identifier-use.html for more details

Start
FuzzyDate

Date from which the identifier is / will be valid (null = unknown)

End
FuzzyDate

Date until which the identifier is / was valid (null = unknown)

Types: Consultant
Quantity

A quantity is a measured amount (or an amount that can potentially be measured)

Object
Value
number nullable

Numerical value of the quantity (decimal)

Unit
CodeableConcept nullable

Unit of the quantity

  • Unit.Text is the unit textual representation
  • Unit.Coding[] contains the coded form of the unit

For reference, FHIR recommends using the UCUM coding system (http://unitsofmeasure.org)

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

ValueString
string nullable

Textual representation of the quantity

Types: Medication MedicationDosage Observation Vaccination